From cfb4a848b4aadc24ceb85bfde3187b78872d9dbb Mon Sep 17 00:00:00 2001 From: chrisfinazzo Date: Mon, 22 Feb 2016 22:17:02 -0500 Subject: [PATCH 1/3] Use HTTPS --- site/_docs/assets.md | 2 +- site/_docs/configuration.md | 4 ++-- site/_docs/continuous-integration.md | 2 +- site/_docs/contributing.md | 4 +++- site/_docs/deployment-methods.md | 14 +++++++++++--- site/_docs/extras.md | 6 +++--- site/_docs/frontmatter.md | 2 +- site/_docs/github-pages.md | 4 ++-- site/_docs/index.md | 4 ++-- site/_docs/installation.md | 6 +++--- site/_docs/migrations.md | 2 +- site/_docs/pages.md | 4 ++-- site/_docs/plugins.md | 4 ++-- site/_docs/posts.md | 8 ++++---- site/_docs/upgrading/2-to-3.md | 2 +- 15 files changed, 39 insertions(+), 29 deletions(-) diff --git a/site/_docs/assets.md b/site/_docs/assets.md index 10f094bd..db8847c1 100644 --- a/site/_docs/assets.md +++ b/site/_docs/assets.md @@ -26,7 +26,7 @@ will process it and put it in your site's destination folder under
Jekyll processes all Liquid filters and tags in asset files
-

If you are using Mustache +

If you are using Mustache or another JavaScript templating language that conflicts with the Liquid template syntax, you will need to place {% raw %} and diff --git a/site/_docs/configuration.md b/site/_docs/configuration.md index 57044184..72929f0a 100644 --- a/site/_docs/configuration.md +++ b/site/_docs/configuration.md @@ -106,9 +106,9 @@ class="flag">flags (specified on the command-line) that control them. Set the time zone for site generation. This sets the TZ environment variable, which Ruby uses to handle time and date creation and manipulation. Any entry from the - IANA Time Zone + IANA Time Zone Database is valid, e.g. America/New_York. A list of all - available values can be found + available values can be found here. The default is the local time zone, as set by your operating system.

