Roots on the rocks is a WordPress starter theme based on Roots. Bootstrap has been removed, and Bourbon Neat added in its place.
Roots on the rocks uses:
- Bourbon
- Bourbon Neat
- Libsass
Clone the git repo - git clone git://github.com/onishiweb/root-on-the-rocks.git
- or download it and then rename the directory to the name of your theme or website.
If you don't use Bedrock, you'll need to add the following to your wp-config.php
on your development installation:
define('WP_ENV', 'development');
Reference the Roots theme activation documentation to understand everything that happens once you activate Roots.
Edit lib/config.php
to enable or disable theme features and to define a Google Analytics ID.
Edit lib/init.php
to setup navigation menus, post thumbnail sizes, post formats, and sidebars.
Roots on the rocks uses Grunt for compiling SCSS to CSS, checking for JS errors, live reloading, concatenating and minifying files, versioning assets, and generating lean Modernizr builds.
Unfamiliar with npm? Don't have node installed? Download and install node.js before proceeding.
From the command line:
- Install
grunt-cli
andbower
globally withnpm install -g grunt-cli bower
. - Navigate to the theme directory, then run
npm install
. npm will look atpackage.json
and automatically install the necessary dependencies. It will also automatically runbower install
, which installs front-end packages defined inbower.json
.
When completed, you'll be able to run the various Grunt commands provided from the command line.
N.B.
You will need write permission to the global npm directory to install grunt-cli
and bower
. You will also likely have to be using an elevated terminal or prefix the command with sudo
, i.e., sudo npm install -g grunt-cli bower
.
We also advise against running as root user. NPM deliberately uses limited privileges when executing certain commands such as those included in the Roots post-install process, and when this happens to the root user, any file system objects that are not expressly writable by the root user will fail to write during the execution of the command. These might include directories such as /var/www
or /home/someotheruser
. If you're running as root and have problems, don't say we didn't warn you.
grunt dev
— Compile SCSS to CSS, concatenate and validate JSgrunt watch
— Compile assets when file changes are madegrunt build
— Create minified assets that are used on non-development environments
- Bourbon — Documentation for Bourbon Sass mixins
- Bourbon Neat - Documentation for Neat grid system
- Roots 101 — A guide to installing Roots, the files, and theme organization
- Theme Wrapper — Learn all about the theme wrapper
- Build Script — A look into how Roots uses Grunt
- Roots Sidebar — Understand how to display or hide the sidebar in Roots