WordPress theme buildsystem with gulp, jade, less, browsersync, babel, etc...
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
copy
jade
js-concat
js
less
.gitignore
.htaccess
LICENSE
README.md
gulp-config-local.env
gulpfile.js
package.json
script-gulp.sh

README.md

Jade/Less/BrowserSync/Babel WordPress Theme Buildsystem

A buildsystem for creating a WordPress theme using gulp, jade, less, browsersync, babel and a few other javascript lovelies.

This repo is not a theme.
It's a buildsystem to make a theme.

To create a new theme from scratch, like any other new theme, first create a folder in wp-content/themes. Then clone this repo into your new folder as a sub folder.

Here's a full example of what you might do:

cd wp-content/themes
mkdir mytheme
cd mytheme
git clone https://github.com/rc1/WordpressJadeBuildsystem.git src
cd src
npm install
gulp default watch

Keyfiles

  • Theme Meta - copy/style.css
  • Theme Config & PHP Utilities - copy/functions.php

Buildsystem

Here is how the gulpfile.js is currently setup. The idea is that no built files are stored in this repo (and are therefore will not be under source control).

Copy

Anything in the ./copy folder will be copied into the parent theme folder.

Jade

To use jadephp and output .php instead of .html files the jade filename must end in .php.jade

All .jade files in ./jade except for any files in ./jade/includes will be compiled and placed into the parent theme folder.

There is some stub theme components in there already. It assumes that index.php.jade is a router. Only suitable for small sites.

Less

Only one less file is compiled. That file is ./less/all.less. From all.less you can include other less or css files.

JS (all.js)

All javascript files in ./js will be compiled into a js called all.js. main.js will be concatenated last. This folder is handy for your custom javascript.

JS (concat.js)

All javascript files in ./js-concat will be concatenated only into a file called concat.js. This folder is handy for placing your minified libraries.

Running gulp

Gulp can be run by using:

$ ./script-gulp.sh

This will pull configuration settings from gulp-config-local.env. Useful for having different build settings. See gulpfile.js for more info.