Skip to content

Repository files navigation

Lyquix WordPress Theme

@version 3.4.0

A modern, unopinionated WordPress starter theme designed for agencies and developers who need maximum flexibility without fighting theme defaults.

Philosophy

Lyquix started releasing its own starter theme in 2016 with the goals of:

  • Following best practices in HTML, CSS, JavaScript, SEO, accessibility, security, and performance.
  • Promoting code reuse and consistency for efficiency, reduced user errors, and developer quality of life.
  • Allowing for custom designs and functionality without interference from the theme (unopinionated approach).
  • Enabling easy updates without affecting customizations.

Key Features

  • 14 Content Blocks - Accordion, Banner, Cards, Filters, Gallery, Hero, Logos, Map, Slider, Tabs, Testimonial, and more
  • 2 Social Embed Blocks - Facebook and Instagram post/reel/video embeds with live editor preview
  • 13 Layout Blocks - CSS layout primitives (Box, Center, Cluster, Container, Cover, Frame, Grid, Icon, Imposter, Reel, Sidebar, Stack, Switcher)
  • 6 Modules - Alerts, CTAs, Modal, Popup, Social Sharing, Social Icons
  • Regionalization - GeoJSON-based geographic content targeting with cookie override and per-post forcing
  • Three-Level Block Settings - Global defaults, saved presets, per-instance user/admin overrides
  • Tailwind CSS + SMACSS - Hybrid styling with utility-first and component-based approaches
  • TypeScript Library - 28 modules for detection, analytics, UI components, and utilities
  • Custom Template Router - Flexible routing engine replacing the standard WordPress template hierarchy
  • 60+ Customizer Options - Branding, admin bar, CSS, JS, analytics, geolocation, browser detection, and feature flags
  • Critical Path CSS - Per-post-type inline critical CSS with async stylesheet loading
  • Modern Build Chain - Bun + Gulp + Sass + Tailwind + PostCSS with LiveReload

Quick Start

# 1. Copy both themes to wp-content/themes/
cp -r lyquix wp-content/themes/
cp -r lyquix-child wp-content/themes/

# 2. Install dependencies (from child theme directory)
cd wp-content/themes/lyquix-child
nvm use 18
bun install

# 3. Activate the child theme in WordPress admin

# 4. Install required plugins (ACF PRO, ACF Extended PRO)

# 5. Start development
bun run watch

Required Plugins

Documentation

Getting Started

  • Installation - Prerequisites, setup, and initial configuration
  • Architecture - Parent/child relationship, design philosophy, extension points, PHP namespaces

Core Systems

  • Template System - Custom router, template resolution, creating page templates
  • Content Blocks - All 14 blocks + social embeds, three-level settings, presets, styles, overrides
  • Layout Blocks - 13 CSS layout primitives, Tailwind integration, ACF-to-class conversion
  • Modules - Alerts, CTAs, Modal, Popup, Share, Social - configuration and overrides
  • Regionalization - GeoJSON-based region detection, per-block/per-post region filtering, client-side element show/hide
  • Editor Tools - QR code generator, URL shortener, per-post custom CSS/JS, featured posts, excerpt repositioning, SVG uploads

Styling and Scripts

  • Styling - SMACSS + Tailwind hybrid, SCSS structure, breakpoints, critical CSS
  • JavaScript - lqx and $lqx libraries, TypeScript modules, adding custom scripts

Configuration

  • Theme Customizer - All 60+ options: branding, admin bar, CSS, JS, analytics, geolocation, features
  • Integrations - Google Maps, GA4, GTM, Clarity, MaxMind, browser detection

Development

  • Build System - Bun, Gulp, Sass, Tailwind, PostCSS pipeline
  • Developer Guide - Workflow, creating blocks/modules/templates, hooks/filters reference

Technology Stack

Layer Technology
CSS Tailwind CSS 3.4, Sass, PostCSS, cssnano, autoprefixer
JavaScript TypeScript 5.4, Bun, Rollup
PHP Namespaced PHP 7.4+, ACF PRO
Build Bun, Gulp 4, LiveReload
Libraries Swiper 11, Day.js, MobileDetect, Vue.js 3 (optional)

License

GNU General Public License version 2 or later

Links

Releases

Packages

Used by

Contributors

Languages