Skip to content

Commit 21c037a

Browse files
committed
readme
1 parent 7c50cbd commit 21c037a

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,13 @@
77
[![Dependency Status](https://gemnasium.com/yegor256/jekyll-github-deploy.svg)](https://gemnasium.com/yegor256/jekyll-github-deploy)
88
[![Code Climate](http://img.shields.io/codeclimate/github/yegor256/jekyll-github-deploy.svg)](https://codeclimate.com/github/yegor256/jekyll-github-deploy)
99

10-
## What is jgd ?
11-
1210
If you use some plugins with your Jekyll blog, chances are you can not
1311
have your blog generated by GitHub.
1412

1513
This is where jekyll-github-deploy (a.k.a. jgd) comes in: it will
1614
automatically build your Jekyll blog and push it to your gh-pages
1715
branch.
1816

19-
## Installing
20-
2117
It is assumed that your blog is in the home directory of your repo.
2218

2319
Install it first:
@@ -34,8 +30,6 @@ jgd
3430

3531
Now your site is deployed to `gh-pages` branch of your repo. Done.
3632

37-
## Command Line Options
38-
3933
Below is a list of all command line options.
4034

4135
| Option | Description |
@@ -47,8 +41,6 @@ Below is a list of all command line options.
4741
| `-d` or `--drafts` | Adds the `--drafts` option to Jekyll so that it will build draft posts. |
4842
| `-h` or `--help` | Displays a list of all options. |
4943

50-
## Production variables
51-
5244
If you need to have different values for your deployed blog, just add a
5345
`_config-deploy.yml` file in your project's root and you're set. Values
5446
re-defined in `_config-deploy.yml` will override those defined in
@@ -103,10 +95,11 @@ script:
10395

10496
Read also [this article](http://www.yegor256.com/2014/06/24/jekyll-github-deploy.html).
10597

106-
# Building locally
98+
## Building locally
99+
107100
In order to build a package locally run below commands.
108101

109102
```bash
110103
gem build jgd.gemspec
111104
gem install jgd-<version>.gem
112-
```
105+
```

0 commit comments

Comments
 (0)