Brunch Wordpress Theme

Brunch Wordpress Theme is a WordPress starter theme based on HTML5 Boilerplate, brunch, Bower, and Bootstrap Sass, that will help you make better themes.

• Source: https://github.com/hyyan/brunch-wordpress-theme
• Wiki : Brunch Wordpress Theme Wiki
• Twitter: HyyanAF

Requirements

Prerequisite	How to check	How to install
PHP >= 5.3.x	php -v	php.net
Node.js >= 0.10.25	node -v	nodejs.org
Brunch >= 1.8.2	brunch -v	npm install -g brunch
Bower >= 1.3.12	bower -v	npm install -g bower

Features

• Brunch build script that compiles both Sass and Less, checks for JavaScript errors, optimizes images, and concatenates and minifies files
• Bower for front-end package management
• Sass Bootstrap
• TGM-Plugin-Activation PHP library that allows you to easily require or recommend plugins for your WordPress themes
• WP Bootstrap Navwalker A custom WordPress nav walker class to fully implement the Twitter Bootstrap 3.0+ navigation style

Installation

1. Clone the git repo : git clone https://github.com/hyyan/brunch-wordpress-theme.git and then rename the directory to the name of your theme or website.

Configuration

1. If you want to use compass set the http_path in config.rb to meet your theme relative path wp-content/themes/my-theme-name/

2. if you want libsass instead of ruby to compile sass change to this in your brunch-config.coffe file:

config =
  plugins:
    sass:
      mode: 'native' # set to 'native' to force libsass

Theme Main Folders

1. The app folder will contains assets files (images,sass,js , ...)
2. The inc folder contains the logic of your theme (functions,template-tags,configurations , ...)
3. The vendor folder contains assets files which can not be handled by Bower
4. The rest files is just orgainzed as any wordpress standard theme

Note : The theme is using brunch-with-hyyan sekelton , you can read more about to take a deeper look

Theme development

Brunch Wordpress Theme uses Brunch as its build system and Bower to manage front-end packages.

1 - Install Brunch and Bower

Building the theme requires node.js.

From the command line:

1. Install Brunch and Bower globally with npm install -g brunch bower
2. Navigate to the theme directory, then run npm install

You now have all the necessary dependencies to run the build process.

2 - Available Brunch commands

• brunch build — Compile and optimize the files in your app directory
• brunch watch — Compile assets when file changes are made
• brunch build --production — Compile assets for production (no source maps).

Documentaions

• Understanding Frontend Package Management
• Require Or Recommend Plugins For Your WordPress Themes
• Wordpress Menus And SideBars
• Theme Deployment

Contributing

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

• Reporting issues (please read issue guidelines)
• Suggesting new features
• Writing or refactoring code
• Fixing issues