From 47e400549a7af16c953f2f158c68ec5b1f012d3a Mon Sep 17 00:00:00 2001 From: Frank Taillandier Date: Wed, 9 Nov 2016 22:42:14 +0100 Subject: [PATCH] [docs] info about the help command usage --- docs/_docs/quickstart.md | 2 ++ docs/_docs/usage.md | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/docs/_docs/quickstart.md b/docs/_docs/quickstart.md index 969b5384..2d341cc0 100644 --- a/docs/_docs/quickstart.md +++ b/docs/_docs/quickstart.md @@ -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 help command to remind you of all available options and usage, it also works with the new, build and serve subcommands, e.g. jekyll help new or jekyll help build. + [Installation]: /docs/installation/ diff --git a/docs/_docs/usage.md b/docs/_docs/usage.md index 3d2413d4..9f91d437 100644 --- a/docs/_docs/usage.md +++ b/docs/_docs/usage.md @@ -97,5 +97,12 @@ $ jekyll build --source _source --destination _deploy For more about the possible configuration options, see the [configuration](../configuration/) page. +
+
Call for help
+

+ The help command is always here to remind you of all available options and usage, and also works with the build, serve and new subcommands, e.g jekyll help new or jekyll help build. +

+
+ If you're interested in browsing these docs on-the-go, install the `jekyll-docs` gem and run `jekyll docs` in your terminal.