First ·

My first WordPress theme made with Sage. Live version.

See a working setup example at roots-example-project.

Requirements

Make sure all dependencies have been installed before moving on:

• WordPress >= 4.7
• PHP >= 7.1.3 (with php-mbstring enabled)
• Composer
• Node.js >= 8.0.0
• Yarn

Theme development

• Run yarn and composer install from the theme directory to install dependencies
• Update resources/assets/config.json settings:
  • devUrl should reflect your local development hostname
  • publicPath should reflect your WordPress folder structure (/wp-content/themes/sage for non-Bedrock installs)
  • devSsl which should be generated according to SSL Manual Guide

Build commands

• yarn start — Compile assets when file changes are made, start Browsersync session
• yarn build — Compile and optimize the files in your assets directory
• yarn build:production — Compile assets for production

Documentation

• Sage documentation
• Controller documentation
• Tailwind CSS documentation