mikevosje/sage

WordPress starter theme with a modern development workflow

Sunday, May 20, 2018
by wappz
Repository
1 Watchers
0 Stars
22 Installations

PHP
0 Dependents
0 Suggesters
2818 Forks
0 Open issues
31 Versions
0 % Grown

The README.md

Sage

, _(*1)

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

Features

Sass for stylesheets
Modern JavaScript
Webpack for compiling assets, optimizing images, and concatenating and minifying files
Browsersync for synchronized browser testing
Blade as a templating engine
Controller for passing data to Blade templates
CSS framework (optional): Bootstrap 4, Bulma, Foundation, Tachyons

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

Requirements

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

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

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 roots/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 roots/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)

, _(*11)

Community

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

Participate on the Roots Discourse
Follow @rootswp on Twitter
Read and subscribe to the Roots Blog
Subscribe to the Roots Newsletter
Listen to the Roots Radio podcast

The Versions

20/05 2018

dev-master

9999999-dev https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

20/05 2018

9.0.30

9.0.30.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

20/05 2018

9.0.29

9.0.29.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

24/04 2018

9.0.28

9.0.28.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

14/03 2018

9.0.27

9.0.27.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

14/03 2018

9.0.26

9.0.26.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

01/03 2018

9.0.24

9.0.24.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

21/02 2018

9.0.22

9.0.22.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

07/02 2018

9.0.0

9.0.0.0 https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

26/12 2017

dev-laravel-mix

dev-laravel-mix https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

05/11 2017

8.5.3.x-dev

8.5.3.9999999-dev 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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

wordpress

21/10 2017

dev-sage-8

dev-sage-8 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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

wordpress

14/08 2017

8.5.2.x-dev

8.5.2.9999999-dev 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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

wordpress

12/08 2017

9.0.0-beta.4

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

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

wordpress

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

squizlabs/php_codesniffer ^2.8.0

by Scott Walkinshaw

by Ben Word

wordpress

04/04 2017

dev-rename-base-to-app

dev-rename-base-to-app https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

squizlabs/php_codesniffer ^2.5.1

by Scott Walkinshaw

by Ben Word

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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

wordpress

21/02 2017

8.5.1.x-dev

8.5.1.9999999-dev 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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

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

squizlabs/php_codesniffer ^2.5.1

by Scott Walkinshaw

by Ben Word

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

by Scott Walkinshaw

by Ben Word

wordpress

13/12 2016

dev-migrate-build-files-to-npm-package

dev-migrate-build-files-to-npm-package https://roots.io/sage/

WordPress starter theme with a modern development workflow

Sources Download

MIT

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

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

php >=5.5.0
composer/installers ~1.0

The Development Requires

by Scott Walkinshaw

by Ben Word

wordpress

21/09 2016

8.5.0.x-dev

8.5.0.9999999-dev 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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

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

php >=5.5.0
composer/installers ~1.0

The Development Requires

by Scott Walkinshaw

by Ben Word

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

php >=5.5.0
composer/installers ~1.0

The Development Requires

by Scott Walkinshaw

by Ben Word

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

php >=5.5.0
composer/installers ~1.0

The Development Requires

by Scott Walkinshaw

by Ben Word

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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

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

php >=5.4.0
composer/installers ~1.0

by Scott Walkinshaw

by Ben Word

wordpress

wordpress-theme sage

WordPress starter theme with a modern development workflow

mikevosje/sage

The README.md

Sage

Features

Requirements

Theme installation

Theme structure

Theme setup

Theme development

Build commands

Documentation

Contributing

Gold sponsors

Community

The Versions

dev-master

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.30

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.29

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.28

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.27

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.26

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.24

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.22

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

9.0.0

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

dev-laravel-mix

The Requires

The Development Requires

by Scott Walkinshaw

by Ben Word

by qwp6t

8.5.3.x-dev

The Requires

by Scott Walkinshaw