Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/hekyll-cli
CLI for hekyll, the Jekyll to Handlebars theme converter.
https://github.com/jonschlinkert/hekyll-cli
blog convert handlebars hekyll jekyll static-site static-site-generator theme
Last synced: 21 days ago
JSON representation
CLI for hekyll, the Jekyll to Handlebars theme converter.
- Host: GitHub
- URL: https://github.com/jonschlinkert/hekyll-cli
- Owner: jonschlinkert
- License: mit
- Created: 2017-08-12T06:18:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-21T17:59:26.000Z (about 7 years ago)
- Last Synced: 2024-10-04T16:51:31.988Z (about 1 month ago)
- Topics: blog, convert, handlebars, hekyll, jekyll, static-site, static-site-generator, theme
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 8.79 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# hekyll-cli [](https://www.npmjs.com/package/hekyll-cli) [](https://npmjs.org/package/hekyll-cli) [](https://npmjs.org/package/hekyll-cli)
> CLI for hekyll, the Jekyll to Handlebars theme converter.
Follow this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), for updates on this project and others.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save hekyll-cli
```
## Quickstart
Get the [poole/lanyon](https://github.com/poole/lanyon) theme and convert it using [hekyll](https://github.com/jonschlinkert/hekyll):
```sh
$ hekyll -r poole/lanyon
```
## Usage
```sh
$ hekyll [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](https://github.com/jonschlinkert/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.
```sh
$ 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.
```sh
$ hekyll poole/poole -r
```
## About
### Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ 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:
```sh
$ npm install && npm test
```
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 21, 2017._