A template agnostic static site generator.
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-haychtml --save-dev
This task recursively renders templates from a source folder to a destination folder.
src/index.jade > dest/index.htmlsrc/subfolder/index.jade > dest/subfolder/index.html
It ignores files and folders that start with an underscore.
src/_base.jade >src/_includes/header.jade >src/index.jade > dest/index.html
It can strip extensions for cleaner urls.
This way, you can link to other pages using
/about/ instead of
src/index.jade > dest/index.htmlsrc/about.jade > dest/about/index.html
In your project's Gruntfile, add a section named
haychtml to the data object passed into
The folder in which to find the source files.
The folder in which to place rendered files.
The template engine to use to render the files. The template engine must be supported by consolidate.js.
The source files extenstion. This defaults to
.html, but can be changed
depending on the type of template engine used (e.g.
Only files with this extension will be rendered.
Global data to be passed to each template.
Whether or not to strip
.html from the source files. Defaults to
true, this will try to save files in a subfolder
index.html file. Because of this transformation, it is possible to
have two source files that map to the same destination path. If this happens,
an error will be thrown to help debug.
stripExtension = true.
index.html > index.htmlabout.html > about/index.htmlabout/index.html > about/index.html
false, the destination path will directly mirror the
stripExtension = false.
index.html > index.htmlabout.html > about.htmlabout/index.html > about/index.html
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
0.1.0 : Initial release