hekyll

hekyll

Migrate Jekyll (gh-pages) themes to use handlebars instead of liquid.

Install

Install with npm:

$ npm install --save hekyll

Usage

The main function expects an options object with src and dest properties, and returns a promise.

var hekyll = require('hekyll');
hekyll(options);

Options

• src: the directory with source files for a Jekyll theme.
• dest: the destination path for the converted theme.

Example

hekyll({src: 'themes/poole', dest: 'src'})
  .then(function() {
    console.log('finished!');
  })
  .catch(console.error);

Choosing a theme

~20 jekyll themes were tested during the creation of this library, including all of the poole/poole themes from @mdo, and all of the built-in gh-pages themes. Most themes convert flawlessly, but some have nuances that might require some manual editing.

Handlebars helpers

To be able to render the migrated templates with handlebars, you will first need to include any missing handlebars helpers that were converted from liquid filters and tags during the migration.

Here are some libraries that might be useful for this:

• template-helpers - generic helpers that can be used with any template engine.
• handlebars-helpers - more than 150 handlebars helpers

Bug reports

If you find a bug or something that doesn't convert correctly, please let me know, I want this to work as seamlessly as possible.

Release history

v2.0.0

Breaking changes

Refactored to simplify. See Usage section for new API.

v1.0.0

First release.

About

Related projects

You might also be interested in these projects:

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• gulp-liquid-to-handlebars: Convert liquid templates to handlebars templates. There are so many resources for jekyll and liquid… more | homepage
• liquid-to-handlebars: Convert liquid templates to handlebars templates. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on August 12, 2017.