dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Ease discovery of CLI commands (in their entirety) (#8178) 

Merge pull request 8178
This commit is contained in:
dotnetCarpenter 2020-05-14 15:38:08 +02:00 committed by GitHub
parent 7baca87e59
commit 58a73a53d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/_docs/usage.md
View File

@ -5,17 +5,29 @@ permalink: /docs/usage/
The Jekyll gem makes a `jekyll` executable available to you in your terminal. The Jekyll gem makes a `jekyll` executable available to you in your terminal.
You can use this command in a number of ways: The `jekyll` program has several commands but the structure is always:
* `jekyll new PATH` - Creates a new Jekyll site with default gem-based theme at specified path. The directories will be created as necessary. ```
* `jekyll new PATH --blank` - Creates a new blank Jekyll site scaffold at specified path. jekyll command [argument] [option] [argument_to_option]
* `jekyll build` or `jekyll b` - Performs a one off build your site to `./_site` (by default)
* `jekyll serve` or `jekyll s` - Builds your site any time a source file changes and serves it locally Examples:
* `jekyll doctor` - Outputs any deprecation or configuration issues jekyll new site/ --blank
* `jekyll clean` - Removes all generated files: destination folder, metadata file, Sass and Jekyll caches. jekyll serve --config _alternative_config.yml
* `jekyll help` - Shows help, optionally for a given subcommand, e.g. `jekyll help build` ```
* `jekyll new-theme` - Creates a new Jekyll theme scaffold
Typically you'll use `jekyll serve` while developing locally and `jekyll build` when you need to generate the site for production. Typically you'll use `jekyll serve` while developing locally and `jekyll build` when you need to generate the site for production.
For a full list of options and their argument, see [Build Command Options](/docs/configuration/options/#build-command-options).
Here is some of the most common commands:
* `jekyll new PATH` - Creates a new Jekyll site with default gem-based theme at specified path. The directories will be created as necessary.
* `jekyll new PATH --blank` - Creates a new blank Jekyll site scaffold at specified path.
* `jekyll build` or `jekyll b` - Performs a one off build your site to `./_site` (by default).
* `jekyll serve` or `jekyll s` - Builds your site any time a source file changes and serves it locally.
* `jekyll clean` - Removes all generated files: destination folder, metadata file, Sass and Jekyll caches.
* `jekyll help` - Shows help, optionally for a given subcommand, e.g. `jekyll help build`.
* `jekyll new-theme` - Creates a new Jekyll theme scaffold.
* `jekyll doctor` - Outputs any deprecation or configuration issues.
To change Jekyll's default build behavior have a look through the [configuration options](/docs/configuration/). To change Jekyll's default build behavior have a look through the [configuration options](/docs/configuration/).