weroots Theme

weroots is a Wordpress starter theme based on Roots Theme.

The theme is based on SASS, so it requires the sass ruby gem, it uses Bower to manage frontend dependencies and Grunt to execute tasks.

Installation

Clone the git repo - git clone git://github.com/webrain/weroots.git - and then rename the directory to the name of your theme or website. Install Grunt, and then install the dependencies for weroots contained in package.json by running the following from the theme directory:

npm install

Then install Bower and install the frontend dependencies contained in bower.json by running the following from the root theme directory:

bower install

Then to finalize the setup just run the following command:

grunt weroots-setup

The ruby sass gem is required to compile the scss files. To install that just execute:

gem install sass

This will move assets files in meaningful directories, compiles and minify javascript and css for the first time. Now you can enable the theme from the Wordpress appearance panel.

Theme Development

After you've installed Grunt and ran npm install from the theme root, use grunt watch to watch for updates to your Sass and JS files and Grunt will automatically re-build as you write your code. You can also use a Livereload extension for your browser to get live page reloading.

Configuration

Edit lib/config.php to enable or disable support for various theme functions and to define constants that are used throughout the theme.

Edit lib/init.php to setup custom navigation menus and post thumbnail sizes.

Documentation

The theme documentation is a work in progress. You can refer to the Roots theme documentation for now, this theme shares a lot with Roots.

Features

• Organized file and template structure
• HTML5 Boilerplate's markup along with ARIA roles and microformat
• Bootstrap
• Grunt build script
• Theme activation
• Theme wrapper
• Root relative URLs
• Clean URLs (no more /wp-content/)
• All static theme assets are rewritten to the website root (/assets/*)
• Cleaner HTML output of navigation menus
• Cleaner output of wp_head and enqueued scripts/styles
• Nice search (/search/query/)
• Image captions use <figure> and <figcaption>
• Example vCard widget
• Posts use the hNews microformat
• Multilingual ready (Brazilian Portuguese, Bulgarian, Catalan, Danish, Dutch, English, Finnish, French, German, Hungarian, Indonesian, Italian, Korean, Macedonian, Norwegian, Polish, Russian, Simplified Chinese, Spanish, Swedish, Traditional Chinese, Turkish, Vietnamese, Serbian)

Contributing

Everyone is welcome to help contribute and improve this project. There are several ways you can contribute:

• Reporting issues
• Suggesting new features
• Writing or refactoring code
• Fixing issues

Support

We are available for support through Github issues, you can also usually tweet us. For customization requests or urgent support we are available for hire. Contact us through our website.