hekyll-cli

hekyll-cli

CLI for hekyll, the Jekyll to Handlebars theme converter.

Follow this project's author, Jon Schlinkert, for updates on this project and others.

Install

Install with npm:

$ npm install --save hekyll-cli

Quickstart

Get the poole/lanyon theme and convert it using hekyll:

$ hekyll -r poole/lanyon

Usage

$ hekyll <src> <dest> [options]

• src - the source directory with Jekyll theme files
• dest - the destination directory for the converted theme
• options - use -r to clone a remote theme

See hekyll for more detailed documentation and options.

Examples

Convert local Jekyll theme

Convert Jekyll theme files from the local themes/poole directory, and write them to the src directory.

$ hekyll themes/poole src
# automatically writes files to "src" if dest is not passed
$ hekyll themes/poole

Convert remote Jekyll theme

Convert Jekyll theme files from the local themes/poole directory, and write them to the src directory.

$ hekyll poole/poole -r

About

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 September 21, 2017.