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 the Pug templating system
• Write CSS stylesheets using the awesome Sass syntax
• Write Javascript logic in Coffeescript
• A growing set of handy and documented PHP helper functions ready to be used within your views
• Development workflow backed by WebPack, BrowserSync (with live reload), WP-CLI, Yarn. All the standards you already know, all the customizations you may need.

Contents

• Installation
  • Wordless GEM (favourite)
  • (Not so) Manual
    • Prerequisites
    • Steps
• Usage
  • Theme anatomy
    • Routing
    • Rendering
      • render_view()
      • render_partial()
      • Layouts
      • Views
    • Helpers
    • Initializers
    • Locale files
    • Assets
      • The Fast Way
      • I need to really understand
        • Custom assets
        • node_modules
  • Build and distribution
    • Build for development
    • Build for production
      • Release signature
    • Code linting
    • PHUG optimizer
    • Deploy
  • Filters
    • wordless_pug_configuration
• Development stack
  • Nodejs
    • Version
    • NVM
  • Development environment
    • YARN
    • Foreman
    • wp server
    • BrowserSync
    • MailHog
  • Code compilation
    • PHUG
      • Who compiles PUG?
    • CoffeeScript and Sass
      • Paths
      • Inclusion of compiled files
      • Multiple “entries”
  • Using plain PHP templates
    • Conclusions