Wordless’s documentation

Introduction

Wordless is an opinionated WordPress plugin + starter theme that dramatically speeds up and enhances your custom theme creation. Some of its features are:

• A structured, organized and clean theme organization
• Scaffold a new theme directly within wp-cli
• Write PHP templates with PUG templating language
• Write CSS stylesheets using the awesome SCSS syntax
• Write Javascript logic in ES2015
• A growing set of handy and documented PHP helper functions ready to be used within your views
• Preconfigured support to MailHog mail-catcher.
• Development workflow backed by WebPack, BrowserSync (with live reload), WP-CLI, Yarn. All the standards you already know, all the customizations you may need.

Wordless is a micro-framework for custom themes development. Thus is a product intended for developers.

A compiled Wordless theme will run on any standard Wordpress installation.

Wordless does not alter any core functionality, thus it is compatible with reasonably any generic plugin.

Table of Contents

Installation

• Prerequisites
• Wordless gem
• Manual installation
  • Additional prerequisites
  • Steps

Usage and structure

• Theme anatomy
• Routing
• Rendering PUG
  • Layouts
  • Templates
  • Partials
  • Components
    • Arguments validation
• SCSS and JS
  • The Fast Way
  • A real explanation
    • Custom assets
    • node_modules
  • Linters
• PHP Helpers
• Initializers
• Locale files
• Filters
  • wordless_pug_configuration
  • wordless_acf_gutenberg_blocks_views_path
  • wordless_tmp_dir_exists
  • wordless_environment
• Actions
  • wordless_component_validation_exception
• CLI
• Test Suite
  • Quick start
  • Where are test configurations?
  • How should I write tests?
    • Factory template
  • CI
  • Troubleshooting

Build and deployment

• Intro
• Development build
• Production build
  • Release signature
  • PHUG optimizer
• Deploy

Development stack

• Intro
• Nodejs
  • Version
  • NVM
• Development environment
  • YARN
  • Foreman
  • wp server
  • BrowserSync
  • MailHog
  • Debug in VSCode
• Code compilation
  • PHUG
    • Who compiles PUG?
  • JS and SCSS
    • Paths
    • Inclusion of compiled files
    • Multiple “entries”
    • Browserslist
    • Stylelint

Appendix

• Static rendering
  • Static template example
  • Static partial example
  • Invalidating the cache
  • Manually manage cache SHA
  • Known limitations
• ACF Gutenberg Blocks
• Using plain PHP templates
  • PHP render helpers
    • render_view()
    • render_partial()
    • Layouts

TODOs

A list of known bugs, wip and improvements this documentation needs, hoping it will be kept empty ;)