From c2dc80b95e6d4cb2f7f9f3adc07e8035f83d9711 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sat, 13 Apr 2013 14:03:16 -0400 Subject: [PATCH 01/26] 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 From 652b548ca50c8e86333de958272b7583c235a757 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 12:59:09 -0400 Subject: [PATCH 02/26] Hard line wrap FTW! --- site/_posts/2012-07-01-upgrading.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 51a415d6..cb77419a 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -8,15 +8,25 @@ 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. +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. +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.

    +

    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: From c038ea6cc283b5255a025d610524382558a6371a Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:00:59 -0400 Subject: [PATCH 03/26] s/problematically/programmatically/, props @mojombo --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index cb77419a..631ab5e9 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -16,7 +16,7 @@ automatically rebuild each time a file changes, just add the `--watch` flag. 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. +environments, or lets you programmatically override user-specified defaults. Simply add the `--config` flag, followed by the path to one or more config files. From ff88254ccbd536e686f34945a6023ffad718f963 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:03:06 -0400 Subject: [PATCH 04/26] De-deprecate `--safe`, props @mojombo --- site/_posts/2012-07-01-upgrading.md | 1 - 1 file changed, 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 631ab5e9..dc1a30b2 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -36,7 +36,6 @@ files. * `--auto` * `--server` * `--url=` -* `--safe` * `--maruku`, `--rdiscount`, and `--redcarpet` * `--pygments` * `--permalink=` From 37f332d58e0563c3fbccc6c32d1ebf009c2f3e7d Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:06:55 -0400 Subject: [PATCH 05/26] Note that `--auto` is not `--watch` --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index dc1a30b2..560e2399 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -33,7 +33,7 @@ files. * `--no-server` * `--no-auto` -* `--auto` +* `--auto` (now `--watch`) * `--server` * `--url=` * `--maruku`, `--rdiscount`, and `--redcarpet` From f4c61e59a60ad28552b021ce23f02a6879df3972 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:11:37 -0400 Subject: [PATCH 06/26] clean up language a bit to clarify meaning --- site/_posts/2012-07-01-upgrading.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 560e2399..26af5927 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -9,27 +9,29 @@ 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. +Whereas before you might simply run the command `jekyll` to generate a site +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 +rebuild each time a file changes, just add the `--watch` flag at the end. ### 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 programmatically override user-specified defaults. -Simply add the `--config` flag, followed by the path to one or more config -files. +Simply add the `--config` flag to the `jekyll` command, 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.

    + file via the command line. Simply pass the path to both files with the latter + file overriding the former.

    -#### As a result, the following command line flags are deprecated: +#### As a result, the following command line flags are now deprecated: * `--no-server` * `--no-auto` From 87d3ddc1d91c3ffc0ef16eafc2dda2d513ae63f5 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:18:03 -0400 Subject: [PATCH 07/26] Add draft functionality explanation to upgrading docs --- site/_posts/2012-07-01-upgrading.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 26af5927..bcb20204 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -45,4 +45,19 @@ to one or more config files. ### Draft posts +Jekyll now lets you write draft posts, and allows you to easily preview how +they will look prior to publishing. To start a draft, simply create a folder +called `_drafts` in your site's root (e.g., along side `_posts`), and add a +new markdown file to it. To generate preview your new post, simply run the +`Jekyll` command with the `--drafts` flag. + +
    +
    Drafts don't have dates
    +

    Unlike posts, drafts don't have a date, since they havn't + been published yet. Rather than naming your draft something like + `2013-07-01-my-draft-post.md`, simply name the file what you'd like your + post to eventually be titled, here `my-draft-post.md`.

    +
    + + ### Baseurl \ No newline at end of file From 30859cd979c38d329d46bf6a44f71d79fe07bdb6 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:27:14 -0400 Subject: [PATCH 08/26] First pass at baseurl documentation --- site/_posts/2012-07-01-upgrading.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index bcb20204..99daafb6 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -53,11 +53,16 @@ new markdown file to it. To generate preview your new post, simply run the
    Drafts don't have dates
    -

    Unlike posts, drafts don't have a date, since they havn't +

    Unlike posts, drafts don't have a date, since they haven't been published yet. Rather than naming your draft something like `2013-07-01-my-draft-post.md`, simply name the file what you'd like your post to eventually be titled, here `my-draft-post.md`.

    +### Baseurl -### Baseurl \ No newline at end of file +Often, you'll want the ability to run a Jekyll site in multiple places, such as +previewing locally before pushing to a server. Jekyll 1.0 makes that easier with +the new `--baseurl` flag. Throughout your Jekyll site, simply prefix relative +url with `{{ site.baseurl }}` and Jekyll will swap in whatever you pass along +ensuring your links remain true in both environments. From 6133252f064da1ee9a267d020f23707decc46a8b Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:30:14 -0400 Subject: [PATCH 09/26] s/root/source/, props @parkr --- site/_posts/2012-07-01-upgrading.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 99daafb6..99360a7e 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -47,9 +47,9 @@ to one or more config files. Jekyll now lets you write draft posts, and allows you to easily preview how they will look prior to publishing. To start a draft, simply create a folder -called `_drafts` in your site's root (e.g., along side `_posts`), and add a -new markdown file to it. To generate preview your new post, simply run the -`Jekyll` command with the `--drafts` flag. +called `_drafts` in your site's source directory (e.g., along side `_posts`), +and add a new markdown file to it. To generate preview your new post, simply +run the `Jekyll` command with the `--drafts` flag.
    Drafts don't have dates
    From 38e7d618583f52c2175c87a78bb4bcfc70899710 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:31:17 -0400 Subject: [PATCH 10/26] fix typo in draft post explanation, props @parkr --- site/_posts/2012-07-01-upgrading.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 99360a7e..66c96dc0 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -48,8 +48,8 @@ to one or more config files. Jekyll now lets you write draft posts, and allows you to easily preview how they will look prior to publishing. To start a draft, simply create a folder called `_drafts` in your site's source directory (e.g., along side `_posts`), -and add a new markdown file to it. To generate preview your new post, simply -run the `Jekyll` command with the `--drafts` flag. +and add a new markdown file to it. To preview your new post, simply run the +`Jekyll` command with the `--drafts` flag.
    Drafts don't have dates
    From 47e9c978bfe53c91e58bc2a35925a02b257ea62b Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Sun, 14 Apr 2013 13:35:24 -0400 Subject: [PATCH 11/26] Direct users to the proper command when previewing drafts. --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 66c96dc0..34c67f45 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -49,7 +49,7 @@ Jekyll now lets you write draft posts, and allows you to easily preview how they will look prior to publishing. To start a draft, simply create a folder called `_drafts` in your site's source directory (e.g., along side `_posts`), and add a new markdown file to it. To preview your new post, simply run the -`Jekyll` command with the `--drafts` flag. +`Jekyll serve` command with the `--drafts` flag.
    Drafts don't have dates
    From f8e816035878fa6bb62f56e81556dc6083b4f29d Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 11:56:46 -0400 Subject: [PATCH 12/26] clarify baseurl usage --- site/_posts/2012-07-01-upgrading.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 34c67f45..6f6e4bca 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -62,7 +62,9 @@ and add a new markdown file to it. To preview your new post, simply run the ### Baseurl Often, you'll want the ability to run a Jekyll site in multiple places, such as -previewing locally before pushing to a server. Jekyll 1.0 makes that easier with -the new `--baseurl` flag. Throughout your Jekyll site, simply prefix relative -url with `{{ site.baseurl }}` and Jekyll will swap in whatever you pass along -ensuring your links remain true in both environments. +previewing locally before pushing to GitHub pages. Jekyll 1.0 makes that easier +with the new `--baseurl` flag. Throughout your Jekyll site, simply prefix +relative urls with `{{ site.baseurl }}` and add the production `baseurl` to +your `_config.yml` file. When previewing locally, Jekyll will swap in whatever +you pass along via the `--baseurl` flag (most likely `/`), ensuring your links +remain true in both environments. \ No newline at end of file From 532adddbb8ece0b64e2dea3030040426d848e858 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 12:02:06 -0400 Subject: [PATCH 13/26] quick shout out to jekyll new --- site/_posts/2012-07-01-upgrading.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 6f6e4bca..f4992a92 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -14,6 +14,11 @@ 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 rebuild each time a file changes, just add the `--watch` flag at the end. +
    +
    Diving in
    +

    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.

    +
    + ### Custom Config File Rather than passing individual flags via the command line, you can now pass an From db76121d89670108b27b2bcc958ff7f84203a2c8 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 12:56:33 -0400 Subject: [PATCH 14/26] Make --config usage more explicit. See https://github.com/mojombo/jekyll/pull/965#discussion_r3797116 and https://github.com/mojombo/jekyll/pull/965#discussion_r3797085 Props @parkr. --- site/_posts/2012-07-01-upgrading.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index f4992a92..7bd04397 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -28,12 +28,14 @@ Simply add the `--config` flag to the `jekyll` command, followed by the path to one or more config files.
    -
    The `--config` flag overrides your `_config.yml` file
    +
    The `--config` explicitly specifies your configuration 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 path to both files with the latter - file overriding the former.

    + 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. ,

    #### As a result, the following command line flags are now deprecated: From 55368898f5df52238590f3b91fbefebfae9bf114 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 13:33:53 -0400 Subject: [PATCH 15/26] Clarify new way to do server and auto, props @parkr see https://github.com/mojombo/jekyll/pull/965#issuecomment-16396829 --- site/_posts/2012-07-01-upgrading.md | 38 ++++++++++++++++++----------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 7bd04397..6e29fa9e 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -6,6 +6,12 @@ prev_section: resources Upgrading from an older version of Jekyll? A few things have changed in 1.0. + +
    +
    Diving in
    +

    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.

    +
    + ### The Jekyll Command 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 rebuild each time a file changes, just add the `--watch` flag at the end. -
    -
    Diving in
    -

    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.

    +
    +
    Watching and Serving
    +

    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`.

    ### 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 to one or more config files. -
    -
    The `--config` explicitly specifies your configuration 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. 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. ,

    -
    - #### As a result, the following command line flags are now deprecated: * `--no-server` @@ -50,6 +49,17 @@ to one or more config files. * `--permalink=` * `--paginate` +
    +
    The `--config` explicitly specifies your configuration 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. 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. ,

    +
    + ### Draft posts Jekyll now lets you write draft posts, and allows you to easily preview how From 91bcb83c8a042c3488b70bab26dc4be31955121e Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 13:34:38 -0400 Subject: [PATCH 16/26] plurlize file(s) --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 6e29fa9e..db430439 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -50,7 +50,7 @@ to one or more config files. * `--paginate`
    -
    The `--config` explicitly specifies your configuration file
    +
    The `--config` explicitly specifies your configuration file(s)

    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 From 343d56dfe3b195cf6c7e84f46eb9178a56357ead Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:09:02 -0400 Subject: [PATCH 17/26] hard wrap *all* the things! --- site/_posts/2012-07-01-upgrading.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index db430439..4d417ece 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -9,7 +9,9 @@ Upgrading from an older version of Jekyll? A few things have changed in 1.0.

    Diving in
    -

    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.

    +

    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.

    ### The Jekyll Command @@ -83,5 +85,5 @@ previewing locally before pushing to GitHub pages. Jekyll 1.0 makes that easier with the new `--baseurl` flag. Throughout your Jekyll site, simply prefix relative urls with `{{ site.baseurl }}` and add the production `baseurl` to your `_config.yml` file. When previewing locally, Jekyll will swap in whatever -you pass along via the `--baseurl` flag (most likely `/`), ensuring your links -remain true in both environments. \ No newline at end of file +you pass along via the `--baseurl` flag (most likely `/`), ensuring your +links remain true in both environments. \ No newline at end of file From 783d59045bee176caa005e37134b26013ddd5a40 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:09:24 -0400 Subject: [PATCH 18/26] remove stray comma --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 4d417ece..f94a631f 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -59,7 +59,7 @@ to one or more config files. 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. ,

    + those on the left (`_config.yml`) when both contain the same key.

    ### Draft posts From 380e7a97442ca5fe005e23d3ce54eee45d172c8c Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:10:19 -0400 Subject: [PATCH 19/26] s/--server/serve --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index f94a631f..6752627c 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -18,7 +18,7 @@ Upgrading from an older version of Jekyll? A few things have changed in 1.0. For better clarity, Jekyll now accepts the commands `build` and `serve`. Whereas before you might simply run the command `jekyll` to generate a site -and `jekyll --serve` to view it locally, now use the subcommands `jekyll build` +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 rebuild each time a file changes, just add the `--watch` flag at the end. From 075e14aaadb9ba85d90891806ce52c219d5fd2fe Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:12:13 -0400 Subject: [PATCH 20/26] moar hard word wrapping --- site/_posts/2012-07-01-upgrading.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 6752627c..3cdfcb2c 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -18,7 +18,7 @@ Upgrading from an older version of Jekyll? A few things have changed in 1.0. For better clarity, Jekyll now accepts the commands `build` and `serve`. Whereas before you might simply run the command `jekyll` to generate a site -and `jekyll serve` to view it locally, now use the subcommands `jekyll build` +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 rebuild each time a file changes, just add the `--watch` flag at the end. @@ -81,9 +81,9 @@ and add a new markdown file to it. To preview your new post, simply run the ### Baseurl 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 easier -with the new `--baseurl` flag. Throughout your Jekyll site, simply prefix -relative urls with `{{ site.baseurl }}` and add the production `baseurl` to -your `_config.yml` file. When previewing locally, Jekyll will swap in whatever -you pass along via the `--baseurl` flag (most likely `/`), ensuring your -links remain true in both environments. \ No newline at end of file +previewing locally before pushing to GitHub pages. Jekyll 1.0 makes that +easier with the new `--baseurl` flag. Throughout your Jekyll site, simply +prefix relative urls with `{{ site.baseurl }}` and add the production `baseurl` +to your `_config.yml` file. When previewing locally, Jekyll will swap in +whatever you pass along via the `--baseurl` flag (most likely `/`), ensuring +your links remain true in both environments. \ No newline at end of file From 6b624fb6994bd87e25a27ce436378faad173c12f Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:12:54 -0400 Subject: [PATCH 21/26] upper case P dangit --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 3cdfcb2c..3399e24d 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -81,7 +81,7 @@ and add a new markdown file to it. To preview your new post, simply run the ### Baseurl 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. Throughout your Jekyll site, simply prefix relative urls with `{{ site.baseurl }}` and add the production `baseurl` to your `_config.yml` file. When previewing locally, Jekyll will swap in From 7a0b6da5ed137e24c8574ee4e1a26b7916f5fff6 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:13:22 -0400 Subject: [PATCH 22/26] s/along side/alongside/ h/t @mattr --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 3399e24d..3199a02e 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -66,7 +66,7 @@ to one or more config files. Jekyll now lets you write draft posts, and allows you to easily preview how they will look prior to publishing. To start a draft, simply create a folder -called `_drafts` in your site's source directory (e.g., along side `_posts`), +called `_drafts` in your site's source directory (e.g., alongside `_posts`), and add a new markdown file to it. To preview your new post, simply run the `Jekyll serve` command with the `--drafts` flag. From 766ef9e3da7cab6b6610a67d3d7ba4aeef3bbd21 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:13:46 -0400 Subject: [PATCH 23/26] s/mardown/markdown, props @mattr --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 3199a02e..a005420d 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -71,7 +71,7 @@ and add a new markdown file to it. To preview your new post, simply run the `Jekyll serve` command with the `--drafts` flag.
    -
    Drafts don't have dates
    +
    Drafts don't have dates

    Unlike posts, drafts don't have a date, since they haven't been published yet. Rather than naming your draft something like `2013-07-01-my-draft-post.md`, simply name the file what you'd like your From 4063e47fb98fa81def975ded7e9f1bb563625203 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:15:38 -0400 Subject: [PATCH 24/26] s/--server/serve/ part deux --- site/_posts/2012-07-01-upgrading.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index a005420d..0d18562d 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -18,7 +18,7 @@ Upgrading from an older version of Jekyll? A few things have changed in 1.0. For better clarity, Jekyll now accepts the commands `build` and `serve`. Whereas before you might simply run the command `jekyll` to generate a site -and `jekyll --serve` to view it locally, now use the subcommands `jekyll build` +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 rebuild each time a file changes, just add the `--watch` flag at the end. From db31c1a4534bcd2b4dfa787b7734bc540e6f2c72 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:16:27 -0400 Subject: [PATCH 25/26] s/mardown/markdown/ part deux --- site/_posts/2012-07-01-upgrading.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index 0d18562d..e9700b35 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -8,7 +8,7 @@ Upgrading from an older version of Jekyll? A few things have changed in 1.0.

    -
    Diving in
    +
    Diving in

    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.

    @@ -23,7 +23,7 @@ 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.
    -
    Watching and Serving
    +
    Watching and Serving

    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 @@ -52,7 +52,7 @@ to one or more config files. * `--paginate`

    -
    The `--config` explicitly specifies your configuration file(s)
    +
    The `--config` explicitly specifies your configuration file(s)

    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 From 3bf38ad0d3e6ef7b5259a2b7a7f59611646e26a2 Mon Sep 17 00:00:00 2001 From: "Benjamin J. Balter" Date: Mon, 15 Apr 2013 16:25:40 -0400 Subject: [PATCH 26/26] significant rewrite of baseurl section for clarity, props mattr- --- site/_posts/2012-07-01-upgrading.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/site/_posts/2012-07-01-upgrading.md b/site/_posts/2012-07-01-upgrading.md index e9700b35..33c03a0c 100644 --- a/site/_posts/2012-07-01-upgrading.md +++ b/site/_posts/2012-07-01-upgrading.md @@ -82,8 +82,10 @@ and add a new markdown file to it. To preview your new post, simply run the 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 -easier with the new `--baseurl` flag. Throughout your Jekyll site, simply -prefix relative urls with `{{ site.baseurl }}` and add the production `baseurl` -to your `_config.yml` file. When previewing locally, Jekyll will swap in -whatever you pass along via the `--baseurl` flag (most likely `/`), ensuring -your links remain true in both environments. \ No newline at end of file +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, +throughout the site, simply prefix relative URLs with `{{ site.baseurl }}`. +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 +swap in whatever you've passed along, ensuring all your links work as you'd +expect in both environments.