diff --git a/site/_docs/continuous-integration.md b/site/_docs/continuous-integration.md index b98de42c..bfee8bda 100644 --- a/site/_docs/continuous-integration.md +++ b/site/_docs/continuous-integration.md @@ -80,7 +80,7 @@ with Ruby and requires RubyGems to install, we use the Ruby language build environment. Below is a sample `.travis.yml` file, followed by an explanation of each line. -**Note:** You will need a Gemfile as well, [Travis will automatically install](http://docs.travis-ci.com/user/languages/ruby/#Dependency-Management) the dependencies based on the referenced gems: +**Note:** You will need a Gemfile as well, [Travis will automatically install](https://docs.travis-ci.com/user/languages/ruby/#Dependency-Management) the dependencies based on the referenced gems: {% highlight ruby %} source "https://rubygems.org" diff --git a/site/_docs/contributing.md b/site/_docs/contributing.md index 224f52f8..5c5b1f13 100644 --- a/site/_docs/contributing.md +++ b/site/_docs/contributing.md @@ -27,9 +27,11 @@ following in mind: change is to review, the more likely it will be merged. * When submitting a pull request, please make judicious use of the pull request body. A description of what changes were made, the motivations behind the - changes and [any tasks completed or left to complete](http://git.io/gfm-tasks) + changes and [any tasks completed or left to complete][] will also speed up review time. +[any tasks completed or left to complete]: https://git.io/gfm-tasks +
Contributions will not be accepted without tests

diff --git a/site/_docs/deployment-methods.md b/site/_docs/deployment-methods.md index 7e77ce16..c5c4f750 100644 --- a/site/_docs/deployment-methods.md +++ b/site/_docs/deployment-methods.md @@ -25,7 +25,8 @@ There are also a number of ways to easily automate the deployment of a Jekyll si ### Git post-update hook -If you store your Jekyll site in [Git](http://git-scm.com/) (you are using version control, right?), it’s pretty easy to automate the +If you store your Jekyll site in [Git](https://git-scm.com/) (you are using +version control, right?), it’s pretty easy to automate the deployment process by setting up a post-update hook in your Git repository, [like this](http://web.archive.org/web/20091223025644/http://www.taknado.com/en/2009/03/26/deploying-a-jekyll-generated-site/). @@ -96,7 +97,14 @@ Another way to deploy your Jekyll site is to use [Rake](https://github.com/ruby/ ### scp -Once you’ve generated the `_site` directory, you can easily scp it using a `tasks/deploy` shell script similar to [this deploy script here](https://github.com/henrik/henrik.nyh.se/blob/master/script/deploy). You’d obviously need to change the values to reflect your site’s details. There is even [a matching TextMate command](http://gist.github.com/214959) that will help you run this script from within Textmate. +Once you’ve generated the `_site` directory, you can easily scp it using a +`tasks/deploy` shell script similar to [this deploy script][]. You’d obviously +need to change the values to reflect your site’s details. There is even [a +matching TextMate command][] that will help you run this script. + +[this deploy script here]: https://github.com/henrik/henrik.nyh.se/blob/master/script/deploy + +[a matching TextMate command]: https://gist.github.com/henrik/214959 ### rsync @@ -109,7 +117,7 @@ process. It makes sense to restrict rsync access only to the directory which it If it is not already installed by your host, you can do it yourself: -- [Download rrsync](http://ftp.samba.org/pub/unpacked/rsync/support/rrsync) +- [Download rrsync](https://ftp.samba.org/pub/unpacked/rsync/support/rrsync) - Place it in the `bin` subdirectory of your home folder (`~/bin`) - Make it executable (`chmod +x`) diff --git a/site/_docs/extras.md b/site/_docs/extras.md index 24bcafa1..708d8718 100644 --- a/site/_docs/extras.md +++ b/site/_docs/extras.md @@ -9,13 +9,13 @@ may want to install, depending on how you plan to use Jekyll. ## Math Support -Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](http://www.mathjax.org/) within math blocks. See the Kramdown documentation on [math blocks](http://kramdown.gettalong.org/syntax.html#math-blocks) and [math support](http://kramdown.gettalong.org/converter/html.html#math-support) for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g. +Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](https://www.mathjax.org) within math blocks. See the Kramdown documentation on [math blocks](http://kramdown.gettalong.org/syntax.html#math-blocks) and [math support](http://kramdown.gettalong.org/converter/html.html#math-support) for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g. {% highlight html %} - + {% endhighlight %} -For more information about getting started, check out [this excellent blog post](http://gastonsanchez.com/opinion/2014/02/16/Mathjax-with-jekyll/). +For more information about getting started, check out [this excellent blog post](https://gastonsanchez.com/opinion/2014/02/16/Mathjax-with-jekyll/). ## Alternative Markdown Processors diff --git a/site/_docs/frontmatter.md b/site/_docs/frontmatter.md index c9a0292e..755f0bc6 100644 --- a/site/_docs/frontmatter.md +++ b/site/_docs/frontmatter.md @@ -108,7 +108,7 @@ front matter of a page or post. more categories that the post belongs to. When the site is generated the post will act as though it had been set with these categories normally. Categories (plural key) can be specified as a YAML list or a + href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list or a comma-separated string.

diff --git a/site/_docs/github-pages.md b/site/_docs/github-pages.md index add661c3..49477c72 100644 --- a/site/_docs/github-pages.md +++ b/site/_docs/github-pages.md @@ -4,7 +4,7 @@ title: GitHub Pages permalink: /docs/github-pages/ --- -[GitHub Pages](http://pages.github.com) are public web pages for users, +[GitHub Pages](https://pages.github.com) are public web pages for users, organizations, and repositories, that are freely hosted on GitHub's `github.io` domain or on a custom domain name of your choice. GitHub Pages are powered by Jekyll behind the scenes, so in addition to supporting regular HTML @@ -117,7 +117,7 @@ branch]({{ site.repository }}/tree/gh-pages) of the same repository.
Source Files Must be in the Root Directory

-GitHub Pages overrides the “Site Source” configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly. +GitHub Pages overrides the “Site Source” configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly.

diff --git a/site/_docs/index.md b/site/_docs/index.md index ceae4749..5e08d760 100644 --- a/site/_docs/index.md +++ b/site/_docs/index.md @@ -15,11 +15,11 @@ development of Jekyll itself. Jekyll is a simple, blog-aware, static site generator. It takes a template directory containing raw text files in various formats, runs it through -a converter (like [Markdown](http://daringfireball.net/projects/markdown/)) +a converter (like [Markdown](https://daringfireball.net/projects/markdown/)) and our [Liquid](https://github.com/Shopify/liquid/wiki) renderer, and spits out a complete, ready-to-publish static website suitable for serving with your favorite web server. Jekyll also happens to be the engine -behind [GitHub Pages](http://pages.github.com), which means you can use Jekyll +behind [GitHub Pages](https://pages.github.com), which means you can use Jekyll to host your project’s page, blog, or website from GitHub’s servers **for free**. diff --git a/site/_docs/installation.md b/site/_docs/installation.md index 3720d043..e557cb76 100644 --- a/site/_docs/installation.md +++ b/site/_docs/installation.md @@ -14,11 +14,11 @@ encountered and how we might make the process easier Installing Jekyll is easy and straight-forward, but there are a few requirements you’ll need to make sure your system has before you start. -- [Ruby](http://www.ruby-lang.org/en/downloads/) (including development +- [Ruby](https://www.ruby-lang.org/en/downloads/) (including development headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3) -- [RubyGems](http://rubygems.org/pages/download) +- [RubyGems](https://rubygems.org/pages/download) - Linux, Unix, or Mac OS X -- [NodeJS](http://nodejs.org), or another JavaScript runtime (Jekyll 2 and +- [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and earlier, for CoffeeScript support). - [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier) diff --git a/site/_docs/migrations.md b/site/_docs/migrations.md index 0544341a..961762f7 100644 --- a/site/_docs/migrations.md +++ b/site/_docs/migrations.md @@ -6,4 +6,4 @@ permalink: /docs/migrations/ If you’re switching to Jekyll from another blogging system, Jekyll’s importers can help you with the move. To learn more about importing your site to Jekyll, -visit our [`jekyll-import` docs site](http://import.jekyllrb.com/docs/home/). +visit our [`jekyll-import` docs site](https://import.jekyllrb.com/docs/home/). diff --git a/site/_docs/pages.md b/site/_docs/pages.md index 32f7f9b8..aaed2e14 100644 --- a/site/_docs/pages.md +++ b/site/_docs/pages.md @@ -27,11 +27,11 @@ homepage of your Jekyll-generated site. ## Where additional pages live -Where you put HTML or [Markdown](http://daringfireball.net/projects/markdown/) +Where you put HTML or [Markdown](https://daringfireball.net/projects/markdown/) files for pages depends on how you want the pages to work. There are two main ways of creating pages: -- Place named HTML or [Markdown](http://daringfireball.net/projects/markdown/) +- Place named HTML or [Markdown](https://daringfireball.net/projects/markdown/) files for each page in your site's root folder. - Create a folder in the site's root for each page, and place an index.html or index.md file in each page folder. diff --git a/site/_docs/plugins.md b/site/_docs/plugins.md index 3236c03b..a8953f91 100644 --- a/site/_docs/plugins.md +++ b/site/_docs/plugins.md @@ -11,7 +11,7 @@ having to modify the Jekyll source itself.
Plugins on GitHub Pages

- GitHub Pages is powered by Jekyll. + 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.

@@ -311,7 +311,7 @@ Commands should implement this single class method:

This method accepts one parameter, the - Mercenary::Program + Mercenary::Program instance, which is the Jekyll program itself. Upon the program, commands may be created using the above syntax. For more details, visit the Mercenary repository on GitHub.com. diff --git a/site/_docs/posts.md b/site/_docs/posts.md index 1b3e322b..33710b53 100644 --- a/site/_docs/posts.md +++ b/site/_docs/posts.md @@ -15,7 +15,7 @@ CMS systems, this will be a welcome change! As explained on the [directory structure](../structure/) page, the `_posts` folder is where your blog posts will live. These files are generally -[Markdown](http://daringfireball.net/projects/markdown/) or HTML, but can +[Markdown](https://daringfireball.net/projects/markdown/) or HTML, but can be other formats with the proper converter installed. All posts must have [YAML Front Matter](../frontmatter/), and they will be converted from their source format into an HTML page that is part of your @@ -53,7 +53,7 @@ file. For example, the following are examples of valid post filenames: All blog post files must begin with [YAML Front Matter](../frontmatter/). After that, it's simply a matter of deciding which format you prefer. Jekyll supports -[Markdown](http://daringfireball.net/projects/markdown/) out of the box, +[Markdown](https://daringfireball.net/projects/markdown/) out of the box, and has [myriad extensions for other formats as well](/docs/plugins/#converters-1), including the popular [Textile](http://redcloth.org/textile) format. These formats each have their own way of marking up different types of content @@ -116,8 +116,8 @@ Linking to a PDF for readers to download: It’s all well and good to have posts in a folder, but a blog is no use unless you have a list of posts somewhere. Creating an index of posts on another page (or in a [template](../templates/)) is easy, thanks to the [Liquid template -language](http://wiki.shopify.com/Liquid) and its tags. Here’s a basic example -of how to create a list of links to your blog posts: +language](https://docs.shopify.com/themes/liquid/basics) and its tags. Here’s a +basic example of how to create a list of links to your blog posts: {% highlight html %}

    diff --git a/site/_docs/upgrading/2-to-3.md b/site/_docs/upgrading/2-to-3.md index 330228de..aec72e7c 100644 --- a/site/_docs/upgrading/2-to-3.md +++ b/site/_docs/upgrading/2-to-3.md @@ -92,7 +92,7 @@ error when trying to **serve** or **build**: {% highlight text %} Since v3.0, permalinks for pages in subfolders must be relative to the site source directory, not the parent directory. Check -http://jekyllrb.com/docs/upgrading/ for more info. +https://jekyllrb.com/docs/upgrading/ for more info. {% endhighlight %} This can be fixed by removing the following line from your `_config.yml` file: From 58a74a166d29738b702fe6048b9f1f37f363f394 Mon Sep 17 00:00:00 2001 From: chrisfinazzo Date: Tue, 23 Feb 2016 11:20:32 -0500 Subject: [PATCH 2/3] Feedback from @parkr --- site/_docs/github-pages.md | 2 +- site/_docs/upgrading/2-to-3.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/site/_docs/github-pages.md b/site/_docs/github-pages.md index 49477c72..cfe8822a 100644 --- a/site/_docs/github-pages.md +++ b/site/_docs/github-pages.md @@ -117,7 +117,7 @@ branch]({{ site.repository }}/tree/gh-pages) of the same repository.
    Source Files Must be in the Root Directory

    -GitHub Pages overrides the “Site Source” configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly. +GitHub Pages overrides the “Site Source” configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly.

    diff --git a/site/_docs/upgrading/2-to-3.md b/site/_docs/upgrading/2-to-3.md index aec72e7c..330228de 100644 --- a/site/_docs/upgrading/2-to-3.md +++ b/site/_docs/upgrading/2-to-3.md @@ -92,7 +92,7 @@ error when trying to **serve** or **build**: {% highlight text %} Since v3.0, permalinks for pages in subfolders must be relative to the site source directory, not the parent directory. Check -https://jekyllrb.com/docs/upgrading/ for more info. +http://jekyllrb.com/docs/upgrading/ for more info. {% endhighlight %} This can be fixed by removing the following line from your `_config.yml` file: From 9c1a897d60129d4418b39927f04c0267d6da8909 Mon Sep 17 00:00:00 2001 From: chrisfinazzo Date: Tue, 23 Feb 2016 16:26:09 -0500 Subject: [PATCH 3/3] Use an inline link here --- site/_docs/contributing.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/site/_docs/contributing.md b/site/_docs/contributing.md index 5c5b1f13..a5654bdd 100644 --- a/site/_docs/contributing.md +++ b/site/_docs/contributing.md @@ -27,11 +27,9 @@ following in mind: change is to review, the more likely it will be merged. * When submitting a pull request, please make judicious use of the pull request body. A description of what changes were made, the motivations behind the - changes and [any tasks completed or left to complete][] + changes, and [any tasks completed or left to complete](http://git.io/gfm-tasks) will also speed up review time. -[any tasks completed or left to complete]: https://git.io/gfm-tasks -
    Contributions will not be accepted without tests