From 52085d2e34d2f5a7b6797462def6370726de357c Mon Sep 17 00:00:00 2001 From: Jesse Pinho Date: Wed, 24 Dec 2014 16:14:08 -0600 Subject: [PATCH 1/4] Fix a few punctuation errors --- site/_docs/pages.md | 2 +- site/_docs/plugins.md | 8 ++++---- site/_docs/templates.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/site/_docs/pages.md b/site/_docs/pages.md index e7b837fa..ea59649e 100644 --- a/site/_docs/pages.md +++ b/site/_docs/pages.md @@ -60,7 +60,7 @@ and associated URLs might look like: ### Named folders containing index HTML files -There is nothing wrong with the above method, however some people like to keep +There is nothing wrong with the above method. However, some people like to keep their URLs free from things like filename extensions. To achieve clean URLs for pages using Jekyll, you simply need to create a folder for each top-level page you want, and then place an `index.html` file in each page’s folder. This way diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index bd4396b3..9b68e17b 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -13,8 +13,8 @@ having to modify the Jekyll source itself.
Plugins on GitHub Pages

- GitHub Pages is powered by Jekyll, - however all Pages sites are generated using the --safe option + GitHub Pages is powered by Jekyll. + However, all Pages sites are generated using the --safe option to disable custom plugins for security reasons. Unfortunately, this means your plugins won’t work if you’re deploying to GitHub Pages.

You can still use GitHub Pages to publish your site, but you’ll need to @@ -68,8 +68,8 @@ A generator is a subclass of `Jekyll::Generator` that defines a `generate` method, which receives an instance of [`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). -Generation is triggered for its side-effects, the return value of `generate` is -ignored. Jekyll does not assume any particular side-effect to happen, it just +Because generation is triggered for its side effects, the return value of `generate` is +ignored. Jekyll does not assume any particular side effect to happen---it just runs the method. Generators run after Jekyll has made an inventory of the existing content, and diff --git a/site/_docs/templates.md b/site/_docs/templates.md index 2cd7461d..c0825702 100644 --- a/site/_docs/templates.md +++ b/site/_docs/templates.md @@ -303,7 +303,7 @@ You can also choose to include file fragments relative to the current file: You won't need to place your included content within the `_includes` directory. Instead, the inclusion is specifically relative to the file where the tag is being used. For example, if `_posts/2014-09-03-my-file.markdown` uses the `include_relative` tag, the included file -must be within the `_posts` directory, or one of it's subdirectories. You cannot include +must be within the `_posts` directory, or one of its subdirectories. You cannot include files in other locations. All the other capabilities of the `include` tag are available to the `include_relative` tag, From 4070143d5b06965a764fc655c7787013c80d040b Mon Sep 17 00:00:00 2001 From: Jesse Pinho Date: Thu, 25 Dec 2014 15:17:21 -0600 Subject: [PATCH 2/4] Tweak sentence structure --- site/_docs/plugins.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index 9b68e17b..605cbf68 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -68,9 +68,9 @@ A generator is a subclass of `Jekyll::Generator` that defines a `generate` method, which receives an instance of [`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). -Because generation is triggered for its side effects, the return value of `generate` is -ignored. Jekyll does not assume any particular side effect to happen---it just -runs the method. +The return value of `generate` is ignored, since generation is triggered for +its side effects. Jekyll does not expect any particular side effect to +happen---it just runs the method. Generators run after Jekyll has made an inventory of the existing content, and before the site is generated. Pages with YAML Front Matters are stored as From b1a517ccb65833ff9250b3ae9fa13794c86f9951 Mon Sep 17 00:00:00 2001 From: Jesse Pinho Date: Thu, 25 Dec 2014 18:29:50 -0600 Subject: [PATCH 3/4] Remove unnecessary 'where' --- site/_docs/pagination.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/_docs/pagination.md b/site/_docs/pagination.md index 3bb7d139..245ba36f 100644 --- a/site/_docs/pagination.md +++ b/site/_docs/pagination.md @@ -32,7 +32,7 @@ paginate: 5 The number should be the maximum number of Posts you’d like to be displayed per- page in the generated site. -You may also specify where the destination of the pagination pages: +You may also specify the destination of the pagination pages: {% highlight yaml %} paginate_path: "blog/page:num/" From 07bd3a3759d8f5b6a4854239cff347b5b23c581f Mon Sep 17 00:00:00 2001 From: Jesse Pinho Date: Thu, 1 Jan 2015 23:58:27 -0600 Subject: [PATCH 4/4] Clarify paragraph on the return value of `generate` --- site/_docs/plugins.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index 605cbf68..b5cf9543 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -66,11 +66,8 @@ based on your own rules. A generator is a subclass of `Jekyll::Generator` that defines a `generate` method, which receives an instance of -[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). - -The return value of `generate` is ignored, since generation is triggered for -its side effects. Jekyll does not expect any particular side effect to -happen---it just runs the method. +[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). The +return value of `generate` is ignored. Generators run after Jekyll has made an inventory of the existing content, and before the site is generated. Pages with YAML Front Matters are stored as