-
Notifications
You must be signed in to change notification settings - Fork 56
Test Site
# [Sage](https://roots.io/sage/) [![Build Status](https://travis-ci.org/roots/sage.svg)](https://travis-ci.org/roots/sage) [![devDependency Status](https://david-dm.org/roots/sage/dev-status.svg)](https://david-dm.org/roots/sage#info=devDependencies)
Sage is a WordPress starter theme based on HTML5 Boilerplate, gulp, Bower, and Bootstrap, that will help you make better themes.
- Source: [https://github.com/roots/sage](https://github.com/roots/sage)
- Homepage: [https://roots.io/sage/](https://roots.io/sage/)
- Documentation: [https://roots.io/sage/docs/](https://roots.io/sage/docs/)
- Twitter: [@rootswp](https://twitter.com/rootswp), [@retlehs](https://twitter.com/retlehs), [@swalkinshaw](https://twitter.com/swalkinshaw), [@Foxaii](https://twitter.com/Foxaii), [@c2foryou](https://twitter.com/c2foryou), [@austinpray](https://twitter.com/austinpray)
- Newsletter: [Subscribe](http://roots.io/subscribe/)
- Forum: [https://discourse.roots.io/](https://discourse.roots.io/)
## Requirements
For more installation notes, refer to the [Install gulp and Bower](#install-gulp-and-bower) section in this document.
## Features
- [gulp](http://gulpjs.com/) build script that compiles both Less and Sass, checks for JavaScript errors, optimizes images, and concatenates and minifies files
- [BrowserSync](http://www.browsersync.io/) for keeping multiple browsers and devices synchronized while testing, along with injecting updated CSS and JS into your browser while you're developing
- [Bower](http://bower.io/) for front-end package management
- [asset-builder](https://github.com/austinpray/asset-builder) for the JSON file based asset pipeline
- [Bootstrap](http://getbootstrap.com/)
- [Theme wrapper](https://roots.io/sage/docs/theme-wrapper/)
- [HTML5 Boilerplate](http://html5boilerplate.com/) * The latest [jQuery](http://jquery.com/) via Google CDN, with a local fallback * The latest [Modernizr](http://modernizr.com/) build for feature detection
- ARIA roles and microformats
- Cleaner HTML output of navigation menus
- Posts use the [hNews](http://microformats.org/wiki/hnews) microformat
- [Multilingual ready](https://roots.io/wpml/) and over 30 available [community translations](https://github.com/roots/sage-translations)
Install the [Soil](https://github.com/roots/soil) plugin to enable additional features:
- Cleaner output of wp_head and enqueued assets
- Root relative URLs
- Nice search (/search/query/)
## Installation
Clone the git repo - git clone https://github.com/roots/sage.git and then rename the directory to the name of your theme or website.
If you don't use [Bedrock](https://github.com/roots/bedrock), you'll need to add the following to your wp-config.php on your development installation:
define('WP_ENV', 'development');
## Configuration
Edit lib/config.php to enable or disable theme features
Edit lib/init.php to setup navigation menus, post thumbnail sizes, post formats, and sidebars.
## Theme development
Sage uses [gulp](http://gulpjs.com/) as its build system and [Bower](http://bower.io/) to manage front-end packages.
### Install gulp and Bower
Building the theme requires [node.js](http://nodejs.org/download/). We recommend you update to the latest version of npm: npm install -g npm@latest.
From the command line:
- Install [gulp](http://gulpjs.com) and [Bower](http://bower.io/) globally with npm install -g gulp bower
- Navigate to the theme directory, then run npm install
- Run bower install
You now have all the necessary dependencies to run the build process.
### Available gulp commands
- gulp — Compile and optimize the files in your assets directory
- gulp watch — Compile assets when file changes are made
- gulp --production — Compile assets for production (no source maps).
### Using BrowserSync
To use BrowserSync during gulp watch you need to update devUrl at the bottom of assets/manifest.json to reflect your local development hostname.
For example, if your local development URL is http://project-name.dev you would update the file to read:
...
"config": {
"devUrl": "http://project-name.dev"
}
...
...
"config": {
"devUrl": "http://localhost:8888/project-name/"
}
...
## Documentation
Sage documentation is available at [https://roots.io/sage/docs/](https://roots.io/sage/docs/).
## Contributing
Contributions are welcome from everyone. We have [contributing guidelines](CONTRIBUTING.md) to help you get started.
## Community
Keep track of development and community news.
- Participate on the [Roots Discourse](https://discourse.roots.io/)
- Follow [@rootswp on Twitter](https://twitter.com/rootswp)
- Read and subscribe to the [Roots Blog](https://roots.io/blog/)
- Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)