2017 © Pedro Pelรกez
 

wordpress-theme sage

WordPress starter theme with a modern development workflow

image

21stdigital/sage

WordPress starter theme with a modern development workflow

  • Sunday, May 13, 2018
  • by robocopklaus
  • Repository
  • 3 Watchers
  • 0 Stars
  • 3 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 2815 Forks
  • 0 Open issues
  • 19 Versions
  • 0 % Grown

The README.md

Sage

Packagist devDependency Status Build Status, (*1)

Sage is a WordPress starter theme with a modern development workflow., (*2)

Features

See a working example at roots-example-project.com., (*3)

Requirements

Make sure all dependencies have been installed before moving on:, (*4)

Theme installation

Install Sage using Composer from your WordPress themes directory (replace your-theme-name below with the name of your theme):, (*5)

# @ app/themes/ or wp-content/themes/
$ composer create-project 21stdigital/sage your-theme-name

To install the latest development version of Sage, add dev-master to the end of the command:, (*6)

$ composer create-project 21stdigital/sage your-theme-name dev-master

During theme installation you will have options to update style.css theme headers, select a CSS framework, and configure Browsersync., (*7)

Theme structure

themes/your-theme-name/   # โ†’ Root of your Sage based theme
โ”œโ”€โ”€ app/                  # โ†’ Theme PHP
โ”‚   โ”œโ”€โ”€ controllers/      # โ†’ Controller files
โ”‚   โ”œโ”€โ”€ admin.php         # โ†’ Theme customizer setup
โ”‚   โ”œโ”€โ”€ filters.php       # โ†’ Theme filters
โ”‚   โ”œโ”€โ”€ helpers.php       # โ†’ Helper functions
โ”‚   โ””โ”€โ”€ setup.php         # โ†’ Theme setup
โ”œโ”€โ”€ composer.json         # โ†’ Autoloading for `app/` files
โ”œโ”€โ”€ composer.lock         # โ†’ Composer lock file (never edit)
โ”œโ”€โ”€ dist/                 # โ†’ Built theme assets (never edit)
โ”œโ”€โ”€ node_modules/         # โ†’ Node.js packages (never edit)
โ”œโ”€โ”€ package.json          # โ†’ Node.js dependencies and scripts
โ”œโ”€โ”€ resources/            # โ†’ Theme assets and templates
โ”‚   โ”œโ”€โ”€ assets/           # โ†’ Front-end assets
โ”‚   โ”‚   โ”œโ”€โ”€ config.json   # โ†’ Settings for compiled assets
โ”‚   โ”‚   โ”œโ”€โ”€ build/        # โ†’ Webpack and ESLint config
โ”‚   โ”‚   โ”œโ”€โ”€ fonts/        # โ†’ Theme fonts
โ”‚   โ”‚   โ”œโ”€โ”€ images/       # โ†’ Theme images
โ”‚   โ”‚   โ”œโ”€โ”€ scripts/      # โ†’ Theme JS
โ”‚   โ”‚   โ””โ”€โ”€ styles/       # โ†’ Theme stylesheets
โ”‚   โ”œโ”€โ”€ functions.php     # โ†’ Composer autoloader, theme includes
โ”‚   โ”œโ”€โ”€ index.php         # โ†’ Never manually edit
โ”‚   โ”œโ”€โ”€ screenshot.png    # โ†’ Theme screenshot for WP admin
โ”‚   โ”œโ”€โ”€ style.css         # โ†’ Theme meta information
โ”‚   โ””โ”€โ”€ views/            # โ†’ Theme templates
โ”‚       โ”œโ”€โ”€ layouts/      # โ†’ Base templates
โ”‚       โ””โ”€โ”€ partials/     # โ†’ Partial templates
โ””โ”€โ”€ vendor/               # โ†’ Composer packages (never edit)

Theme setup

Edit app/setup.php to enable or disable theme features, setup navigation menus, post thumbnail sizes, and sidebars., (*8)

Theme development

  • Run yarn 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)

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

Contributing

Contributions are welcome from everyone. We have contributing guidelines to help you get started., (*9)

Gold sponsors

Help support our open-source development efforts by contributing to Sage on OpenCollective., (*10)

Kinsta KM Digital, (*11)

Community

Keep track of development and community news., (*12)

The Versions

13/05 2018
13/04 2018
16/02 2018

8.5.4

8.5.4.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress

18/08 2017

8.5.3

8.5.3.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress

14/08 2017

8.5.2

8.5.2.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress

12/08 2017
22/04 2017

9.0.0-beta.3

9.0.0.0-beta3 https://roots.io/sage/

WordPress starter theme with a modern development workflow

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

21/02 2017

8.5.1

8.5.1.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress

19/01 2017

9.0.0-beta.2

9.0.0.0-beta2 https://roots.io/sage/

WordPress starter theme with a modern development workflow

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

10/01 2017

9.0.0-beta.1

9.0.0.0-beta1 https://roots.io/sage/

WordPress starter theme with a modern development workflow

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

17/11 2016

9.0.0-alpha.4

9.0.0.0-alpha4 https://roots.io/sage/

WordPress starter theme with a modern development workflow

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

21/09 2016

8.5.0

8.5.0.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress

12/09 2016

9.0.0-alpha.3

9.0.0.0-alpha3 https://roots.io/sage/

WordPress starter theme with a modern development workflow

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

05/09 2016

9.0.0-alpha.2

9.0.0.0-alpha2 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

30/08 2016

9.0.0-alpha.1

9.0.0.0-alpha1 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

The Development Requires

wordpress

19/02 2016

8.4.2

8.4.2.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress

27/01 2016

8.4.1

8.4.1.0 https://roots.io/sage/

The best WordPress starter theme with a modern front-end development workflow. Based on HTML5 Boilerplate, gulp, Bower, and Bootstrap.

  Sources   Download

MIT

The Requires

 

wordpress