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,1337 @@
|
|
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>Configuration - Jekyll • Simple, blog-aware, static sites</title>
|
15
|
+
<meta property="og:title" content="Configuration">
|
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/configuration/">
|
19
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/configuration/">
|
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": "Configuration",
|
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/configuration/"
|
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/configuration.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
283
|
+
</div>
|
284
|
+
<h1>Configuration</h1>
|
285
|
+
<p>Jekyll allows you to concoct your sites in any way you can dream up, and it’s
|
286
|
+
thanks to the powerful and flexible configuration options that this is possible.
|
287
|
+
These options can either be specified in a <code class="highlighter-rouge">_config.yml</code> file placed in your
|
288
|
+
site’s root directory, or can be specified as flags for the <code class="highlighter-rouge">jekyll</code> executable
|
289
|
+
in the terminal.</p>
|
290
|
+
|
291
|
+
<h2 id="configuration-settings">Configuration Settings</h2>
|
292
|
+
|
293
|
+
<h3 id="global-configuration">Global Configuration</h3>
|
294
|
+
|
295
|
+
<p>The table below lists the available settings for Jekyll, and the various <code class="option">options</code> (specified in the configuration file) and <code class="flag">flags</code> (specified on the command-line) that control them.</p>
|
296
|
+
|
297
|
+
<div class="mobile-side-scroller">
|
298
|
+
<table>
|
299
|
+
<thead>
|
300
|
+
<tr>
|
301
|
+
<th>Setting</th>
|
302
|
+
<th>
|
303
|
+
<span class="option">Options</span> and <span class="flag">Flags</span>
|
304
|
+
</th>
|
305
|
+
</tr>
|
306
|
+
</thead>
|
307
|
+
<tbody>
|
308
|
+
<tr class="setting">
|
309
|
+
<td>
|
310
|
+
<p class="name"><strong>Site Source</strong></p>
|
311
|
+
<p class="description">Change the directory where Jekyll will read files</p>
|
312
|
+
</td>
|
313
|
+
<td class="align-center">
|
314
|
+
<p><code class="option">source: DIR</code></p>
|
315
|
+
<p><code class="flag">-s, --source DIR</code></p>
|
316
|
+
</td>
|
317
|
+
</tr>
|
318
|
+
<tr class="setting">
|
319
|
+
<td>
|
320
|
+
<p class="name"><strong>Site Destination</strong></p>
|
321
|
+
<p class="description">Change the directory where Jekyll will write files</p>
|
322
|
+
</td>
|
323
|
+
<td class="align-center">
|
324
|
+
<p><code class="option">destination: DIR</code></p>
|
325
|
+
<p><code class="flag">-d, --destination DIR</code></p>
|
326
|
+
</td>
|
327
|
+
</tr>
|
328
|
+
<tr class="setting">
|
329
|
+
<td>
|
330
|
+
<p class="name"><strong>Safe</strong></p>
|
331
|
+
<p class="description">Disable <a href="../plugins/">custom plugins, and ignore symbolic links</a>.</p>
|
332
|
+
</td>
|
333
|
+
<td class="align-center">
|
334
|
+
<p><code class="option">safe: BOOL</code></p>
|
335
|
+
<p><code class="flag">--safe</code></p>
|
336
|
+
</td>
|
337
|
+
</tr>
|
338
|
+
<tr class="setting">
|
339
|
+
<td>
|
340
|
+
<p class="name"><strong>Exclude</strong></p>
|
341
|
+
<p class="description">
|
342
|
+
Exclude directories and/or files from the
|
343
|
+
conversion. These exclusions are relative to the site's
|
344
|
+
source directory and cannot be outside the source directory.
|
345
|
+
</p>
|
346
|
+
</td>
|
347
|
+
<td class="align-center">
|
348
|
+
<p><code class="option">exclude: [DIR, FILE, ...]</code></p>
|
349
|
+
</td>
|
350
|
+
</tr>
|
351
|
+
<tr class="setting">
|
352
|
+
<td>
|
353
|
+
<p class="name"><strong>Include</strong></p>
|
354
|
+
<p class="description">
|
355
|
+
Force inclusion of directories and/or files in the conversion.
|
356
|
+
<code>.htaccess</code> is a good example since dotfiles are excluded
|
357
|
+
by default.
|
358
|
+
</p>
|
359
|
+
</td>
|
360
|
+
<td class="align-center">
|
361
|
+
<p><code class="option">include: [DIR, FILE, ...]</code></p>
|
362
|
+
</td>
|
363
|
+
</tr>
|
364
|
+
<tr class="setting">
|
365
|
+
<td>
|
366
|
+
<p class="name"><strong>Keep files</strong></p>
|
367
|
+
<p class="description">
|
368
|
+
When clobbering the site destination, keep the selected files.
|
369
|
+
Useful for files that are not generated by jekyll; e.g. files or
|
370
|
+
assets that are generated by your build tool.
|
371
|
+
The paths are relative to the <code>destination</code>.
|
372
|
+
</p>
|
373
|
+
</td>
|
374
|
+
<td class="align-center">
|
375
|
+
<p><code class="option">keep_files: [DIR, FILE, ...]</code></p>
|
376
|
+
</td>
|
377
|
+
</tr>
|
378
|
+
<tr class="setting">
|
379
|
+
<td>
|
380
|
+
<p class="name"><strong>Time Zone</strong></p>
|
381
|
+
<p class="description">
|
382
|
+
Set the time zone for site generation. This sets the <code>TZ</code>
|
383
|
+
environment variable, which Ruby uses to handle time and date
|
384
|
+
creation and manipulation. Any entry from the
|
385
|
+
<a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
|
386
|
+
Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
|
387
|
+
available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
|
388
|
+
here</a>. The default is the local time zone, as set by your operating system.
|
389
|
+
</p>
|
390
|
+
</td>
|
391
|
+
<td class="align-center">
|
392
|
+
<p><code class="option">timezone: TIMEZONE</code></p>
|
393
|
+
</td>
|
394
|
+
</tr>
|
395
|
+
<tr class="setting">
|
396
|
+
<td>
|
397
|
+
<p class="name"><strong>Encoding</strong></p>
|
398
|
+
<p class="description">
|
399
|
+
Set the encoding of files by name (only available for Ruby
|
400
|
+
1.9 or later).
|
401
|
+
The default value is <code>utf-8</code> starting in 2.0.0,
|
402
|
+
and <code>nil</code> before 2.0.0, which will yield the Ruby
|
403
|
+
default of <code>ASCII-8BIT</code>.
|
404
|
+
Available encodings can be shown by the
|
405
|
+
command <code>ruby -e 'puts Encoding::list.join("\n")'</code>.
|
406
|
+
</p>
|
407
|
+
</td>
|
408
|
+
<td class="align-center">
|
409
|
+
<p><code class="option">encoding: ENCODING</code></p>
|
410
|
+
</td>
|
411
|
+
</tr>
|
412
|
+
<tr>
|
413
|
+
<td>
|
414
|
+
<p class="name"><strong>Defaults</strong></p>
|
415
|
+
<p class="description">
|
416
|
+
Set defaults for <a href="../frontmatter/" title="YAML Front Matter">YAML Front Matter</a>
|
417
|
+
variables.
|
418
|
+
</p>
|
419
|
+
</td>
|
420
|
+
<td class="align-center">
|
421
|
+
<p>see <a href="#front-matter-defaults" title="details">below</a></p>
|
422
|
+
</td>
|
423
|
+
</tr>
|
424
|
+
</tbody>
|
425
|
+
</table>
|
426
|
+
</div>
|
427
|
+
|
428
|
+
<div class="note warning">
|
429
|
+
<h5>Destination folders are cleaned on site builds</h5>
|
430
|
+
<p>
|
431
|
+
The contents of <code><destination></code> are automatically
|
432
|
+
cleaned, by default, when the site is built. Files or folders that are not
|
433
|
+
created by your site will be removed. Some files could be retained
|
434
|
+
by specifying them within the <code><keep_files></code> configuration directive.
|
435
|
+
</p>
|
436
|
+
<p>
|
437
|
+
Do not use an important location for <code><destination></code>; instead, use it as
|
438
|
+
a staging area and copy files from there to your web server.
|
439
|
+
</p>
|
440
|
+
</div>
|
441
|
+
|
442
|
+
<h3 id="build-command-options">Build Command Options</h3>
|
443
|
+
|
444
|
+
<div class="mobile-side-scroller">
|
445
|
+
<table>
|
446
|
+
<thead>
|
447
|
+
<tr>
|
448
|
+
<th>Setting</th>
|
449
|
+
<th>
|
450
|
+
<span class="option">Options</span> and <span class="flag">Flags</span>
|
451
|
+
</th>
|
452
|
+
</tr>
|
453
|
+
</thead>
|
454
|
+
<tbody>
|
455
|
+
<tr class="setting">
|
456
|
+
<td>
|
457
|
+
<p class="name"><strong>Regeneration</strong></p>
|
458
|
+
<p class="description">Enable auto-regeneration of the site when files are modified.</p>
|
459
|
+
</td>
|
460
|
+
<td class="align-center">
|
461
|
+
<p><code class="flag">-w, --[no-]watch</code></p>
|
462
|
+
</td>
|
463
|
+
</tr>
|
464
|
+
<tr class="setting">
|
465
|
+
<td>
|
466
|
+
<p class="name"><strong>Configuration</strong></p>
|
467
|
+
<p class="description">Specify config files instead of using <code>_config.yml</code> automatically. Settings in later files override settings in earlier files.</p>
|
468
|
+
</td>
|
469
|
+
<td class="align-center">
|
470
|
+
<p><code class="flag">--config FILE1[,FILE2,...]</code></p>
|
471
|
+
</td>
|
472
|
+
</tr>
|
473
|
+
<tr class="setting">
|
474
|
+
<td>
|
475
|
+
<p class="name"><strong>Drafts</strong></p>
|
476
|
+
<p class="description">Process and render draft posts.</p>
|
477
|
+
</td>
|
478
|
+
<td class="align-center">
|
479
|
+
<p><code class="option">show_drafts: BOOL</code></p>
|
480
|
+
<p><code class="flag">--drafts</code></p>
|
481
|
+
</td>
|
482
|
+
</tr>
|
483
|
+
<tr class="setting">
|
484
|
+
<td>
|
485
|
+
<p class="name"><strong>Environment</strong></p>
|
486
|
+
<p class="description">Use a specific environment value in the build.</p>
|
487
|
+
</td>
|
488
|
+
<td class="align-center">
|
489
|
+
<p><code class="flag">JEKYLL_ENV=production</code></p>
|
490
|
+
</td>
|
491
|
+
</tr>
|
492
|
+
<tr class="setting">
|
493
|
+
<td>
|
494
|
+
<p class="name"><strong>Future</strong></p>
|
495
|
+
<p class="description">Publish posts or collection documents with a future date.</p>
|
496
|
+
</td>
|
497
|
+
<td class="align-center">
|
498
|
+
<p><code class="option">future: BOOL</code></p>
|
499
|
+
<p><code class="flag">--future</code></p>
|
500
|
+
</td>
|
501
|
+
</tr>
|
502
|
+
<tr class="setting">
|
503
|
+
<td>
|
504
|
+
<p class="name"><strong>LSI</strong></p>
|
505
|
+
<p class="description">Produce an index for related posts.</p>
|
506
|
+
</td>
|
507
|
+
<td class="align-center">
|
508
|
+
<p><code class="option">lsi: BOOL</code></p>
|
509
|
+
<p><code class="flag">--lsi</code></p>
|
510
|
+
</td>
|
511
|
+
</tr>
|
512
|
+
<tr class="setting">
|
513
|
+
<td>
|
514
|
+
<p class="name"><strong>Limit Posts</strong></p>
|
515
|
+
<p class="description">Limit the number of posts to parse and publish.</p>
|
516
|
+
</td>
|
517
|
+
<td class="align-center">
|
518
|
+
<p><code class="option">limit_posts: NUM</code></p>
|
519
|
+
<p><code class="flag">--limit_posts NUM</code></p>
|
520
|
+
</td>
|
521
|
+
</tr>
|
522
|
+
<tr class="setting">
|
523
|
+
<td>
|
524
|
+
<p class="name"><strong>Force polling</strong></p>
|
525
|
+
<p class="description">Force watch to use polling.</p>
|
526
|
+
</td>
|
527
|
+
<td class="align-center">
|
528
|
+
<p><code class="flag">--force_polling</code></p>
|
529
|
+
</td>
|
530
|
+
</tr>
|
531
|
+
<tr class="setting">
|
532
|
+
<td>
|
533
|
+
<p class="name"><strong>Verbose output</strong></p>
|
534
|
+
<p class="description">Print verbose output.</p>
|
535
|
+
</td>
|
536
|
+
<td class="align-center">
|
537
|
+
<p><code class="flag">-V, --verbose</code></p>
|
538
|
+
</td>
|
539
|
+
</tr>
|
540
|
+
<tr class="setting">
|
541
|
+
<td>
|
542
|
+
<p class="name"><strong>Silence Output</strong></p>
|
543
|
+
<p class="description">Silence the normal output from Jekyll
|
544
|
+
during a build</p>
|
545
|
+
</td>
|
546
|
+
<td class="align-center">
|
547
|
+
<p><code class="flag">-q, --quiet</code></p>
|
548
|
+
</td>
|
549
|
+
</tr>
|
550
|
+
<tr class="setting">
|
551
|
+
<td>
|
552
|
+
<p class="name"><strong>Incremental build</strong></p>
|
553
|
+
<p class="description">
|
554
|
+
Enable the experimental incremental build feature. Incremental build only
|
555
|
+
re-builds posts and pages that have changed, resulting in significant performance
|
556
|
+
improvements for large sites, but may also break site generation in certain
|
557
|
+
cases.
|
558
|
+
</p>
|
559
|
+
</td>
|
560
|
+
<td class="align-center">
|
561
|
+
<p><code class="option">incremental: BOOL</code></p>
|
562
|
+
<p><code class="flag">-I, --incremental</code></p>
|
563
|
+
</td>
|
564
|
+
</tr>
|
565
|
+
</tbody>
|
566
|
+
</table>
|
567
|
+
</div>
|
568
|
+
|
569
|
+
<h3 id="serve-command-options">Serve Command Options</h3>
|
570
|
+
|
571
|
+
<p>In addition to the options below, the <code class="highlighter-rouge">serve</code> sub-command can accept any of the options
|
572
|
+
for the <code class="highlighter-rouge">build</code> sub-command, which are then applied to the site build which occurs right
|
573
|
+
before your site is served.</p>
|
574
|
+
|
575
|
+
<div class="mobile-side-scroller">
|
576
|
+
<table>
|
577
|
+
<thead>
|
578
|
+
<tr>
|
579
|
+
<th>Setting</th>
|
580
|
+
<th>
|
581
|
+
<span class="option">Options</span> and <span class="flag">Flags</span>
|
582
|
+
</th>
|
583
|
+
</tr>
|
584
|
+
</thead>
|
585
|
+
<tbody>
|
586
|
+
<tr class="setting">
|
587
|
+
<td>
|
588
|
+
<p class="name"><strong>Local Server Port</strong></p>
|
589
|
+
<p class="description">Listen on the given port.</p>
|
590
|
+
</td>
|
591
|
+
<td class="align-center">
|
592
|
+
<p><code class="option">port: PORT</code></p>
|
593
|
+
<p><code class="flag">--port PORT</code></p>
|
594
|
+
</td>
|
595
|
+
</tr>
|
596
|
+
<tr class="setting">
|
597
|
+
<td>
|
598
|
+
<p class="name"><strong>Local Server Hostname</strong></p>
|
599
|
+
<p class="description">Listen at the given hostname.</p>
|
600
|
+
</td>
|
601
|
+
<td class="align-center">
|
602
|
+
<p><code class="option">host: HOSTNAME</code></p>
|
603
|
+
<p><code class="flag">--host HOSTNAME</code></p>
|
604
|
+
</td>
|
605
|
+
</tr>
|
606
|
+
<tr class="setting">
|
607
|
+
<td>
|
608
|
+
<p class="name"><strong>Base URL</strong></p>
|
609
|
+
<p class="description">Serve the website from the given base URL</p>
|
610
|
+
</td>
|
611
|
+
<td class="align-center">
|
612
|
+
<p><code class="option">baseurl: URL</code></p>
|
613
|
+
<p><code class="flag">--baseurl URL</code></p>
|
614
|
+
</td>
|
615
|
+
</tr>
|
616
|
+
<tr class="setting">
|
617
|
+
<td>
|
618
|
+
<p class="name"><strong>Detach</strong></p>
|
619
|
+
<p class="description">Detach the server from the terminal</p>
|
620
|
+
</td>
|
621
|
+
<td class="align-center">
|
622
|
+
<p><code class="option">detach: BOOL</code></p>
|
623
|
+
<p><code class="flag">-B, --detach</code></p>
|
624
|
+
</td>
|
625
|
+
</tr>
|
626
|
+
<tr class="setting">
|
627
|
+
<td>
|
628
|
+
<p class="name"><strong>Skips the initial site build.</strong></p>
|
629
|
+
<p class="description">Skips the initial site build which occurs before the server is started.</p>
|
630
|
+
</td>
|
631
|
+
<td class="align-center">
|
632
|
+
<p><code class="flag">--skip-initial-build</code></p>
|
633
|
+
</td>
|
634
|
+
</tr>
|
635
|
+
<tr class="setting">
|
636
|
+
<td>
|
637
|
+
<p class="name"><strong>X.509 (SSL) Private Key</strong></p>
|
638
|
+
<p class="description">SSL Private Key.</p>
|
639
|
+
</td>
|
640
|
+
<td class="align-center">
|
641
|
+
<p><code class="flag">--ssl-key</code></p>
|
642
|
+
</td>
|
643
|
+
</tr>
|
644
|
+
<tr class="setting">
|
645
|
+
<td>
|
646
|
+
<p class="name"><strong>X.509 (SSL) Certificate</strong></p>
|
647
|
+
<p class="description">SSL Public certificate.</p>
|
648
|
+
</td>
|
649
|
+
<td class="align-center">
|
650
|
+
<p><code class="flag">--ssl-cert</code></p>
|
651
|
+
</td>
|
652
|
+
</tr>
|
653
|
+
</tbody>
|
654
|
+
</table>
|
655
|
+
</div>
|
656
|
+
|
657
|
+
<div class="note warning">
|
658
|
+
<h5>Do not use tabs in configuration files</h5>
|
659
|
+
<p>
|
660
|
+
This will either lead to parsing errors, or Jekyll will revert to the
|
661
|
+
default settings. Use spaces instead.
|
662
|
+
</p>
|
663
|
+
</div>
|
664
|
+
|
665
|
+
<h2 id="custom-webrick-headers">Custom WEBrick Headers</h2>
|
666
|
+
|
667
|
+
<p>You can provide custom headers for your site by adding them to <code class="highlighter-rouge">_config.yml</code></p>
|
668
|
+
|
669
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="c1"># File: _config.yml</span>
|
670
|
+
<span class="s">webrick</span><span class="pi">:</span>
|
671
|
+
<span class="s">headers</span><span class="pi">:</span>
|
672
|
+
<span class="s">My-Header</span><span class="pi">:</span> <span class="s">My-Value</span>
|
673
|
+
<span class="s">My-Other-Header</span><span class="pi">:</span> <span class="s">My-Other-Value</span></code></pre></figure>
|
674
|
+
|
675
|
+
<h3 id="defaults">Defaults</h3>
|
676
|
+
|
677
|
+
<p>We provide by default <code class="highlighter-rouge">Content-Type</code> and <code class="highlighter-rouge">Cache-Control</code> response headers: one
|
678
|
+
dynamic in order to specify the nature of the data being served, the other
|
679
|
+
static in order to disable caching so that you don’t have to fight with Chrome’s
|
680
|
+
aggressive caching when you are in development mode.</p>
|
681
|
+
|
682
|
+
<h2 id="specifying-a-jekyll-environment-at-build-time">Specifying a Jekyll environment at build time</h2>
|
683
|
+
|
684
|
+
<p>In the build (or serve) arguments, you can specify a Jekyll environment and value. The build will then apply this value in any conditional statements in your content.</p>
|
685
|
+
|
686
|
+
<p>For example, suppose you set this conditional statement in your code:</p>
|
687
|
+
|
688
|
+
<figure class="highlight"><pre><code class="language-liquid" data-lang="liquid"><span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">jekyll</span><span class="p">.</span><span class="nv">environment</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"production"</span><span class="w"> </span><span class="p">%}</span>
|
689
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span><span class="na">disqus</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="p">%}</span>
|
690
|
+
<span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span></code></pre></figure>
|
691
|
+
|
692
|
+
<p>When you build your Jekyll site, the content inside the <code class="highlighter-rouge">if</code> statement won’t be run unless you also specify a <code class="highlighter-rouge">production</code> environment in the build command, like this:</p>
|
693
|
+
|
694
|
+
<figure class="highlight"><pre><code class="language-sh" data-lang="sh"><span class="nv">JEKYLL_ENV</span><span class="o">=</span>production jekyll build</code></pre></figure>
|
695
|
+
|
696
|
+
<p>Specifying an environment value allows you to make certain content available only within specific environments.</p>
|
697
|
+
|
698
|
+
<p>The default value for <code class="highlighter-rouge">JEKYLL_ENV</code> is <code class="highlighter-rouge">development</code>. Therefore if you omit <code class="highlighter-rouge">JEKYLL_ENV</code> from the build arguments, the default value will be <code class="highlighter-rouge">JEKYLL_ENV=development</code>. Any content inside <code class="highlighter-rouge"><span class="p">{</span><span class="err">%</span><span class="w"> </span><span class="err">if</span><span class="w"> </span><span class="err">jekyll.environment</span><span class="w"> </span><span class="err">==</span><span class="w"> </span><span class="nt">"development"</span><span class="w"> </span><span class="err">%}</span></code> tags will automatically appear in the build.</p>
|
699
|
+
|
700
|
+
<p>Your environment values can be anything you want (not just <code class="highlighter-rouge">development</code> or <code class="highlighter-rouge">production</code>). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an “Edit me in GitHub” button in a development environment but not include it in production environments.</p>
|
701
|
+
|
702
|
+
<p>By specifying the option in the build command, you avoid having to change values in your configuration files when moving from one environment to another.</p>
|
703
|
+
|
704
|
+
<h2 id="front-matter-defaults">Front Matter defaults</h2>
|
705
|
+
|
706
|
+
<p>Using <a href="../frontmatter/">YAML Front Matter</a> is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.</p>
|
707
|
+
|
708
|
+
<p>Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.</p>
|
709
|
+
|
710
|
+
<p>Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the <code class="highlighter-rouge">defaults</code> key in the <code class="highlighter-rouge">_config.yml</code> file in your project’s root directory.</p>
|
711
|
+
|
712
|
+
<p>The <code class="highlighter-rouge">defaults</code> key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.</p>
|
713
|
+
|
714
|
+
<p>Let’s say that you want to add a default layout to all pages and posts in your site. You would add this to your <code class="highlighter-rouge">_config.yml</code> file:</p>
|
715
|
+
|
716
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">defaults</span><span class="pi">:</span>
|
717
|
+
<span class="pi">-</span>
|
718
|
+
<span class="s">scope</span><span class="pi">:</span>
|
719
|
+
<span class="s">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># an empty string here means all files in the project</span>
|
720
|
+
<span class="s">values</span><span class="pi">:</span>
|
721
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span></code></pre></figure>
|
722
|
+
|
723
|
+
<div class="note info">
|
724
|
+
<h5>Please stop and rerun `jekyll serve` command.</h5>
|
725
|
+
<p>
|
726
|
+
The <code>_config.yml</code> master configuration file contains global configurations
|
727
|
+
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
|
728
|
+
during automatic regeneration are not loaded until the next execution.
|
729
|
+
</p>
|
730
|
+
<p>
|
731
|
+
Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
|
732
|
+
</p>
|
733
|
+
</div>
|
734
|
+
|
735
|
+
<p>Here, we are scoping the <code class="highlighter-rouge">values</code> to any file that exists in the path <code class="highlighter-rouge">scope</code>. Since the path is set as an empty string, it will apply to <strong>all files</strong> in your project. You probably don’t want to set a layout on every file in your project - like css files, for example - so you can also specify a <code class="highlighter-rouge">type</code> value under the <code class="highlighter-rouge">scope</code> key.</p>
|
736
|
+
|
737
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">defaults</span><span class="pi">:</span>
|
738
|
+
<span class="pi">-</span>
|
739
|
+
<span class="s">scope</span><span class="pi">:</span>
|
740
|
+
<span class="s">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># an empty string here means all files in the project</span>
|
741
|
+
<span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">posts"</span> <span class="c1"># previously `post` in Jekyll 2.2.</span>
|
742
|
+
<span class="s">values</span><span class="pi">:</span>
|
743
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span></code></pre></figure>
|
744
|
+
|
745
|
+
<p>Now, this will only set the layout for files where the type is <code class="highlighter-rouge">posts</code>.
|
746
|
+
The different types that are available to you are <code class="highlighter-rouge">pages</code>, <code class="highlighter-rouge">posts</code>, <code class="highlighter-rouge">drafts</code> or any collection in your site. While <code class="highlighter-rouge">type</code> is optional, you must specify a value for <code class="highlighter-rouge">path</code> when creating a <code class="highlighter-rouge">scope/values</code> pair.</p>
|
747
|
+
|
748
|
+
<p>As mentioned earlier, you can set multiple scope/values pairs for <code class="highlighter-rouge">defaults</code>.</p>
|
749
|
+
|
750
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">defaults</span><span class="pi">:</span>
|
751
|
+
<span class="pi">-</span>
|
752
|
+
<span class="s">scope</span><span class="pi">:</span>
|
753
|
+
<span class="s">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
754
|
+
<span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">posts"</span>
|
755
|
+
<span class="s">values</span><span class="pi">:</span>
|
756
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my-site"</span>
|
757
|
+
<span class="pi">-</span>
|
758
|
+
<span class="s">scope</span><span class="pi">:</span>
|
759
|
+
<span class="s">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
|
760
|
+
<span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span> <span class="c1"># previously `page` in Jekyll 2.2.</span>
|
761
|
+
<span class="s">values</span><span class="pi">:</span>
|
762
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span> <span class="c1"># overrides previous default layout</span>
|
763
|
+
<span class="s">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span></code></pre></figure>
|
764
|
+
|
765
|
+
<p>With these defaults, all posts would use the <code class="highlighter-rouge">my-site</code> layout. Any html files that exist in the <code class="highlighter-rouge">projects/</code> folder will use the <code class="highlighter-rouge">project</code> layout, if it exists. Those files will also have the <code class="highlighter-rouge">page.author</code> <a href="../variables/">liquid variable</a> set to <code class="highlighter-rouge">Mr. Hyde</code>.</p>
|
766
|
+
|
767
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">collections</span><span class="pi">:</span>
|
768
|
+
<span class="pi">-</span> <span class="s">my_collection</span><span class="pi">:</span>
|
769
|
+
<span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
|
770
|
+
|
771
|
+
<span class="s">defaults</span><span class="pi">:</span>
|
772
|
+
<span class="pi">-</span>
|
773
|
+
<span class="s">scope</span><span class="pi">:</span>
|
774
|
+
<span class="s">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
775
|
+
<span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my_collection"</span> <span class="c1"># a collection in your site, in plural form</span>
|
776
|
+
<span class="s">values</span><span class="pi">:</span>
|
777
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span></code></pre></figure>
|
778
|
+
|
779
|
+
<p>In this example, the <code class="highlighter-rouge">layout</code> is set to <code class="highlighter-rouge">default</code> inside the
|
780
|
+
<a href="../collections/">collection</a> with the name <code class="highlighter-rouge">my_collection</code>.</p>
|
781
|
+
|
782
|
+
<h3 id="precedence">Precedence</h3>
|
783
|
+
|
784
|
+
<p>Jekyll will apply all of the configuration settings you specify in the <code class="highlighter-rouge">defaults</code> section of your <code class="highlighter-rouge">_config.yml</code> file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.</p>
|
785
|
+
|
786
|
+
<p>You can see that in the second to last example above. First, we set the default layout to <code class="highlighter-rouge">my-site</code>. Then, using a more specific path, we set the default layout for files in the <code class="highlighter-rouge">projects/</code> path to <code class="highlighter-rouge">project</code>. This can be done with any value that you would set in the page or post front matter.</p>
|
787
|
+
|
788
|
+
<p>Finally, if you set defaults in the site configuration by adding a <code class="highlighter-rouge">defaults</code> section to your <code class="highlighter-rouge">_config.yml</code> file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:</p>
|
789
|
+
|
790
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="c1"># In _config.yml</span>
|
791
|
+
<span class="nn">...</span>
|
792
|
+
<span class="s">defaults</span><span class="pi">:</span>
|
793
|
+
<span class="pi">-</span>
|
794
|
+
<span class="s">scope</span><span class="pi">:</span>
|
795
|
+
<span class="s">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
|
796
|
+
<span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
|
797
|
+
<span class="s">values</span><span class="pi">:</span>
|
798
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
|
799
|
+
<span class="s">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span>
|
800
|
+
<span class="s">category</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
|
801
|
+
<span class="nn">...</span></code></pre></figure>
|
802
|
+
|
803
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="c1"># In projects/foo_project.md</span>
|
804
|
+
<span class="nn">---</span>
|
805
|
+
<span class="s">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">John</span><span class="nv"> </span><span class="s">Smith"</span>
|
806
|
+
<span class="s">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">foobar"</span>
|
807
|
+
<span class="nn">---</span>
|
808
|
+
<span class="s">The post text goes here...</span></code></pre></figure>
|
809
|
+
|
810
|
+
<p>The <code class="highlighter-rouge">projects/foo_project.md</code> would have the <code class="highlighter-rouge">layout</code> set to <code class="highlighter-rouge">foobar</code> instead
|
811
|
+
of <code class="highlighter-rouge">project</code> and the <code class="highlighter-rouge">author</code> set to <code class="highlighter-rouge">John Smith</code> instead of <code class="highlighter-rouge">Mr. Hyde</code> when
|
812
|
+
the site is built.</p>
|
813
|
+
|
814
|
+
<h2 id="default-configuration">Default Configuration</h2>
|
815
|
+
|
816
|
+
<p>Jekyll runs with the following configuration options by default. Alternative
|
817
|
+
settings for these options can be explicitly specified in the configuration
|
818
|
+
file or on the command-line.</p>
|
819
|
+
|
820
|
+
<div class="note warning">
|
821
|
+
<h5>There are two unsupported kramdown options</h5>
|
822
|
+
<p>
|
823
|
+
Please note that both <code>remove_block_html_tags</code> and
|
824
|
+
<code>remove_span_html_tags</code> are currently unsupported in Jekyll due
|
825
|
+
to the fact that they are not included within the kramdown HTML converter.
|
826
|
+
</p>
|
827
|
+
</div>
|
828
|
+
|
829
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="c1"># Where things are</span>
|
830
|
+
<span class="s">source</span><span class="pi">:</span> <span class="s">.</span>
|
831
|
+
<span class="s">destination</span><span class="pi">:</span> <span class="s">./_site</span>
|
832
|
+
<span class="s">plugins_dir</span><span class="pi">:</span> <span class="s">_plugins</span>
|
833
|
+
<span class="s">layouts_dir</span><span class="pi">:</span> <span class="s">_layouts</span>
|
834
|
+
<span class="s">data_dir</span><span class="pi">:</span> <span class="s">_data</span>
|
835
|
+
<span class="s">includes_dir</span><span class="pi">:</span> <span class="s">_includes</span>
|
836
|
+
<span class="s">collections</span><span class="pi">:</span>
|
837
|
+
<span class="s">posts</span><span class="pi">:</span>
|
838
|
+
<span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
|
839
|
+
|
840
|
+
<span class="c1"># Handling Reading</span>
|
841
|
+
<span class="s">safe</span><span class="pi">:</span> <span class="s">false</span>
|
842
|
+
<span class="s">include</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.htaccess"</span><span class="pi">]</span>
|
843
|
+
<span class="s">exclude</span><span class="pi">:</span> <span class="pi">[]</span>
|
844
|
+
<span class="s">keep_files</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.git"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">.svn"</span><span class="pi">]</span>
|
845
|
+
<span class="s">encoding</span><span class="pi">:</span> <span class="s2">"</span><span class="s">utf-8"</span>
|
846
|
+
<span class="s">markdown_ext</span><span class="pi">:</span> <span class="s2">"</span><span class="s">markdown,mkdown,mkdn,mkd,md"</span>
|
847
|
+
|
848
|
+
<span class="c1"># Filtering Content</span>
|
849
|
+
<span class="s">show_drafts</span><span class="pi">:</span> <span class="s">null</span>
|
850
|
+
<span class="s">limit_posts</span><span class="pi">:</span> <span class="s">0</span>
|
851
|
+
<span class="s">future</span><span class="pi">:</span> <span class="s">false</span>
|
852
|
+
<span class="s">unpublished</span><span class="pi">:</span> <span class="s">false</span>
|
853
|
+
|
854
|
+
<span class="c1"># Plugins</span>
|
855
|
+
<span class="s">whitelist</span><span class="pi">:</span> <span class="pi">[]</span>
|
856
|
+
<span class="s">gems</span><span class="pi">:</span> <span class="pi">[]</span>
|
857
|
+
|
858
|
+
<span class="c1"># Conversion</span>
|
859
|
+
<span class="s">markdown</span><span class="pi">:</span> <span class="s">kramdown</span>
|
860
|
+
<span class="s">highlighter</span><span class="pi">:</span> <span class="s">rouge</span>
|
861
|
+
<span class="s">lsi</span><span class="pi">:</span> <span class="s">false</span>
|
862
|
+
<span class="s">excerpt_separator</span><span class="pi">:</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s">"</span>
|
863
|
+
<span class="s">incremental</span><span class="pi">:</span> <span class="s">false</span>
|
864
|
+
|
865
|
+
<span class="c1"># Serving</span>
|
866
|
+
<span class="s">detach</span><span class="pi">:</span> <span class="s">false</span>
|
867
|
+
<span class="s">port</span><span class="pi">:</span> <span class="s">4000</span>
|
868
|
+
<span class="s">host</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
|
869
|
+
<span class="s">baseurl</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># does not include hostname</span>
|
870
|
+
<span class="s">show_dir_listing</span><span class="pi">:</span> <span class="s">false</span>
|
871
|
+
|
872
|
+
<span class="c1"># Outputting</span>
|
873
|
+
<span class="s">permalink</span><span class="pi">:</span> <span class="s">date</span>
|
874
|
+
<span class="s">paginate_path</span><span class="pi">:</span> <span class="s">/page:num</span>
|
875
|
+
<span class="s">timezone</span><span class="pi">:</span> <span class="s">null</span>
|
876
|
+
|
877
|
+
<span class="s">quiet</span><span class="pi">:</span> <span class="s">false</span>
|
878
|
+
<span class="s">verbose</span><span class="pi">:</span> <span class="s">false</span>
|
879
|
+
<span class="s">defaults</span><span class="pi">:</span> <span class="pi">[]</span>
|
880
|
+
|
881
|
+
<span class="s">liquid</span><span class="pi">:</span>
|
882
|
+
<span class="s">error_mode</span><span class="pi">:</span> <span class="s">warn</span>
|
883
|
+
|
884
|
+
<span class="c1"># Markdown Processors</span>
|
885
|
+
<span class="s">rdiscount</span><span class="pi">:</span>
|
886
|
+
<span class="s">extensions</span><span class="pi">:</span> <span class="pi">[]</span>
|
887
|
+
|
888
|
+
<span class="s">redcarpet</span><span class="pi">:</span>
|
889
|
+
<span class="s">extensions</span><span class="pi">:</span> <span class="pi">[]</span>
|
890
|
+
|
891
|
+
<span class="s">kramdown</span><span class="pi">:</span>
|
892
|
+
<span class="s">auto_ids</span><span class="pi">:</span> <span class="s">true</span>
|
893
|
+
<span class="s">footnote_nr</span><span class="pi">:</span> <span class="s">1</span>
|
894
|
+
<span class="s">entity_output</span><span class="pi">:</span> <span class="s">as_char</span>
|
895
|
+
<span class="s">toc_levels</span><span class="pi">:</span> <span class="s">1..6</span>
|
896
|
+
<span class="s">smart_quotes</span><span class="pi">:</span> <span class="s">lsquo,rsquo,ldquo,rdquo</span>
|
897
|
+
<span class="s">input</span><span class="pi">:</span> <span class="s">GFM</span>
|
898
|
+
<span class="s">hard_wrap</span><span class="pi">:</span> <span class="s">false</span>
|
899
|
+
<span class="s">footnote_nr</span><span class="pi">:</span> <span class="s">1</span></code></pre></figure>
|
900
|
+
|
901
|
+
<h2 id="liquid-options">Liquid Options</h2>
|
902
|
+
|
903
|
+
<p>Liquid’s response to errors can be configured by setting <code class="highlighter-rouge">error_mode</code>. The
|
904
|
+
options are</p>
|
905
|
+
|
906
|
+
<ul>
|
907
|
+
<li>
|
908
|
+
<code class="highlighter-rouge">lax</code> — Ignore all errors.</li>
|
909
|
+
<li>
|
910
|
+
<code class="highlighter-rouge">warn</code> — Output a warning on the console for each error.</li>
|
911
|
+
<li>
|
912
|
+
<code class="highlighter-rouge">strict</code> — Output an error message and stop the build.</li>
|
913
|
+
</ul>
|
914
|
+
|
915
|
+
<h2 id="markdown-options">Markdown Options</h2>
|
916
|
+
|
917
|
+
<p>The various Markdown renderers supported by Jekyll sometimes have extra options
|
918
|
+
available.</p>
|
919
|
+
|
920
|
+
<h3 id="redcarpet">Redcarpet</h3>
|
921
|
+
|
922
|
+
<p>Redcarpet can be configured by providing an <code class="highlighter-rouge">extensions</code> sub-setting, whose
|
923
|
+
value should be an array of strings. Each string should be the name of one of
|
924
|
+
the <code class="highlighter-rouge">Redcarpet::Markdown</code> class’s extensions; if present in the array, it will
|
925
|
+
set the corresponding extension to <code class="highlighter-rouge">true</code>.</p>
|
926
|
+
|
927
|
+
<p>Jekyll handles two special Redcarpet extensions:</p>
|
928
|
+
|
929
|
+
<ul>
|
930
|
+
<li>
|
931
|
+
<code class="highlighter-rouge">no_fenced_code_blocks</code> — By default, Jekyll sets the <code class="highlighter-rouge">fenced_code_blocks</code>
|
932
|
+
extension (for delimiting code blocks with triple tildes or triple backticks)
|
933
|
+
to <code class="highlighter-rouge">true</code>, probably because GitHub’s eager adoption of them is starting to make
|
934
|
+
them inescapable. Redcarpet’s normal <code class="highlighter-rouge">fenced_code_blocks</code> extension is inert
|
935
|
+
when used with Jekyll; instead, you can use this inverted version of the
|
936
|
+
extension for disabling fenced code.</li>
|
937
|
+
</ul>
|
938
|
+
|
939
|
+
<p>Note that you can also specify a language for highlighting after the first
|
940
|
+
delimiter:</p>
|
941
|
+
|
942
|
+
<div class="highlighter-rouge">
|
943
|
+
<pre class="highlight"><code> ```ruby
|
944
|
+
# ...ruby code
|
945
|
+
```
|
946
|
+
</code></pre>
|
947
|
+
</div>
|
948
|
+
|
949
|
+
<p>With both fenced code blocks and highlighter enabled, this will statically
|
950
|
+
highlight the code; without any syntax highlighter, it will add a
|
951
|
+
<code class="highlighter-rouge">class="LANGUAGE"</code> attribute to the <code class="highlighter-rouge"><code></code> element, which can be used as a
|
952
|
+
hint by various JavaScript code highlighting libraries.</p>
|
953
|
+
|
954
|
+
<ul>
|
955
|
+
<li>
|
956
|
+
<code class="highlighter-rouge">smart</code> — This pseudo-extension turns on SmartyPants, which converts
|
957
|
+
straight quotes to curly quotes and runs of hyphens to em (<code class="highlighter-rouge">---</code>) and en (<code class="highlighter-rouge">--</code>) dashes.</li>
|
958
|
+
</ul>
|
959
|
+
|
960
|
+
<p>All other extensions retain their usual names from Redcarpet, and no renderer
|
961
|
+
options aside from <code class="highlighter-rouge">smart</code> can be specified in Jekyll. <a href="https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use">A list of available
|
962
|
+
extensions can be found in the Redcarpet README file.</a>
|
963
|
+
Make sure you’re looking at the README for the right version of
|
964
|
+
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
|
965
|
+
extensions are:</p>
|
966
|
+
|
967
|
+
<ul>
|
968
|
+
<li><code class="highlighter-rouge">tables</code></li>
|
969
|
+
<li><code class="highlighter-rouge">no_intra_emphasis</code></li>
|
970
|
+
<li><code class="highlighter-rouge">autolink</code></li>
|
971
|
+
</ul>
|
972
|
+
|
973
|
+
<h3 id="custom-markdown-processors">Custom Markdown Processors</h3>
|
974
|
+
|
975
|
+
<p>If you’re interested in creating a custom markdown processor, you’re in luck! Create a new class in the <code class="highlighter-rouge">Jekyll::Converters::Markdown</code> namespace:</p>
|
976
|
+
|
977
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">Jekyll</span><span class="o">::</span><span class="no">Converters</span><span class="o">::</span><span class="no">Markdown</span><span class="o">::</span><span class="no">MyCustomProcessor</span>
|
978
|
+
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
|
979
|
+
<span class="nb">require</span> <span class="s1">'funky_markdown'</span>
|
980
|
+
<span class="vi">@config</span> <span class="o">=</span> <span class="n">config</span>
|
981
|
+
<span class="k">rescue</span> <span class="no">LoadError</span>
|
982
|
+
<span class="no">STDERR</span><span class="p">.</span><span class="nf">puts</span> <span class="s1">'You are missing a library required for Markdown. Please run:'</span>
|
983
|
+
<span class="no">STDERR</span><span class="p">.</span><span class="nf">puts</span> <span class="s1">' $ [sudo] gem install funky_markdown'</span>
|
984
|
+
<span class="k">raise</span> <span class="no">FatalException</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"Missing dependency: funky_markdown"</span><span class="p">)</span>
|
985
|
+
<span class="k">end</span>
|
986
|
+
|
987
|
+
<span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
|
988
|
+
<span class="o">::</span><span class="no">FunkyMarkdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">content</span><span class="p">).</span><span class="nf">convert</span>
|
989
|
+
<span class="k">end</span>
|
990
|
+
<span class="k">end</span></code></pre></figure>
|
991
|
+
|
992
|
+
<p>Once you’ve created your class and have it properly set up either as a plugin
|
993
|
+
in the <code class="highlighter-rouge">_plugins</code> folder or as a gem, specify it in your <code class="highlighter-rouge">_config.yml</code>:</p>
|
994
|
+
|
995
|
+
<figure class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="s">markdown</span><span class="pi">:</span> <span class="s">MyCustomProcessor</span></code></pre></figure>
|
996
|
+
|
997
|
+
<h2 id="incremental-regeneration">Incremental Regeneration</h2>
|
998
|
+
<div class="note warning">
|
999
|
+
<h5>Incremental regeneration is still an experimental feature</h5>
|
1000
|
+
<p>
|
1001
|
+
While incremental regeneration will work for the most common cases, it will
|
1002
|
+
not work correctly in every scenario. Please be extremely cautious when
|
1003
|
+
using the feature, and report any problems not listed below by
|
1004
|
+
<a href="https://github.com/jekyll/jekyll/issues/new">opening an issue on GitHub</a>.
|
1005
|
+
</p>
|
1006
|
+
</div>
|
1007
|
+
|
1008
|
+
<p>Incremental regeneration helps shorten build times by only generating documents
|
1009
|
+
and pages that were updated since the previous build. It does this by keeping
|
1010
|
+
track of both file modification times and inter-document dependencies in the
|
1011
|
+
<code class="highlighter-rouge">.jekyll-metadata</code> file.</p>
|
1012
|
+
|
1013
|
+
<p>Under the current implementation, incremental regeneration will only generate a
|
1014
|
+
document or page if either it, or one of its dependencies, is modified. Currently,
|
1015
|
+
the only types of dependencies tracked are includes (using the
|
1016
|
+
<code class="highlighter-rouge"><span class="p">{</span><span class="err">%</span><span class="w"> </span><span class="err">include</span><span class="w"> </span><span class="err">%</span><span class="p">}</span></code> tag) and layouts. This means that plain
|
1017
|
+
references to other documents (for example, the common case of iterating over
|
1018
|
+
<code class="highlighter-rouge">site.posts</code> in a post listings page) will not be detected as a dependency.</p>
|
1019
|
+
|
1020
|
+
<p>To remedy some of these shortfalls, putting <code class="highlighter-rouge">regenerate: true</code> in the front-matter
|
1021
|
+
of a document will force Jekyll to regenerate it regardless of whether it has been
|
1022
|
+
modified. Note that this will generate the specified document only; references
|
1023
|
+
to other documents’ contents will not work since they won’t be re-rendered.</p>
|
1024
|
+
|
1025
|
+
<p>Incremental regeneration can be enabled via the <code class="highlighter-rouge">--incremental</code> flag (<code class="highlighter-rouge">-I</code> for
|
1026
|
+
short) from the command-line or by setting <code class="highlighter-rouge">incremental: true</code> in your
|
1027
|
+
configuration file.</p>
|
1028
|
+
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
1032
|
+
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
|
1045
|
+
|
1046
|
+
|
1047
|
+
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
<div class="section-nav">
|
1053
|
+
<div class="left align-right">
|
1054
|
+
|
1055
|
+
|
1056
|
+
|
1057
|
+
<a href="/docs/structure/" class="prev">Back</a>
|
1058
|
+
|
1059
|
+
</div>
|
1060
|
+
<div class="right align-left">
|
1061
|
+
|
1062
|
+
|
1063
|
+
|
1064
|
+
<a href="/docs/frontmatter/" class="next">Next</a>
|
1065
|
+
|
1066
|
+
</div>
|
1067
|
+
</div>
|
1068
|
+
<div class="clear"></div>
|
1069
|
+
|
1070
|
+
</article>
|
1071
|
+
</div>
|
1072
|
+
|
1073
|
+
<div class="unit one-fifth hide-on-mobiles">
|
1074
|
+
<aside>
|
1075
|
+
|
1076
|
+
<h4>Getting Started</h4>
|
1077
|
+
<ul>
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
<li class=""><a href="https://jekyllrb.com/docs/home/">Welcome</a></li>
|
1082
|
+
|
1083
|
+
|
1084
|
+
|
1085
|
+
<li class=""><a href="https://jekyllrb.com/docs/quickstart/">Quick-start guide</a></li>
|
1086
|
+
|
1087
|
+
|
1088
|
+
|
1089
|
+
<li class=""><a href="https://jekyllrb.com/docs/installation/">Installation</a></li>
|
1090
|
+
|
1091
|
+
|
1092
|
+
|
1093
|
+
<li class=""><a href="https://jekyllrb.com/docs/usage/">Basic Usage</a></li>
|
1094
|
+
|
1095
|
+
|
1096
|
+
|
1097
|
+
<li class=""><a href="https://jekyllrb.com/docs/structure/">Directory structure</a></li>
|
1098
|
+
|
1099
|
+
|
1100
|
+
|
1101
|
+
<li class="current"><a href="https://jekyllrb.com/docs/configuration/">Configuration</a></li>
|
1102
|
+
|
1103
|
+
</ul>
|
1104
|
+
|
1105
|
+
|
1106
|
+
<h4>Your Content</h4>
|
1107
|
+
<ul>
|
1108
|
+
|
1109
|
+
|
1110
|
+
|
1111
|
+
<li class=""><a href="https://jekyllrb.com/docs/frontmatter/">Front Matter</a></li>
|
1112
|
+
|
1113
|
+
|
1114
|
+
|
1115
|
+
<li class=""><a href="https://jekyllrb.com/docs/posts/">Writing posts</a></li>
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
<li class=""><a href="https://jekyllrb.com/docs/drafts/">Working with drafts</a></li>
|
1120
|
+
|
1121
|
+
|
1122
|
+
|
1123
|
+
<li class=""><a href="https://jekyllrb.com/docs/pages/">Creating pages</a></li>
|
1124
|
+
|
1125
|
+
|
1126
|
+
|
1127
|
+
<li class=""><a href="https://jekyllrb.com/docs/static-files/">Static Files</a></li>
|
1128
|
+
|
1129
|
+
|
1130
|
+
|
1131
|
+
<li class=""><a href="https://jekyllrb.com/docs/variables/">Variables</a></li>
|
1132
|
+
|
1133
|
+
|
1134
|
+
|
1135
|
+
<li class=""><a href="https://jekyllrb.com/docs/collections/">Collections</a></li>
|
1136
|
+
|
1137
|
+
|
1138
|
+
|
1139
|
+
<li class=""><a href="https://jekyllrb.com/docs/datafiles/">Data Files</a></li>
|
1140
|
+
|
1141
|
+
|
1142
|
+
|
1143
|
+
<li class=""><a href="https://jekyllrb.com/docs/assets/">Assets</a></li>
|
1144
|
+
|
1145
|
+
|
1146
|
+
|
1147
|
+
<li class=""><a href="https://jekyllrb.com/docs/migrations/">Blog migrations</a></li>
|
1148
|
+
|
1149
|
+
</ul>
|
1150
|
+
|
1151
|
+
|
1152
|
+
<h4>Customization</h4>
|
1153
|
+
<ul>
|
1154
|
+
|
1155
|
+
|
1156
|
+
|
1157
|
+
<li class=""><a href="https://jekyllrb.com/docs/templates/">Templates</a></li>
|
1158
|
+
|
1159
|
+
|
1160
|
+
|
1161
|
+
<li class=""><a href="https://jekyllrb.com/docs/permalinks/">Permalinks</a></li>
|
1162
|
+
|
1163
|
+
|
1164
|
+
|
1165
|
+
<li class=""><a href="https://jekyllrb.com/docs/pagination/">Pagination</a></li>
|
1166
|
+
|
1167
|
+
|
1168
|
+
|
1169
|
+
<li class=""><a href="https://jekyllrb.com/docs/plugins/">Plugins</a></li>
|
1170
|
+
|
1171
|
+
|
1172
|
+
|
1173
|
+
<li class=""><a href="https://jekyllrb.com/docs/themes/">Themes</a></li>
|
1174
|
+
|
1175
|
+
|
1176
|
+
|
1177
|
+
<li class=""><a href="https://jekyllrb.com/docs/extras/">Extras</a></li>
|
1178
|
+
|
1179
|
+
</ul>
|
1180
|
+
|
1181
|
+
|
1182
|
+
<h4>Deployment</h4>
|
1183
|
+
<ul>
|
1184
|
+
|
1185
|
+
|
1186
|
+
|
1187
|
+
<li class=""><a href="https://jekyllrb.com/docs/github-pages/">GitHub Pages</a></li>
|
1188
|
+
|
1189
|
+
|
1190
|
+
|
1191
|
+
<li class=""><a href="https://jekyllrb.com/docs/deployment-methods/">Deployment methods</a></li>
|
1192
|
+
|
1193
|
+
|
1194
|
+
|
1195
|
+
<li class=""><a href="https://jekyllrb.com/docs/continuous-integration/">Continuous Integration</a></li>
|
1196
|
+
|
1197
|
+
</ul>
|
1198
|
+
|
1199
|
+
|
1200
|
+
<h4>Miscellaneous</h4>
|
1201
|
+
<ul>
|
1202
|
+
|
1203
|
+
|
1204
|
+
|
1205
|
+
<li class=""><a href="https://jekyllrb.com/docs/troubleshooting/">Troubleshooting</a></li>
|
1206
|
+
|
1207
|
+
|
1208
|
+
|
1209
|
+
<li class=""><a href="https://jekyllrb.com/docs/sites/">Sites using Jekyll</a></li>
|
1210
|
+
|
1211
|
+
|
1212
|
+
|
1213
|
+
<li class=""><a href="https://jekyllrb.com/docs/resources/">Resources</a></li>
|
1214
|
+
|
1215
|
+
|
1216
|
+
|
1217
|
+
<li class=""><a href="https://jekyllrb.com/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
|
1218
|
+
|
1219
|
+
|
1220
|
+
|
1221
|
+
<li class=""><a href="https://jekyllrb.com/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
|
1222
|
+
|
1223
|
+
</ul>
|
1224
|
+
|
1225
|
+
|
1226
|
+
<h4>Meta</h4>
|
1227
|
+
<ul>
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
1231
|
+
<li class=""><a href="https://jekyllrb.com/docs/contributing/">Contributing</a></li>
|
1232
|
+
|
1233
|
+
|
1234
|
+
|
1235
|
+
<li class=""><a href="https://jekyllrb.com/docs/conduct/">Code of Conduct</a></li>
|
1236
|
+
|
1237
|
+
|
1238
|
+
|
1239
|
+
<li class=""><a href="https://jekyllrb.com/docs/history/">History</a></li>
|
1240
|
+
|
1241
|
+
</ul>
|
1242
|
+
|
1243
|
+
|
1244
|
+
</aside>
|
1245
|
+
</div>
|
1246
|
+
|
1247
|
+
|
1248
|
+
<div class="clear"></div>
|
1249
|
+
|
1250
|
+
</div>
|
1251
|
+
</section>
|
1252
|
+
|
1253
|
+
|
1254
|
+
<footer>
|
1255
|
+
<div class="grid">
|
1256
|
+
<div class="unit one-third center-on-mobiles">
|
1257
|
+
<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>
|
1258
|
+
</div>
|
1259
|
+
<div class="unit two-thirds align-right center-on-mobiles">
|
1260
|
+
<p>
|
1261
|
+
Proudly hosted by
|
1262
|
+
<a href="https://github.com">
|
1263
|
+
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
1264
|
+
</a>
|
1265
|
+
</p>
|
1266
|
+
</div>
|
1267
|
+
</div>
|
1268
|
+
</footer>
|
1269
|
+
|
1270
|
+
<script>
|
1271
|
+
var anchorForId = function (id) {
|
1272
|
+
var anchor = document.createElement("a");
|
1273
|
+
anchor.className = "header-link";
|
1274
|
+
anchor.href = "#" + id;
|
1275
|
+
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
1276
|
+
anchor.title = "Permalink";
|
1277
|
+
return anchor;
|
1278
|
+
};
|
1279
|
+
|
1280
|
+
var linkifyAnchors = function (level, containingElement) {
|
1281
|
+
var headers = containingElement.getElementsByTagName("h" + level);
|
1282
|
+
for (var h = 0; h < headers.length; h++) {
|
1283
|
+
var header = headers[h];
|
1284
|
+
|
1285
|
+
if (typeof header.id !== "undefined" && header.id !== "") {
|
1286
|
+
header.appendChild(anchorForId(header.id));
|
1287
|
+
}
|
1288
|
+
}
|
1289
|
+
};
|
1290
|
+
|
1291
|
+
document.onreadystatechange = function () {
|
1292
|
+
if (this.readyState === "complete") {
|
1293
|
+
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
1294
|
+
if (!contentBlock) {
|
1295
|
+
return;
|
1296
|
+
}
|
1297
|
+
for (var level = 1; level <= 6; level++) {
|
1298
|
+
linkifyAnchors(level, contentBlock);
|
1299
|
+
}
|
1300
|
+
}
|
1301
|
+
};
|
1302
|
+
</script>
|
1303
|
+
|
1304
|
+
|
1305
|
+
<!-- Gauges (http://gaug.es/) -->
|
1306
|
+
<script>
|
1307
|
+
var _gauges = _gauges || [];
|
1308
|
+
(function() {
|
1309
|
+
var t = document.createElement('script');
|
1310
|
+
t.type = 'text/javascript';
|
1311
|
+
t.async = true;
|
1312
|
+
t.id = 'gauges-tracker';
|
1313
|
+
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
1314
|
+
t.src = '//secure.gaug.es/track.js';
|
1315
|
+
var s = document.getElementsByTagName('script')[0];
|
1316
|
+
s.parentNode.insertBefore(t, s);
|
1317
|
+
})();
|
1318
|
+
</script>
|
1319
|
+
|
1320
|
+
|
1321
|
+
|
1322
|
+
<!-- Google Analytics (http://google.com/analytics) -->
|
1323
|
+
<script>
|
1324
|
+
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
1325
|
+
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
1326
|
+
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
1327
|
+
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
1328
|
+
|
1329
|
+
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
1330
|
+
ga('send', 'pageview');
|
1331
|
+
|
1332
|
+
</script>
|
1333
|
+
|
1334
|
+
|
1335
|
+
|
1336
|
+
</body>
|
1337
|
+
</html>
|