jekyll-docs 3.1.6 → 3.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/jekyll-docs.rb +7 -13
- data/site/community/index.html +305 -0
- data/site/conduct/index.html +10 -0
- data/site/css/screen.css +1445 -0
- data/site/docs/assets/index.html +701 -0
- data/site/docs/collections/index.html +973 -0
- data/site/docs/conduct/index.html +718 -0
- data/site/docs/configuration/index.html +1337 -0
- data/site/docs/continuous-integration/index.html +846 -0
- data/site/docs/contributing/index.html +815 -0
- data/site/docs/datafiles/index.html +742 -0
- data/site/docs/deployment-methods/index.html +866 -0
- data/site/docs/drafts/index.html +615 -0
- data/site/docs/extras/index.html +656 -0
- data/site/docs/frontmatter/index.html +776 -0
- data/site/docs/github-pages/index.html +778 -0
- data/site/docs/history/index.html +3293 -0
- data/site/docs/home/index.html +627 -0
- data/site/docs/index.html +10 -0
- data/site/docs/installation/index.html +682 -0
- data/site/docs/migrations/index.html +627 -0
- data/site/docs/pages/index.html +698 -0
- data/site/docs/pagination/index.html +840 -0
- data/site/docs/permalinks/index.html +924 -0
- data/site/docs/plugins/index.html +1726 -0
- data/site/docs/posts/index.html +811 -0
- data/site/docs/quickstart/index.html +599 -0
- data/site/docs/resources/index.html +717 -0
- data/site/docs/sites/index.html +676 -0
- data/site/docs/static-files/index.html +655 -0
- data/site/docs/structure/index.html +794 -0
- data/site/docs/templates/index.html +1105 -0
- data/site/docs/themes/index.html +751 -0
- data/site/docs/troubleshooting/index.html +826 -0
- data/site/docs/upgrading/0-to-2/index.html +802 -0
- data/site/docs/upgrading/2-to-3/index.html +785 -0
- data/site/docs/upgrading/index.html +664 -0
- data/site/docs/usage/index.html +673 -0
- data/site/docs/variables/index.html +1013 -0
- data/site/docs/windows/index.html +775 -0
- data/site/feed.xml +222 -0
- data/site/github.html +10 -0
- data/site/help/index.html +246 -0
- data/site/img/article-footer.png +0 -0
- data/site/img/footer-logo.png +0 -0
- data/site/img/logo-2x.png +0 -0
- data/site/index.html +200 -16
- data/site/issues.html +10 -0
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +524 -0
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +524 -0
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +525 -0
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +522 -0
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +524 -0
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +523 -0
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +519 -0
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +519 -0
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +526 -0
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +520 -0
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +518 -0
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +553 -0
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +522 -0
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +537 -0
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +519 -0
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +518 -0
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +527 -0
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +518 -0
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +523 -0
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +539 -0
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +519 -0
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +521 -0
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +536 -0
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +533 -0
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +522 -0
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +542 -0
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +528 -0
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +551 -0
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +529 -0
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +519 -0
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +526 -0
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +521 -0
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +522 -0
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +542 -0
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +517 -0
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +546 -0
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +530 -0
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +520 -0
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +553 -0
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +537 -0
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +532 -0
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +523 -0
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +519 -0
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +525 -0
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +521 -0
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +526 -0
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +530 -0
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +518 -0
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +520 -0
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +521 -0
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +630 -0
- data/site/news/index.html +2831 -10
- data/site/news/releases/index.html +2603 -10
- data/site/sitemap.xml +327 -0
- metadata +99 -111
- data/site/_config.yml +0 -25
- data/site/_data/docs.yml +0 -49
- data/site/_docs/assets.md +0 -94
- data/site/_docs/collections.md +0 -380
- data/site/_docs/conduct.md +0 -55
- data/site/_docs/configuration.md +0 -747
- data/site/_docs/continuous-integration.md +0 -221
- data/site/_docs/contributing.md +0 -124
- data/site/_docs/datafiles.md +0 -151
- data/site/_docs/deployment-methods.md +0 -213
- data/site/_docs/drafts.md +0 -20
- data/site/_docs/extras.md +0 -22
- data/site/_docs/frontmatter.md +0 -191
- data/site/_docs/github-pages.md +0 -133
- data/site/_docs/history.md +0 -2323
- data/site/_docs/index.md +0 -57
- data/site/_docs/installation.md +0 -106
- data/site/_docs/migrations.md +0 -9
- data/site/_docs/pages.md +0 -100
- data/site/_docs/pagination.md +0 -224
- data/site/_docs/permalinks.md +0 -308
- data/site/_docs/plugins.md +0 -903
- data/site/_docs/posts.md +0 -237
- data/site/_docs/quickstart.md +0 -26
- data/site/_docs/resources.md +0 -38
- data/site/_docs/sites.md +0 -23
- data/site/_docs/static_files.md +0 -52
- data/site/_docs/structure.md +0 -211
- data/site/_docs/templates.md +0 -451
- data/site/_docs/troubleshooting.md +0 -207
- data/site/_docs/upgrading.md +0 -10
- data/site/_docs/upgrading/0-to-2.md +0 -140
- data/site/_docs/upgrading/2-to-3.md +0 -126
- data/site/_docs/usage.md +0 -101
- data/site/_docs/variables.md +0 -390
- data/site/_docs/windows.md +0 -46
- data/site/_includes/analytics.html +0 -30
- data/site/_includes/anchor_links.html +0 -33
- data/site/_includes/docs_contents.html +0 -8
- data/site/_includes/docs_contents_mobile.html +0 -10
- data/site/_includes/docs_option.html +0 -11
- data/site/_includes/docs_ul.html +0 -17
- data/site/_includes/footer.html +0 -15
- data/site/_includes/header.html +0 -18
- data/site/_includes/news_contents.html +0 -33
- data/site/_includes/news_contents_mobile.html +0 -11
- data/site/_includes/news_item.html +0 -24
- data/site/_includes/primary-nav-items.html +0 -17
- data/site/_includes/section_nav.html +0 -39
- data/site/_includes/top.html +0 -17
- data/site/_layouts/default.html +0 -13
- data/site/_layouts/docs.html +0 -26
- data/site/_layouts/news.html +0 -19
- data/site/_layouts/news_item.html +0 -27
- data/site/_layouts/page.html +0 -18
- data/site/_posts/2013-05-06-jekyll-1-0-0-released.markdown +0 -23
- data/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown +0 -27
- data/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown +0 -28
- data/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown +0 -25
- data/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown +0 -27
- data/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown +0 -31
- data/site/_posts/2013-07-25-jekyll-1-0-4-released.markdown +0 -20
- data/site/_posts/2013-07-25-jekyll-1-1-2-released.markdown +0 -20
- data/site/_posts/2013-09-06-jekyll-1-2-0-released.markdown +0 -23
- data/site/_posts/2013-09-14-jekyll-1-2-1-released.markdown +0 -19
- data/site/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown +0 -17
- data/site/_posts/2013-11-04-jekyll-1-3-0-released.markdown +0 -43
- data/site/_posts/2013-11-26-jekyll-1-3-1-released.markdown +0 -21
- data/site/_posts/2013-12-07-jekyll-1-4-0-released.markdown +0 -30
- data/site/_posts/2013-12-09-jekyll-1-4-1-released.markdown +0 -18
- data/site/_posts/2013-12-16-jekyll-1-4-2-released.markdown +0 -18
- data/site/_posts/2014-01-13-jekyll-1-4-3-released.markdown +0 -26
- data/site/_posts/2014-03-24-jekyll-1-5-0-released.markdown +0 -19
- data/site/_posts/2014-03-27-jekyll-1-5-1-released.markdown +0 -26
- data/site/_posts/2014-05-06-jekyll-turns-2-0-0.markdown +0 -31
- data/site/_posts/2014-05-08-jekyll-2-0-3-released.markdown +0 -18
- data/site/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown +0 -19
- data/site/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown +0 -31
- data/site/_posts/2014-07-01-jekyll-2-1-1-released.markdown +0 -30
- data/site/_posts/2014-07-29-jekyll-2-2-0-released.markdown +0 -19
- data/site/_posts/2014-08-10-jekyll-2-3-0-released.markdown +0 -41
- data/site/_posts/2014-09-09-jekyll-2-4-0-released.markdown +0 -25
- data/site/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown +0 -47
- data/site/_posts/2014-11-08-jekyll-2-5-1-released.markdown +0 -29
- data/site/_posts/2014-11-12-jekyll-2-5-2-released.markdown +0 -18
- data/site/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md +0 -27
- data/site/_posts/2014-12-22-jekyll-2-5-3-released.markdown +0 -20
- data/site/_posts/2015-01-20-jekyll-meet-and-greet.markdown +0 -20
- data/site/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown +0 -40
- data/site/_posts/2015-02-26-introducing-jekyll-talk.markdown +0 -15
- data/site/_posts/2015-10-26-jekyll-3-0-released.markdown +0 -35
- data/site/_posts/2015-11-17-jekyll-3-0-1-released.markdown +0 -25
- data/site/_posts/2016-01-20-jekyll-3-0-2-released.markdown +0 -19
- data/site/_posts/2016-01-24-jekyll-3-1-0-released.markdown +0 -50
- data/site/_posts/2016-01-28-jekyll-3-1-1-released.markdown +0 -33
- data/site/_posts/2016-02-08-jekyll-3-0-3-released.markdown +0 -32
- data/site/_posts/2016-02-19-jekyll-3-1-2-released.markdown +0 -20
- data/site/_sass/_font-awesome.scss +0 -25
- data/site/_sass/_gridism.scss +0 -124
- data/site/_sass/_mixins.scss +0 -38
- data/site/_sass/_normalize.scss +0 -1
- data/site/_sass/_pygments.scss +0 -78
- data/site/_sass/_style.scss +0 -1002
- data/site/css/screen.scss +0 -9
- data/site/help/index.md +0 -41
- data/site/redirects/github.html +0 -4
- data/site/redirects/issues.html +0 -4
@@ -0,0 +1,10 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="en-US">
|
3
|
+
<meta charset="utf-8">
|
4
|
+
<title>Redirecting…</title>
|
5
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/home/">
|
6
|
+
<meta http-equiv="refresh" content="0; url=https://jekyllrb.com/docs/home/">
|
7
|
+
<h1>Redirecting…</h1>
|
8
|
+
<a href="https://jekyllrb.com/docs/home/">Click here if you are not redirected.</a>
|
9
|
+
<script>location="https://jekyllrb.com/docs/home/"</script>
|
10
|
+
</html>
|
@@ -0,0 +1,682 @@
|
|
1
|
+
<!DOCTYPE HTML>
|
2
|
+
<html lang="en-US">
|
3
|
+
<head>
|
4
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
+
<meta name="generator" content="Jekyll v3.2.0">
|
8
|
+
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
|
+
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
|
+
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
|
+
<link rel="stylesheet" href="/css/screen.css">
|
12
|
+
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
+
<!-- Begin Jekyll SEO tag v2.0.0 -->
|
14
|
+
<title>Installation - Jekyll • Simple, blog-aware, static sites</title>
|
15
|
+
<meta property="og:title" content="Installation">
|
16
|
+
<meta name="description" content="Transform your plain text into static websites and blogs">
|
17
|
+
<meta property="og:description" content="Transform your plain text into static websites and blogs">
|
18
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/installation/">
|
19
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/installation/">
|
20
|
+
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
|
+
<meta property="og:type" content="article">
|
22
|
+
<meta property="article:published_time" content="2016-07-27T18:44:57-07:00">
|
23
|
+
<meta name="twitter:card" content="summary">
|
24
|
+
<meta name="twitter:site" content="@jekyllrb">
|
25
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
26
|
+
<script type="application/ld+json">
|
27
|
+
{
|
28
|
+
"@context": "http://schema.org",
|
29
|
+
"@type": "BlogPosting",
|
30
|
+
"headline": "Installation",
|
31
|
+
"datePublished": "2016-07-27T18:44:57-07:00",
|
32
|
+
"description": "Transform your plain text into static websites and blogs",
|
33
|
+
"logo": "https://jekyllrb.comimg/logo-2x.png",
|
34
|
+
"url": "https://jekyllrb.com/docs/installation/"
|
35
|
+
}
|
36
|
+
</script>
|
37
|
+
<!-- End Jekyll SEO tag -->
|
38
|
+
<!--[if lt IE 9]>
|
39
|
+
<script src="/js/html5shiv.min.js"></script>
|
40
|
+
<script src="/js/respond.min.js"></script>
|
41
|
+
<![endif]-->
|
42
|
+
</head>
|
43
|
+
|
44
|
+
|
45
|
+
<body class="wrap">
|
46
|
+
<header>
|
47
|
+
<nav class="mobile-nav show-on-mobiles">
|
48
|
+
<ul>
|
49
|
+
<li class="">
|
50
|
+
<a href="/">Home</a>
|
51
|
+
</li>
|
52
|
+
<li class="current">
|
53
|
+
<a href="/docs/home/">Docs</a>
|
54
|
+
</li>
|
55
|
+
<li class="">
|
56
|
+
<a href="/news/">News</a>
|
57
|
+
</li>
|
58
|
+
<li class="">
|
59
|
+
<a href="/community/">Community</a>
|
60
|
+
</li>
|
61
|
+
<li class="">
|
62
|
+
<a href="/help/">Help</a>
|
63
|
+
</li>
|
64
|
+
<li>
|
65
|
+
<a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
|
66
|
+
</li>
|
67
|
+
</ul>
|
68
|
+
|
69
|
+
</nav>
|
70
|
+
<div class="grid">
|
71
|
+
<div class="unit one-third center-on-mobiles">
|
72
|
+
<h1>
|
73
|
+
<a href="/">
|
74
|
+
<span class="sr-only">Jekyll</span>
|
75
|
+
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
76
|
+
</a>
|
77
|
+
</h1>
|
78
|
+
</div>
|
79
|
+
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
80
|
+
<ul>
|
81
|
+
<li class="">
|
82
|
+
<a href="/">Home</a>
|
83
|
+
</li>
|
84
|
+
<li class="current">
|
85
|
+
<a href="/docs/home/">Docs</a>
|
86
|
+
</li>
|
87
|
+
<li class="">
|
88
|
+
<a href="/news/">News</a>
|
89
|
+
</li>
|
90
|
+
<li class="">
|
91
|
+
<a href="/community/">Community</a>
|
92
|
+
</li>
|
93
|
+
<li class="">
|
94
|
+
<a href="/help/">Help</a>
|
95
|
+
</li>
|
96
|
+
<li>
|
97
|
+
<a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
|
98
|
+
</li>
|
99
|
+
</ul>
|
100
|
+
|
101
|
+
</nav>
|
102
|
+
</div>
|
103
|
+
</header>
|
104
|
+
|
105
|
+
|
106
|
+
<section class="docs">
|
107
|
+
<div class="grid">
|
108
|
+
|
109
|
+
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
110
|
+
<select onchange="if (this.value) window.location.href=this.value">
|
111
|
+
<option value="">Navigate the docs…</option>
|
112
|
+
|
113
|
+
<optgroup label="Getting Started">
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
<option value="https://jekyllrb.com/docs/home/">Welcome</option>
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
<option value="https://jekyllrb.com/docs/quickstart/">Quick-start guide</option>
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
<option value="https://jekyllrb.com/docs/installation/">Installation</option>
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
<option value="https://jekyllrb.com/docs/usage/">Basic Usage</option>
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
<option value="https://jekyllrb.com/docs/structure/">Directory structure</option>
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
<option value="https://jekyllrb.com/docs/configuration/">Configuration</option>
|
138
|
+
|
139
|
+
|
140
|
+
</optgroup>
|
141
|
+
|
142
|
+
<optgroup label="Your Content">
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
<option value="https://jekyllrb.com/docs/frontmatter/">Front Matter</option>
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
<option value="https://jekyllrb.com/docs/posts/">Writing posts</option>
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
<option value="https://jekyllrb.com/docs/drafts/">Working with drafts</option>
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
<option value="https://jekyllrb.com/docs/pages/">Creating pages</option>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
<option value="https://jekyllrb.com/docs/static-files/">Static Files</option>
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
<option value="https://jekyllrb.com/docs/variables/">Variables</option>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
<option value="https://jekyllrb.com/docs/collections/">Collections</option>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
<option value="https://jekyllrb.com/docs/datafiles/">Data Files</option>
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
<option value="https://jekyllrb.com/docs/assets/">Assets</option>
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
<option value="https://jekyllrb.com/docs/migrations/">Blog migrations</option>
|
183
|
+
|
184
|
+
|
185
|
+
</optgroup>
|
186
|
+
|
187
|
+
<optgroup label="Customization">
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
<option value="https://jekyllrb.com/docs/templates/">Templates</option>
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
<option value="https://jekyllrb.com/docs/permalinks/">Permalinks</option>
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
<option value="https://jekyllrb.com/docs/pagination/">Pagination</option>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
<option value="https://jekyllrb.com/docs/plugins/">Plugins</option>
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
<option value="https://jekyllrb.com/docs/themes/">Themes</option>
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
<option value="https://jekyllrb.com/docs/extras/">Extras</option>
|
212
|
+
|
213
|
+
|
214
|
+
</optgroup>
|
215
|
+
|
216
|
+
<optgroup label="Deployment">
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
<option value="https://jekyllrb.com/docs/github-pages/">GitHub Pages</option>
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
<option value="https://jekyllrb.com/docs/deployment-methods/">Deployment methods</option>
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
<option value="https://jekyllrb.com/docs/continuous-integration/">Continuous Integration</option>
|
229
|
+
|
230
|
+
|
231
|
+
</optgroup>
|
232
|
+
|
233
|
+
<optgroup label="Miscellaneous">
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
<option value="https://jekyllrb.com/docs/troubleshooting/">Troubleshooting</option>
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
<option value="https://jekyllrb.com/docs/sites/">Sites using Jekyll</option>
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
<option value="https://jekyllrb.com/docs/resources/">Resources</option>
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
<option value="https://jekyllrb.com/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
<option value="https://jekyllrb.com/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
|
254
|
+
|
255
|
+
|
256
|
+
</optgroup>
|
257
|
+
|
258
|
+
<optgroup label="Meta">
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
<option value="https://jekyllrb.com/docs/contributing/">Contributing</option>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
<option value="https://jekyllrb.com/docs/conduct/">Code of Conduct</option>
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
<option value="https://jekyllrb.com/docs/history/">History</option>
|
271
|
+
|
272
|
+
|
273
|
+
</optgroup>
|
274
|
+
|
275
|
+
</select>
|
276
|
+
</div>
|
277
|
+
|
278
|
+
|
279
|
+
<div class="unit four-fifths">
|
280
|
+
<article>
|
281
|
+
<div class="improve right hide-on-mobiles">
|
282
|
+
<a href="https://github.com/jekyll/jekyll/edit/master/site/_docs/installation.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
283
|
+
</div>
|
284
|
+
<h1>Installation</h1>
|
285
|
+
<p>Getting Jekyll installed and ready-to-go should only take a few minutes.
|
286
|
+
If it ever becomes a pain, please <a href="https://github.com/jekyll/jekyll/issues/new">file an issue</a>
|
287
|
+
(or submit a pull request) describing the issue you
|
288
|
+
encountered and how we might make the process easier</p>
|
289
|
+
|
290
|
+
<h3 id="requirements">Requirements</h3>
|
291
|
+
|
292
|
+
<p>Installing Jekyll is easy and straight-forward, but there are a few
|
293
|
+
requirements you’ll need to make sure your system has before you start.</p>
|
294
|
+
|
295
|
+
<ul>
|
296
|
+
<li>
|
297
|
+
<a href="https://www.ruby-lang.org/en/downloads/">Ruby</a> (including development
|
298
|
+
headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3)</li>
|
299
|
+
<li><a href="https://rubygems.org/pages/download">RubyGems</a></li>
|
300
|
+
<li>Linux, Unix, or Mac OS X</li>
|
301
|
+
<li>
|
302
|
+
<a href="https://nodejs.org/">NodeJS</a>, or another JavaScript runtime (Jekyll 2 and
|
303
|
+
earlier, for CoffeeScript support).</li>
|
304
|
+
<li>
|
305
|
+
<a href="https://www.python.org/downloads/">Python 2.7</a> (for Jekyll 2 and earlier)</li>
|
306
|
+
</ul>
|
307
|
+
|
308
|
+
<div class="note info">
|
309
|
+
<h5>Running Jekyll on Windows</h5>
|
310
|
+
<p>
|
311
|
+
While Windows is not officially supported, it is possible to get it running
|
312
|
+
on Windows. Special instructions can be found on our
|
313
|
+
<a href="../windows/#installation">Windows-specific docs page</a>.
|
314
|
+
</p>
|
315
|
+
</div>
|
316
|
+
|
317
|
+
<h2 id="install-with-rubygems">Install with RubyGems</h2>
|
318
|
+
|
319
|
+
<p>The best way to install Jekyll is via
|
320
|
+
<a href="http://rubygems.org/pages/download">RubyGems</a>. At the terminal prompt,
|
321
|
+
simply run the following command to install Jekyll:</p>
|
322
|
+
|
323
|
+
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="gp">$ </span>gem install jekyll</code></pre></figure>
|
324
|
+
|
325
|
+
<p>All of Jekyll’s gem dependencies are automatically installed by the above
|
326
|
+
command, so you won’t have to worry about them at all. If you have problems
|
327
|
+
installing Jekyll, check out the <a href="../troubleshooting/">troubleshooting</a> page or
|
328
|
+
<a href="https://github.com/jekyll/jekyll/issues/new">report an issue</a> so the Jekyll
|
329
|
+
community can improve the experience for everyone.</p>
|
330
|
+
|
331
|
+
<div class="note info">
|
332
|
+
<h5>Installing Xcode Command-Line Tools</h5>
|
333
|
+
<p>
|
334
|
+
If you run into issues installing Jekyll's dependencies which make use of
|
335
|
+
native extensions and are using Mac OS X, you will need to install Xcode
|
336
|
+
and the Command-Line Tools it ships with. Download in
|
337
|
+
<code>Preferences → Downloads → Components</code>.
|
338
|
+
</p>
|
339
|
+
</div>
|
340
|
+
|
341
|
+
<h2 id="pre-releases">Pre-releases</h2>
|
342
|
+
|
343
|
+
<p>In order to install a pre-release, make sure you have all the requirements
|
344
|
+
installed properly and run:</p>
|
345
|
+
|
346
|
+
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">gem install jekyll --pre</code></pre></figure>
|
347
|
+
|
348
|
+
<p>This will install the latest pre-release. If you want a particular pre-release,
|
349
|
+
use the <code class="highlighter-rouge">-v</code> switch to indicate the version you’d like to install:</p>
|
350
|
+
|
351
|
+
<figure class="highlight"><pre><code class="language-shell" data-lang="shell">gem install jekyll -v <span class="s1">'2.0.0.alpha.1'</span></code></pre></figure>
|
352
|
+
|
353
|
+
<p>If you’d like to install a development version of Jekyll, the process is a bit
|
354
|
+
more involved. This gives you the advantage of having the latest and greatest,
|
355
|
+
but may be unstable.</p>
|
356
|
+
|
357
|
+
<figure class="highlight"><pre><code class="language-shell" data-lang="shell"><span class="gp">$ </span>git clone git://github.com/jekyll/jekyll.git
|
358
|
+
<span class="gp">$ </span><span class="nb">cd </span>jekyll
|
359
|
+
<span class="gp">$ </span>script/bootstrap
|
360
|
+
<span class="gp">$ </span>bundle <span class="nb">exec </span>rake build
|
361
|
+
<span class="gp">$ </span>ls pkg/<span class="k">*</span>.gem | head -n 1 | xargs gem install -l</code></pre></figure>
|
362
|
+
|
363
|
+
<h2 id="optional-extras">Optional Extras</h2>
|
364
|
+
|
365
|
+
<p>There are a number of (optional) extra features that Jekyll supports that you
|
366
|
+
may want to install, depending on how you plan to use Jekyll. These extras
|
367
|
+
include LaTeX support, and the use of alternative content rendering engines.
|
368
|
+
Check out <a href="../extras/">the extras page</a> for more information.</p>
|
369
|
+
|
370
|
+
<div class="note">
|
371
|
+
<h5>ProTip™: Enable Syntax Highlighting</h5>
|
372
|
+
<p>
|
373
|
+
If you’re the kind of person who is using Jekyll, then chances are you’ll
|
374
|
+
want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
|
375
|
+
or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
|
376
|
+
<a href="../templates/#code-snippet-highlighting">check out how to
|
377
|
+
do that</a> before you go any farther.
|
378
|
+
</p>
|
379
|
+
</div>
|
380
|
+
|
381
|
+
<p>Now that you’ve got everything installed, let’s get to work!</p>
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
<div class="section-nav">
|
398
|
+
<div class="left align-right">
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
<a href="/docs/quickstart/" class="prev">Back</a>
|
403
|
+
|
404
|
+
</div>
|
405
|
+
<div class="right align-left">
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
<a href="/docs/usage/" class="next">Next</a>
|
410
|
+
|
411
|
+
</div>
|
412
|
+
</div>
|
413
|
+
<div class="clear"></div>
|
414
|
+
|
415
|
+
</article>
|
416
|
+
</div>
|
417
|
+
|
418
|
+
<div class="unit one-fifth hide-on-mobiles">
|
419
|
+
<aside>
|
420
|
+
|
421
|
+
<h4>Getting Started</h4>
|
422
|
+
<ul>
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
<li class=""><a href="https://jekyllrb.com/docs/home/">Welcome</a></li>
|
427
|
+
|
428
|
+
|
429
|
+
|
430
|
+
<li class=""><a href="https://jekyllrb.com/docs/quickstart/">Quick-start guide</a></li>
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
<li class="current"><a href="https://jekyllrb.com/docs/installation/">Installation</a></li>
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
<li class=""><a href="https://jekyllrb.com/docs/usage/">Basic Usage</a></li>
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
<li class=""><a href="https://jekyllrb.com/docs/structure/">Directory structure</a></li>
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
<li class=""><a href="https://jekyllrb.com/docs/configuration/">Configuration</a></li>
|
447
|
+
|
448
|
+
</ul>
|
449
|
+
|
450
|
+
|
451
|
+
<h4>Your Content</h4>
|
452
|
+
<ul>
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
<li class=""><a href="https://jekyllrb.com/docs/frontmatter/">Front Matter</a></li>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
<li class=""><a href="https://jekyllrb.com/docs/posts/">Writing posts</a></li>
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
<li class=""><a href="https://jekyllrb.com/docs/drafts/">Working with drafts</a></li>
|
465
|
+
|
466
|
+
|
467
|
+
|
468
|
+
<li class=""><a href="https://jekyllrb.com/docs/pages/">Creating pages</a></li>
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
<li class=""><a href="https://jekyllrb.com/docs/static-files/">Static Files</a></li>
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
<li class=""><a href="https://jekyllrb.com/docs/variables/">Variables</a></li>
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
<li class=""><a href="https://jekyllrb.com/docs/collections/">Collections</a></li>
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
<li class=""><a href="https://jekyllrb.com/docs/datafiles/">Data Files</a></li>
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
<li class=""><a href="https://jekyllrb.com/docs/assets/">Assets</a></li>
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
<li class=""><a href="https://jekyllrb.com/docs/migrations/">Blog migrations</a></li>
|
493
|
+
|
494
|
+
</ul>
|
495
|
+
|
496
|
+
|
497
|
+
<h4>Customization</h4>
|
498
|
+
<ul>
|
499
|
+
|
500
|
+
|
501
|
+
|
502
|
+
<li class=""><a href="https://jekyllrb.com/docs/templates/">Templates</a></li>
|
503
|
+
|
504
|
+
|
505
|
+
|
506
|
+
<li class=""><a href="https://jekyllrb.com/docs/permalinks/">Permalinks</a></li>
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
<li class=""><a href="https://jekyllrb.com/docs/pagination/">Pagination</a></li>
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
<li class=""><a href="https://jekyllrb.com/docs/plugins/">Plugins</a></li>
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
<li class=""><a href="https://jekyllrb.com/docs/themes/">Themes</a></li>
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
<li class=""><a href="https://jekyllrb.com/docs/extras/">Extras</a></li>
|
523
|
+
|
524
|
+
</ul>
|
525
|
+
|
526
|
+
|
527
|
+
<h4>Deployment</h4>
|
528
|
+
<ul>
|
529
|
+
|
530
|
+
|
531
|
+
|
532
|
+
<li class=""><a href="https://jekyllrb.com/docs/github-pages/">GitHub Pages</a></li>
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
<li class=""><a href="https://jekyllrb.com/docs/deployment-methods/">Deployment methods</a></li>
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
<li class=""><a href="https://jekyllrb.com/docs/continuous-integration/">Continuous Integration</a></li>
|
541
|
+
|
542
|
+
</ul>
|
543
|
+
|
544
|
+
|
545
|
+
<h4>Miscellaneous</h4>
|
546
|
+
<ul>
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
<li class=""><a href="https://jekyllrb.com/docs/troubleshooting/">Troubleshooting</a></li>
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
<li class=""><a href="https://jekyllrb.com/docs/sites/">Sites using Jekyll</a></li>
|
555
|
+
|
556
|
+
|
557
|
+
|
558
|
+
<li class=""><a href="https://jekyllrb.com/docs/resources/">Resources</a></li>
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
<li class=""><a href="https://jekyllrb.com/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
<li class=""><a href="https://jekyllrb.com/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
|
567
|
+
|
568
|
+
</ul>
|
569
|
+
|
570
|
+
|
571
|
+
<h4>Meta</h4>
|
572
|
+
<ul>
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
<li class=""><a href="https://jekyllrb.com/docs/contributing/">Contributing</a></li>
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
<li class=""><a href="https://jekyllrb.com/docs/conduct/">Code of Conduct</a></li>
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
<li class=""><a href="https://jekyllrb.com/docs/history/">History</a></li>
|
585
|
+
|
586
|
+
</ul>
|
587
|
+
|
588
|
+
|
589
|
+
</aside>
|
590
|
+
</div>
|
591
|
+
|
592
|
+
|
593
|
+
<div class="clear"></div>
|
594
|
+
|
595
|
+
</div>
|
596
|
+
</section>
|
597
|
+
|
598
|
+
|
599
|
+
<footer>
|
600
|
+
<div class="grid">
|
601
|
+
<div class="unit one-third center-on-mobiles">
|
602
|
+
<p>The contents of this website are <br>© 2016 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
603
|
+
</div>
|
604
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
605
|
+
<p>
|
606
|
+
Proudly hosted by
|
607
|
+
<a href="https://github.com">
|
608
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
609
|
+
</a>
|
610
|
+
</p>
|
611
|
+
</div>
|
612
|
+
</div>
|
613
|
+
</footer>
|
614
|
+
|
615
|
+
<script>
|
616
|
+
var anchorForId = function (id) {
|
617
|
+
var anchor = document.createElement("a");
|
618
|
+
anchor.className = "header-link";
|
619
|
+
anchor.href = "#" + id;
|
620
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
621
|
+
anchor.title = "Permalink";
|
622
|
+
return anchor;
|
623
|
+
};
|
624
|
+
|
625
|
+
var linkifyAnchors = function (level, containingElement) {
|
626
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
627
|
+
for (var h = 0; h < headers.length; h++) {
|
628
|
+
var header = headers[h];
|
629
|
+
|
630
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
631
|
+
header.appendChild(anchorForId(header.id));
|
632
|
+
}
|
633
|
+
}
|
634
|
+
};
|
635
|
+
|
636
|
+
document.onreadystatechange = function () {
|
637
|
+
if (this.readyState === "complete") {
|
638
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
639
|
+
if (!contentBlock) {
|
640
|
+
return;
|
641
|
+
}
|
642
|
+
for (var level = 1; level <= 6; level++) {
|
643
|
+
linkifyAnchors(level, contentBlock);
|
644
|
+
}
|
645
|
+
}
|
646
|
+
};
|
647
|
+
</script>
|
648
|
+
|
649
|
+
|
650
|
+
<!-- Gauges (http://gaug.es/) -->
|
651
|
+
<script>
|
652
|
+
var _gauges = _gauges || [];
|
653
|
+
(function() {
|
654
|
+
var t = document.createElement('script');
|
655
|
+
t.type = 'text/javascript';
|
656
|
+
t.async = true;
|
657
|
+
t.id = 'gauges-tracker';
|
658
|
+
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
659
|
+
t.src = '//secure.gaug.es/track.js';
|
660
|
+
var s = document.getElementsByTagName('script')[0];
|
661
|
+
s.parentNode.insertBefore(t, s);
|
662
|
+
})();
|
663
|
+
</script>
|
664
|
+
|
665
|
+
|
666
|
+
|
667
|
+
<!-- Google Analytics (http://google.com/analytics) -->
|
668
|
+
<script>
|
669
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
670
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
671
|
+
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
672
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
673
|
+
|
674
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
675
|
+
ga('send', 'pageview');
|
676
|
+
|
677
|
+
</script>
|
678
|
+
|
679
|
+
|
680
|
+
|
681
|
+
</body>
|
682
|
+
</html>
|