Clarify new way to do server and auto, props @parkr

see https://github.com/mojombo/jekyll/pull/965#issuecomment-16396829
This commit is contained in:
Benjamin J. Balter 2013-04-15 13:33:53 -04:00
parent db76121d89
commit 55368898f5
1 changed files with 24 additions and 14 deletions

View File

@ -6,6 +6,12 @@ prev_section: resources
Upgrading from an older version of Jekyll? A few things have changed in 1.0. Upgrading from an older version of Jekyll? A few things have changed in 1.0.
<div class="note feature">
<h5 mardown="1">Diving in</h5>
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply run `jekyll new [sitename]`, to create a new folder with a bare bones Jekyll site.</p>
</div>
### The Jekyll Command ### The Jekyll Command
For better clarity, Jekyll now accepts the commands `build` and `serve`. For better clarity, Jekyll now accepts the commands `build` and `serve`.
@ -14,9 +20,13 @@ and `jekyll --serve` to view it locally, now use the subcommands `jekyll build`
and `jekyll serve` to do the same. And if you want Jekyll to automatically and `jekyll serve` to do the same. And if you want Jekyll to automatically
rebuild each time a file changes, just add the `--watch` flag at the end. rebuild each time a file changes, just add the `--watch` flag at the end.
<div class="note feature"> <div class="note info">
<h5 mardown="1">Diving in</h5> <h5 mardown="1">Watching and Serving</h5>
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply run `jekyll new [sitename]`, to create a new folder with a bare bones Jekyll site.</p> <p markdown="1">With the new subcommands, the way sites are previewed locally
changed a bit. Instead of specifying `server: true` in the site's
`_config.yml` file, use `jekyll serve`. The same hold's true for
`watch: true`. Instead, use the `--watch` flag with either `jekyll serve`
or `jekyll build`.</p>
</div> </div>
### Custom Config File ### Custom Config File
@ -27,17 +37,6 @@ environments, or lets you programmatically override user-specified defaults.
Simply add the `--config` flag to the `jekyll` command, followed by the path Simply add the `--config` flag to the `jekyll` command, followed by the path
to one or more config files. to one or more config files.
<div class="note info">
<h5 mardown="1">The `--config` explicitly specifies your configuration file</h5>
<p markdown="1">If you use the `--config` flag, Jekyll will ignore your
`_config.yml` file. Want to merge a custom configuration with the normal
configuration? No problem. Jekyll will accept more than one custom config
file via the command line. Config files cascade from right to left, such
that if I run `jekyll serve --config `--config _config.yml,_config-dev.yml`,
the values in the config files on the right (`_config-dev.yml`) overwrite
those on the left (`_config.yml`) when both contain the same key. , </p>
</div>
#### As a result, the following command line flags are now deprecated: #### As a result, the following command line flags are now deprecated:
* `--no-server` * `--no-server`
@ -50,6 +49,17 @@ to one or more config files.
* `--permalink=` * `--permalink=`
* `--paginate` * `--paginate`
<div class="note info">
<h5 mardown="1">The `--config` explicitly specifies your configuration file</h5>
<p markdown="1">If you use the `--config` flag, Jekyll will ignore your
`_config.yml` file. Want to merge a custom configuration with the normal
configuration? No problem. Jekyll will accept more than one custom config
file via the command line. Config files cascade from right to left, such
that if I run `jekyll serve --config _config.yml,_config-dev.yml`,
the values in the config files on the right (`_config-dev.yml`) overwrite
those on the left (`_config.yml`) when both contain the same key. , </p>
</div>
### Draft posts ### Draft posts
Jekyll now lets you write draft posts, and allows you to easily preview how Jekyll now lets you write draft posts, and allows you to easily preview how