[docs] info about the help command usage

This commit is contained in:
Frank Taillandier 2016-11-09 22:42:14 +01:00
parent 74a5297c19
commit 47e400549a
2 changed files with 9 additions and 0 deletions

View File

@ -25,4 +25,6 @@ advantage of all the awesome configuration options Jekyll makes available.
If you're running into problems, ensure you have all the [requirements
installed][Installation].
When in doubt, use the <code>help</code> command to remind you of all available options and usage, it also works with the <code>new</code>, <code>build</code> and <code>serve</code> subcommands, e.g. <code>jekyll help new</code> or <code>jekyll help build</code>.
[Installation]: /docs/installation/

View File

@ -97,5 +97,12 @@ $ jekyll build --source _source --destination _deploy
For more about the possible configuration options, see the
[configuration](../configuration/) page.
<div class="note info">
<h5>Call for help</h5>
<p>
The <code>help</code> command is always here to remind you of all available options and usage, and also works with the <code>build</code>, <code>serve</code> and <code>new</code> subcommands, e.g <code>jekyll help new</code> or <code>jekyll help build</code>.
</p>
</div>
If you're interested in browsing these docs on-the-go, install the
`jekyll-docs` gem and run `jekyll docs` in your terminal.