From c2dc80b95e6d4cb2f7f9f3adc07e8035f83d9711 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sat, 13 Apr 2013 14:03:16 -0400 Subject: [PATCH] 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 --- site/_includes/docs_contents.html | 3 +++ site/_posts/2012-07-01-resources.md | 1 + site/_posts/2012-07-01-upgrading.md | 37 +++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 site/_posts/2012-07-01-upgrading.md diff --git a/site/_includes/docs_contents.html b/site/_includes/docs_contents.html index 7e7637f3..3360f62c 100644 --- a/site/_includes/docs_contents.html +++ b/site/_includes/docs_contents.html @@ -77,6 +77,9 @@
  • Resources
  • +
  • + Upgrading +
  • diff --git a/site/_posts/2012-07-01-resources.md b/site/_posts/2012-07-01-resources.md index c14c584c..c319df2d 100644 --- a/site/_posts/2012-07-01-resources.md +++ b/site/_posts/2012-07-01-resources.md @@ -2,6 +2,7 @@ layout: docs title: Resources 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. diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md new file mode 100644 index 00000000..51a415d6 --- /dev/null +++ b/site/_posts/2012-07-01-upgrading.md @@ -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. + +
    +
    The `--config` flag overrides your `_config.yml` file
    +

    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.

    +
    + +#### 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 \ No newline at end of file