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

Add docs to help users upgrade from < 1.0, fixes #877 

* Help with new command line usage
* Help with deprecated flags
* Help with baseurl
* Help with drafts
This commit is contained in:
Benjamin J. Balter 2013-04-13 14:03:16 -04:00
parent dcad4b2867
commit c2dc80b95e
3 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
site/_includes/docs_contents.html
View File

@ -77,6 +77,9 @@
<li class="{% if page.title == "Resources" %}current{% endif %}"> <li class="{% if page.title == "Resources" %}current{% endif %}">
<a href="{{ site.url }}/docs/resources">Resources</a> <a href="{{ site.url }}/docs/resources">Resources</a>
</li> </li>
<li class="{% if page.title == "Upgrading" %}current{% endif %}">
<a href="{{ site.url }}/docs/upgrading">Upgrading</a>
</li>
</ul> </ul>
</aside> </aside>
</div> </div>

1
site/_posts/2012-07-01-resources.md
View File

@ -2,6 +2,7 @@
layout: docs layout: docs
title: Resources title: Resources
prev_section: sites prev_section: sites
next_section: upgrading
--- ---
Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources. Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.

37
site/_posts/2012-07-01-upgrading.md Normal file
View File

@ -0,0 +1,37 @@
---
layout: docs
title: Upgrading
prev_section: resources
---
Upgrading from an older version of Jekyll? A few things have changed in 1.0.
### The Jekyll Command
For better clarity, Jekyll now accepts the commands `build` and `serve`. Rather than just `jekyll` and `jekyll --serve`. If you want Jekyll to automatically rebuild each time a file changes, just add the `--watch` flag.
### Custom Config File
Rather than passing individual flags via the command line, you can now pass an entire custom Jekyll config file. This helps to distinguish between environments, or lets you problematically override user-specified defaults. Simply add the `--config` flag, followed by the path to one or more config files.
<div class="note info">
<h5 mardown="1">The `--config` flag overrides your `_config.yml` 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. Simply pass the URL to both files with the latter file overriding the first.</p>
</div>
#### As a result, the following command line flags are deprecated:
* `--no-server`
* `--no-auto`
* `--auto`
* `--server`
* `--url=`
* `--safe`
* `--maruku`, `--rdiscount`, and `--redcarpet`
* `--pygments`
* `--permalink=`
* `--paginate`
### Draft posts
### Baseurl