98 lines
4.4 KiB
Markdown
98 lines
4.4 KiB
Markdown
# [Roots Theme](http://roots.io/)
|
|
|
|
[](http://gruntjs.com/)
|
|
|
|
Roots is a WordPress starter theme based on [HTML5 Boilerplate](http://html5boilerplate.com/) & [Bootstrap](http://getbootstrap.com/) that will help you make better themes.
|
|
|
|
* Source: [https://github.com/roots/roots](https://github.com/roots/roots)
|
|
* Home Page: [http://roots.io/](http://roots.io/)
|
|
* Twitter: [@retlehs](https://twitter.com/retlehs)
|
|
* Newsletter: [Subscribe](http://roots.io/subscribe/)
|
|
* Forum: [http://discourse.roots.io/](http://discourse.roots.io/)
|
|
|
|
## Installation
|
|
|
|
Clone the git repo - `git clone git://github.com/roots/roots.git` - or [download it](https://github.com/roots/roots/zipball/master) 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:
|
|
|
|
```php
|
|
define('WP_ENV', 'development');
|
|
```
|
|
|
|
## Theme activation
|
|
|
|
Reference the [theme activation](http://roots.io/roots-101/#theme-activation) documentation to understand everything that happens once you activate Roots.
|
|
|
|
## Compiling CSS and JavaScript
|
|
|
|
Roots uses [Grunt](http://gruntjs.com/) for compiling LESS to CSS, checking for JS errors, live reloading, concatenating and minifying files, versioning assets, and generating lean Modernizr builds.
|
|
|
|
To use it, install the required dependencies as directed and then run some Grunt commands.
|
|
|
|
### Install Grunt
|
|
|
|
From the command line:
|
|
|
|
1. Install `grunt-cli` globally with `npm install -g grunt-cli`.
|
|
2. Navigate to the theme directory, then run `npm install`. npm will look at `package.json` and automatically install the necessary dependencies. It will also automatically run `bower install`, which references dependencies in `bower.json`.
|
|
|
|
When completed, you'll be able to run the various Grunt commands provided from the command line.
|
|
|
|
**Unfamiliar with npm? Don't have node installed?** [Download and install node.js](http://nodejs.org/download/) before proceeding.
|
|
|
|
### Available Grunt commands
|
|
|
|
* `grunt dev` — Compile LESS to CSS, concatenate and validate JS
|
|
* `grunt watch` — Compile assets when file changes are made
|
|
* `grunt build` — Create minified assets that are used on non-development environments
|
|
|
|
## Configuration
|
|
|
|
Edit `lib/config.php` to enable or disable support for various theme functions and to define constants.
|
|
|
|
Edit `lib/init.php` to setup navigation menus, post thumbnail sizes, post formats, and sidebars.
|
|
|
|
## Documentation
|
|
|
|
### [Roots Docs](http://roots.io/docs/)
|
|
|
|
* [Roots 101](http://roots.io/roots-101/) — A guide to installing Roots, the files and theme organization
|
|
* [Theme Wrapper](http://roots.io/an-introduction-to-the-roots-theme-wrapper/) — Learn all about the theme wrapper
|
|
* [Build Script](http://roots.io/using-grunt-for-wordpress-theme-development/) — A look into the Roots build script powered by Grunt
|
|
* [Roots Sidebar](http://roots.io/the-roots-sidebar/) — Understand how to display or hide the sidebar in Roots
|
|
|
|
## Features
|
|
|
|
* Organized file and template structure
|
|
* HTML5 Boilerplate's markup along with ARIA roles and microformat
|
|
* Bootstrap
|
|
* [Grunt build script](http://roots.io/using-grunt-for-wordpress-theme-development/)
|
|
* Bower for front-end package management
|
|
* [Theme activation](http://roots.io/roots-101/#theme-activation)
|
|
* [Theme wrapper](http://roots.io/an-introduction-to-the-roots-theme-wrapper/)
|
|
* Cleaner HTML output of navigation menus
|
|
* Posts use the [hNews](http://microformats.org/wiki/hnews) microformat
|
|
* [Multilingual ready](http://roots.io/wpml/) and over 30 available [community translations](https://github.com/roots/roots-translations)
|
|
|
|
### Features from [Soil](https://github.com/roots/soil)
|
|
|
|
* Root relative URLs
|
|
* Nice search (`/search/query/`)
|
|
* Cleaner output of `wp_head` and enqueued scripts/styles
|
|
* Image captions use `<figure>` and `<figcaption>`
|
|
|
|
## Contributing
|
|
|
|
Everyone is welcome to help [contribute](CONTRIBUTING.md) and improve this project. There are several ways you can contribute:
|
|
|
|
* Reporting issues (please read [issue guidelines](https://github.com/necolas/issue-guidelines))
|
|
* Suggesting new features
|
|
* Writing or refactoring code
|
|
* Fixing [issues](https://github.com/roots/roots/issues)
|
|
* Replying to questions on the [forum](http://discourse.roots.io/)
|
|
|
|
## Support
|
|
|
|
Use the [Roots Discourse](http://discourse.roots.io/) to ask questions and get support.
|