Merge pull request #4566 from chrisfinazzo/add-https-urls
HTTPS (almost) all the docs
This commit is contained in:
Parker Moore
commit
d14600152f
|
|
@ -26,7 +26,7 @@ will process it and put it in your site's destination folder under
|
|||
|
||||
<div class="note info">
|
||||
<h5>Jekyll processes all Liquid filters and tags in asset files</h5>
|
||||
<p>If you are using <a href="http://mustache.github.io">Mustache</a>
|
||||
<p>If you are using <a href="https://mustache.github.io">Mustache</a>
|
||||
or another JavaScript templating language that conflicts with
|
||||
the <a href="/docs/templates/">Liquid template syntax</a>, you
|
||||
will need to place <code>{% raw %}</code> and
|
||||
|
|
|
|||
|
|
@ -106,9 +106,9 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
|||
Set the time zone for site generation. This sets the <code>TZ</code>
|
||||
environment variable, which Ruby uses to handle time and date
|
||||
creation and manipulation. Any entry from the
|
||||
<a href="http://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
|
||||
<a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
|
||||
Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
|
||||
available values can be found <a href="http://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
|
||||
available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
|
||||
here</a>. The default is the local time zone, as set by your operating system.
|
||||
</p>
|
||||
</td>
|
||||
|
|
|
|||
|
|
@ -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"
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ 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](http://git.io/gfm-tasks)
|
||||
will also speed up review time.
|
||||
|
||||
<div class="note warning">
|
||||
|
|
|
|||
|
|
@ -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`)
|
||||
|
||||
|
|
|
|||
|
|
@ -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 %}
|
||||
<script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
|
||||
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
|
||||
{% 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
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <a
|
||||
href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list</a> or a
|
||||
href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list</a> or a
|
||||
comma-separated string.
|
||||
|
||||
</p>
|
||||
|
|
|
|||
|
|
@ -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.
|
|||
<div class="note warning">
|
||||
<h5>Source Files Must be in the Root Directory</h5>
|
||||
<p>
|
||||
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a> the <a href="http://jekyllrb.com/docs/configuration/#global-configuration">“Site Source”</a> configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly.
|
||||
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a> the <a href="/docs/configuration/#global-configuration">“Site Source”</a> configuration value, so if you locate your files anywhere other than the root directory, your site may not build correctly.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -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**.
|
||||
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
||||
|
|
|
|||
|
|
@ -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/).
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ having to modify the Jekyll source itself.
|
|||
<div class="note info">
|
||||
<h5>Plugins on GitHub Pages</h5>
|
||||
<p>
|
||||
<a href="http://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
|
||||
<a href="https://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
|
||||
However, all Pages sites are generated using the <code>--safe</code> option
|
||||
to disable custom plugins for security reasons. Unfortunately, this means
|
||||
your plugins won’t work if you’re deploying to GitHub Pages.<br><br>
|
||||
|
|
@ -311,7 +311,7 @@ Commands should implement this single class method:
|
|||
</td>
|
||||
<td><p>
|
||||
This method accepts one parameter, the
|
||||
<code><a href="http://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
|
||||
<code><a href="https://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -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 %}
|
||||
<ul>
|
||||
|
|
|
|||
Loading…
Reference in New Issue