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

Add further fixes to upgrade doc. #3607

This commit is contained in:
Parker Moore 2015-04-10 16:56:55 -04:00
parent d10c46d4fd
commit 20d48fcfe9
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
site/_docs/upgrading.md
View File

@ -24,9 +24,9 @@ $ 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 and `jekyll --server` to view it locally, in v2.0 (and later) you should
the subcommands `jekyll build` use the subcommands `jekyll build` and `jekyll serve` to build and preview
and `jekyll serve` to build and preview your site. your site.
<div class="note info"> <div class="note info">
<h5>Watching and Serving</h5> <h5>Watching and Serving</h5>
@ -41,11 +41,11 @@ and `jekyll serve` to build and preview your site.
In Jekyll v1.0, we introduced absolute permalinks for pages in In Jekyll v1.0, we introduced absolute permalinks for pages in
subdirectories. Starting with v2.0, absolute permalinks are opt-out, 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
instead of relative permalinks. relative permalinks.
* To use absolute permalinks, set `relative_permalinks: false` in * To use absolute permalinks, set `relative_permalinks: false` in your
your configuration file. configuration file.
* To continue using relative permalinks, set `relative_permalinks: true` in * To continue using relative permalinks, set `relative_permalinks: true` in
your configuration file. your configuration file.
@ -77,17 +77,17 @@ and add a new markdown file to it. To preview your new post, simply run the
### Custom Config File ### Custom Config File
Rather than passing individual flags via the command line, you can now pass an Rather than passing individual flags via the command line, you can now pass
entire custom Jekyll config file. This helps to distinguish between an entire custom Jekyll config file. This helps to distinguish between
environments, or lets you programmatically override user-specified defaults. environments, or lets you programmatically override user-specified
Simply add the `--config` flag to the `jekyll` command, followed by the path defaults. Simply add the `--config` flag to the `jekyll` command, followed
to one or more config files (comma-delimited, no spaces). by the path to one or more config files (comma-delimited, no spaces).
#### 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`
* `--no-auto` * `--no-auto` (now `--no-watch`)
* `--auto` (now `--watch` and `--no-watch`, defaults to `--watch`) * `--auto` (now `--watch`)
* `--server` * `--server`
* `--url=` * `--url=`
* `--maruku`, `--rdiscount`, and `--redcarpet` * `--maruku`, `--rdiscount`, and `--redcarpet`
@ -108,9 +108,9 @@ 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,
should check to see if any of these are present in your pre-1.0 config file, you should check to see if any of these are present in your pre-1.0 config
and if so, make sure that you're using them properly: file, and if so, make sure that you're using them properly:
* `excerpt_separator` * `excerpt_separator`
* `host` * `host`
@ -123,16 +123,16 @@ and if so, make sure that you're using them properly:
### Baseurl ### Baseurl
Often, you'll want the ability to run a Jekyll site in multiple places, such as Often, you'll want the ability to run a Jekyll site in multiple places,
previewing locally before pushing to GitHub Pages. Jekyll 1.0 makes that such as previewing locally before pushing to GitHub Pages. Jekyll 1.0 makes
easier with the new `--baseurl` flag. To take advantage of this feature, first that easier with the new `--baseurl` flag. To take advantage of this
add the production `baseurl` to your site's `_config.yml` file. Then, feature, first add the production `baseurl` to your site's `_config.yml`
throughout the site, simply prefix relative URLs file. Then, throughout the site, simply prefix relative URLs
with `{% raw %}{{ site.baseurl }}{% endraw %}`. 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`
with your local baseurl (most likely `/`) to `jekyll serve` and Jekyll will flag with your local baseurl (most likely `/`) to `jekyll serve` and Jekyll
swap in whatever you've passed along, ensuring all your links work as you'd will swap in whatever you've passed along, ensuring all your links work as
expect in both environments. you'd expect in both environments.
<div class="note warning"> <div class="note warning">