jsw0528/jekyll-cli

View on GitHub
README.md

Summary

Maintainability
Test Coverage
[![Code Climate](https://codeclimate.com/github/jsw0528/jekyll-cli.png)](https://codeclimate.com/github/jsw0528/jekyll-cli)
[![Dependencies](https://david-dm.org/jsw0528/jekyll-cli.png)](https://david-dm.org/jsw0528/jekyll-cli)
[![NPM version](https://badge.fury.io/js/jekyll-cli.png)](http://badge.fury.io/js/jekyll-cli)

## Installation

```bash
$ npm install -g jekyll-cli
```

## Getting Started

- [Using Jekyll with GitHub Pages](http://mrzhang.me/blog/using-jekyll-with-github-pages.html)
- [Jekyll Documents](http://jekyllrb.com/)
- [Standard Liquid tags and filters](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers)

## Commands

```bash
$ jkl new [options] <PATH>    Creates a new Jekyll site scaffold in PATH
$ jkl post [options] <TITLE>  Create a new post
$ jkl watch [options]         Watch the changes locally
$ jkl sass [options]          Compile Sass stylesheets
$ jkl git                     Setup git repository
$ jkl deploy [options]        Deploy to GitHub
```

__Display command help documentation__

```bash
$ jkl post -h
```

```
  Usage: post [options] <TITLE>

  Options:

    -h, --help    output usage information
    -d, --drafts  As a draft
    --ext <NAME>  Specify the extension name (Defaults to md)
```

## License

Licensed under the [MIT License](http://www.opensource.org/licenses/mit-license.php).