Converter Plugin that brings Pug support to the Jekyll blog-aware, static site generator
Ruby
Pull request Compare This branch is 5 commits ahead of snappylabs:master.
Latest commit 9c34e95 May 10, 2016 @mdxprograms Update README.md
Permalink
Failed to load latest commit information.
.gitignore Initial commit Jun 12, 2013
LICENSE Initial import Jun 12, 2013
README.md Update README.md May 10, 2016
pug.rb Create pug.rb Apr 22, 2016

README.md

pug-jekyll-plugin (previously jade-jekyll-plugin)

Converter Plugin that brings Pug support to the Jekyll blog-aware, static site generator.

HOWTO

  1. Install Pug with NPM. e.g. $ npm install pug -g
  2. Place the pug.rb file into your Jekyll installation under _plugins/
  3. All static pages and posts ending in the extension .pug are now processed through Pug automatically.
  4. Layouts need special treatment, see below.

Applying Pug to Layouts

Unfortunately Jekyll doesn't yet allow plugins to pre-process layout files before further processing. To write your layouts in Pug, you therefore have to render them externally. Fortunately this only needs to be done frequently for a small period of time, during layout development.

During layout development, we recommend:

  1. Create a _layouts/pug/ folder where you will place your "pre-rendered" Pug source.
  2. Create a Makefile or shell script to execute the Pug compile-and-watch command: pug -w -o ../ *.pug
  3. In another terminal, simultaneously run your Jekyll builds: e.g. jekyll serve -w

License

See LICENSE.