sage-timber
# SageTimber Starter Theme for Wordpress SageTimber is [Sage theme](https://github.com/roots/sage) ported to work with [Timber](https://www.upstatement.com/timber/). Sage is a WordPress starter theme based on HTML5 Boilerplate, [gulp](http://gulpjs.com/), [Bower](http://bower.io/), and [Bootstrap](http://getbootstrap.com/), that will help you make better themes. ## Requirements | Prerequisite | How to check | How to install | --------------- | ------------ | ------------- | | PHP >= 5.4.x | `php -v` | [php.net](http://php.net/manual/en/install.php) | | Node.js >= 4.5 | `node -v` | [nodejs.org](http://nodejs.org/) | | gulp >= 3.8.10 | `gulp -v` | `npm install -g gulp` | | Bower >= 1.3.12 | `bower -v` | `npm install -g bower` | For more installation notes, refer to the [Install gulp and Bower](#install-gulp-and-bower) section in this document. ## Features * [Timber](https://www.upstatement.com/timber/) a faster, easier and more powerful way to build themes * [gulp](http://gulpjs.com/) build script that compiles both Sass and Less, 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/) * ARIA roles and microformats * 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) ## Theme installation Install SageTimber by copying the project into a new folder within your WordPress themes directory. ## Theme setup Edit `lib/setup.php` to enable or disable theme features, setup navigation menus, post thumbnail sizes, post formats, and sidebars. ## Theme development SageTimber 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: 1. Install [gulp](http://gulpjs.com) and [Bower](http://bower.io/) globally with `npm install -g gulp bower` 2. Navigate to the theme directory, then run `npm install` 3. 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: ```json ... "config": { "devUrl": "http://project-name.test" } ... ``` If your local development URL looks like `http://localhost:8888/project-name/` you would update the file to read: ```json ... "config": { "devUrl": "http://localhost:8888/project-name/" } ... ``` ## Documentation * Sage: [https://github.com/roots/sage](https://github.com/roots/sage) * Twig: [http://twig.sensiolabs.org/](http://twig.sensiolabs.org/) * Timber: [https://github.com/jarednova/timber/wiki](https://github.com/jarednova/timber/wiki) ## Contributing Contributions are welcome from everyone. Just issue a pull request to this repository. ## Sage 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/) * Listen to the [Roots Radio podcast](https://roots.io/podcast/)