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

Fix a typo, wrap lines

This commit is contained in:
chrisfinazzo 2015-03-22 15:22:27 -04:00
parent db0e1a683c
commit f635f3d34b
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
site/_docs/upgrading.md
View File

@ -24,14 +24,15 @@ $ gem update jekyll
For better clarity, Jekyll now accepts the commands `build` and `serve`. For better clarity, Jekyll now accepts the commands `build` and `serve`.
Whereas before you might simply run the command `jekyll` to generate a site Whereas before you might simply run the command `jekyll` to generate a site
and `jekyll --server` to view it locally, in v2.0 (and later) you should use the subcommands `jekyll build` and `jekyll --server` to view it locally, in v2.0 (and later) you should use
the subcommands `jekyll build`
and `jekyll serve` to build and preview your site. and `jekyll serve` to build and preview your site.
<div class="note info"> <div class="note info">
<h5>Watching and Serving</h5> <h5>Watching and Serving</h5>
<p markdown="1">With the new subcommands, the way sites are previewed locally <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 changed a bit. Instead of specifying `server: true` in the site's
configuration file, use `jekyll serve`. The same hold's true for configuration file, use `jekyll serve`. The same holds true for
`watch: true`. Instead, use the `--watch` flag with either `jekyll serve` `watch: true`. Instead, use the `--watch` flag with either `jekyll serve`
or `jekyll build`.</p> or `jekyll build`.</p>
</div> </div>
@ -43,8 +44,10 @@ subdirectories. Starting with v2.0, absolute permalinks are opt-out,
meaning Jekyll will default to using absolute permalinks meaning Jekyll will default to using absolute permalinks
instead of relative permalinks. instead of relative permalinks.
* To use absolute permalinks, set `relative_permalinks: false` in your configuration file. * To use absolute permalinks, set `relative_permalinks: false` in
* To continue using relative permalinks, set `relative_permalinks: true` in your configuration file. your configuration file.
* To continue using relative permalinks, set `relative_permalinks: true` in
your configuration file.
<div class="note warning" id="absolute-permalinks-warning"> <div class="note warning" id="absolute-permalinks-warning">
<h5 markdown="1">Absolute permalinks will be default in v2.0 and on</h5> <h5 markdown="1">Absolute permalinks will be default in v2.0 and on</h5>
@ -84,7 +87,7 @@ to one or more config files (comma-delimited, no spaces).
* `--no-server` * `--no-server`
* `--no-auto` * `--no-auto`
* `--auto` (now `--watch`) * `--auto` (now `--watch` and `--no-watch`)
* `--server` * `--server`
* `--url=` * `--url=`
* `--maruku`, `--rdiscount`, and `--redcarpet` * `--maruku`, `--rdiscount`, and `--redcarpet`
@ -106,8 +109,8 @@ to one or more config files (comma-delimited, no spaces).
### New Config File Options ### New Config File Options
Jekyll 1.0 introduced several new config file options. Before you upgrade, you Jekyll 1.0 introduced several new config file options. Before you upgrade, you
should check to see if any of these are present in your pre-1.0 config file, and should check to see if any of these are present in your pre-1.0 config file,
if so, make sure that you're using them properly: and if so, make sure that you're using them properly:
* `excerpt_separator` * `excerpt_separator`
* `host` * `host`
@ -124,7 +127,8 @@ Often, you'll want the ability to run a Jekyll site in multiple places, such as
previewing locally before pushing to GitHub Pages. Jekyll 1.0 makes that previewing locally before pushing to GitHub Pages. Jekyll 1.0 makes that
easier with the new `--baseurl` flag. To take advantage of this feature, first easier with the new `--baseurl` flag. To take advantage of this feature, first
add the production `baseurl` to your site's `_config.yml` file. Then, add the production `baseurl` to your site's `_config.yml` file. Then,
throughout the site, simply prefix relative URLs with `{% raw %}{{ site.baseurl }}{% endraw %}`. throughout the site, simply prefix relative URLs
with `{% raw %}{{ site.baseurl }}{% endraw %}`.
When you're ready to preview your site locally, pass along the `--baseurl` flag When you're ready to preview your site locally, pass along the `--baseurl` flag
with your local baseurl (most likely `/`) to `jekyll serve` and Jekyll will with your local baseurl (most likely `/`) to `jekyll serve` and Jekyll will
swap in whatever you've passed along, ensuring all your links work as you'd swap in whatever you've passed along, ensuring all your links work as you'd