Scaffold out a handlebars theme from a Jekyll theme using Hekyll.

generate-hekyll

Usage

var generateHekyll = require('generate-hekyll');

Getting started

Install

Installing the CLI

To run the readme generator from the command line, you'll need to install [Generate][] globally first. You can do that now with the following command:

$ npm install --global generate

This adds the gen command to your system path, allowing it to be run from any directory.

Install generate-hekyll

Install this module with the following command:

$ npm install --global generate-hekyll

CLI

Run this generator's default task with the following command:

$ gen readme

What you should see in the terminal

If completed successfully, you should see both starting and finished events in the terminal, like the following:

[00:44:21] starting ...
...
[00:44:22] finished ✔

If you do not see one or both of those events, please let us know about it.

Help

To see a general help menu and available commands for Generate's CLI, run:

$ gen help

Available tasks

All available tasks for this generator.

default

Scaffold out a new handlebars blog or site from a jekyll theme.

Example

$ gen hekyll
$ gen hekyll:default

delete

Delete themes that have been cloned and cached by generate-hekyll from the generate-hekyll/themes directory. This does not delete your copy of the theme, only the cached version used by generate-hekyll.

Example

$ gen hekyll:delete

Visit Generate's documentation for tasks.

Next steps

Running unit tests

It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:

$ npm install && test

Publishing your generator

If you're tests are passing and you're ready to publish your generator to npm, you can do that now with the following command:

Are you sure you're ready?!

Let's go!

$ npm publish

About

What is "Generate"?

Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks.

Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.

For more information:

• Visit the generate project
• Visit the generate documentation
• Find generators on npm (help us author generators)

Related projects

• generate-project: Scaffold out complete code projects from the command line, or use this generator as a… more | homepage
• generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
• hekyll-cli: CLI for hekyll, the Jekyll to Handlebars theme converter. | homepage
• hekyll: Migrate Jekyll (gh-pages) themes to use handlebars instead of liquid. | homepage

Community

Bigger community means more plugins, better support and more progress. Help us make Generate better by spreading the word:

• Show your love by starring the project
• Tweet about Generate. Mention using @generatejs, or use the #generatejs hashtag
• Get implementation help on StackOverflow with the generatejs tag
• Discuss Generate with us on Gitter
• If you publish a generator, to make your project as discoverable as possible, please add the unique keyword generategenerator to your project's package.json.

Contributing

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

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.