jekyll-docs 3.3.1 → 3.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/site/404.html +3 -3
- data/site/community/index.html +5 -5
- data/site/css/screen.css +7 -6
- data/site/docs/assets/index.html +13 -5
- data/site/docs/collections/index.html +132 -29
- data/site/docs/conduct/index.html +16 -5
- data/site/docs/configuration/index.html +26 -8
- data/site/docs/continuous-integration/circleci/index.html +761 -0
- data/site/docs/continuous-integration/index.html +25 -245
- data/site/docs/continuous-integration/travis-ci/index.html +916 -0
- data/site/docs/contributing/index.html +41 -5
- data/site/docs/datafiles/index.html +14 -6
- data/site/docs/deployment-methods/index.html +17 -7
- data/site/docs/drafts/index.html +13 -5
- data/site/docs/extras/index.html +17 -6
- data/site/docs/frontmatter/index.html +13 -5
- data/site/docs/github-pages/index.html +68 -47
- data/site/docs/history/index.html +132 -9
- data/site/docs/home/index.html +13 -5
- data/site/docs/includes/index.html +824 -0
- data/site/docs/installation/index.html +16 -6
- data/site/docs/maintaining/affinity-team-captain/index.html +16 -5
- data/site/docs/maintaining/avoiding-burnout/index.html +16 -5
- data/site/docs/maintaining/becoming-a-maintainer/index.html +17 -6
- data/site/docs/maintaining/index.html +16 -5
- data/site/docs/maintaining/merging-a-pull-request/index.html +21 -6
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +16 -5
- data/site/docs/maintaining/special-labels/index.html +16 -5
- data/site/docs/maintaining/triaging-an-issue/index.html +16 -5
- data/site/docs/migrations/index.html +13 -5
- data/site/docs/pages/index.html +33 -50
- data/site/docs/pagination/index.html +16 -5
- data/site/docs/permalinks/index.html +148 -66
- data/site/docs/plugins/index.html +39 -14
- data/site/docs/posts/index.html +32 -5
- data/site/docs/quickstart/index.html +57 -18
- data/site/docs/resources/index.html +21 -10
- data/site/docs/sites/index.html +18 -7
- data/site/docs/static-files/index.html +15 -7
- data/site/docs/structure/index.html +47 -32
- data/site/docs/templates/index.html +85 -89
- data/site/docs/themes/index.html +214 -63
- data/site/docs/troubleshooting/index.html +16 -5
- data/site/docs/upgrading/0-to-2/index.html +16 -5
- data/site/docs/upgrading/2-to-3/index.html +17 -6
- data/site/docs/upgrading/index.html +16 -5
- data/site/docs/usage/index.html +21 -6
- data/site/docs/variables/index.html +14 -6
- data/site/docs/windows/index.html +35 -10
- data/site/feed.xml +41 -22
- data/site/fonts/FontAwesome.eot +0 -0
- data/site/fonts/FontAwesome.svg +12 -0
- data/site/fonts/FontAwesome.ttf +0 -0
- data/site/fonts/FontAwesome.woff +0 -0
- data/site/help/index.html +3 -3
- data/site/icomoon-selection.json +96 -0
- data/site/index.html +3 -3
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +12 -8
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +11 -7
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +11 -7
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +11 -7
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +11 -7
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +12 -8
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +11 -7
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +11 -7
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +11 -7
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +11 -7
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +11 -7
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +11 -7
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +11 -7
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +11 -7
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +11 -7
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +11 -7
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +11 -7
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +11 -7
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +11 -7
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +11 -7
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +11 -7
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +12 -8
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +12 -8
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +11 -7
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +11 -7
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +11 -7
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +11 -7
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +11 -7
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +11 -7
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +11 -7
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +12 -8
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +11 -7
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +11 -7
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +11 -7
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +11 -7
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +11 -7
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +11 -7
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +11 -7
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +11 -7
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +11 -7
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +11 -7
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +11 -7
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +11 -7
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +11 -7
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +11 -8
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +11 -7
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +11 -7
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +11 -7
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +11 -7
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +11 -7
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +11 -7
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +11 -7
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +12 -8
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +12 -8
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +11 -7
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +570 -0
- data/site/news/index.html +81 -15
- data/site/news/releases/index.html +78 -12
- data/site/readme.md +9 -2
- data/site/sitemap.xml +59 -43
- metadata +14 -10
- data/site/fonts/fontawesome-webfont.eot +0 -0
- data/site/fonts/fontawesome-webfont.svg +0 -640
- data/site/fonts/fontawesome-webfont.ttf +0 -0
- data/site/fonts/fontawesome-webfont.woff +0 -0
- data/site/fonts/fontawesome-webfont.woff2 +0 -0
@@ -4,7 +4,7 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.4.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
@@ -19,7 +19,7 @@
|
|
19
19
|
<meta property="og:url" content="https://jekyllrb.com/docs/pagination/">
|
20
20
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
21
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
22
|
+
<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
|
23
23
|
<meta name="twitter:card" content="summary">
|
24
24
|
<meta name="twitter:site" content="@jekyllrb">
|
25
25
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
@@ -27,7 +27,7 @@
|
|
27
27
|
{"@context": "http://schema.org",
|
28
28
|
"@type": "BlogPosting",
|
29
29
|
"headline": "Pagination",
|
30
|
-
"datePublished": "2017-
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
31
|
"description": "With many websites — especially blogs — it’s very common to break the main listing of posts up into smaller lists and display them over multiple pages. Jekyll offers a pagination plugin, so you can automatically generate the appropriate files and folders you need for paginated listings.",
|
32
32
|
"publisher": {"@type": "Organization",
|
33
33
|
"logo": {"@type": "ImageObject",
|
@@ -192,6 +192,10 @@
|
|
192
192
|
|
193
193
|
|
194
194
|
|
195
|
+
<option value="/docs/includes/">Includes</option>
|
196
|
+
|
197
|
+
|
198
|
+
|
195
199
|
<option value="/docs/permalinks/">Permalinks</option>
|
196
200
|
|
197
201
|
|
@@ -567,6 +571,9 @@ page with links to all but the current page.</p>
|
|
567
571
|
|
568
572
|
|
569
573
|
|
574
|
+
|
575
|
+
|
576
|
+
|
570
577
|
|
571
578
|
|
572
579
|
|
@@ -680,6 +687,10 @@ page with links to all but the current page.</p>
|
|
680
687
|
|
681
688
|
|
682
689
|
|
690
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
691
|
+
|
692
|
+
|
693
|
+
|
683
694
|
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
684
695
|
|
685
696
|
|
@@ -828,7 +839,7 @@ page with links to all but the current page.</p>
|
|
828
839
|
</script>
|
829
840
|
|
830
841
|
|
831
|
-
<!-- Gauges (http://gaug.es/) -->
|
842
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
832
843
|
<script>
|
833
844
|
var _gauges = _gauges || [];
|
834
845
|
(function() {
|
@@ -845,7 +856,7 @@ page with links to all but the current page.</p>
|
|
845
856
|
|
846
857
|
|
847
858
|
|
848
|
-
<!-- Google Analytics (
|
859
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
849
860
|
<script>
|
850
861
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
851
862
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
@@ -4,7 +4,7 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.4.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
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
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
@@ -13,13 +13,13 @@
|
|
13
13
|
<!-- Begin Jekyll SEO tag v2.1.0 -->
|
14
14
|
<title>Permalinks - Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Permalinks">
|
16
|
-
<meta name="description" content="
|
17
|
-
<meta property="og:description" content="
|
16
|
+
<meta name="description" content="Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern.">
|
17
|
+
<meta property="og:description" content="Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern.">
|
18
18
|
<link rel="canonical" href="https://jekyllrb.com/docs/permalinks/">
|
19
19
|
<meta property="og:url" content="https://jekyllrb.com/docs/permalinks/">
|
20
20
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
21
21
|
<meta property="og:type" content="article">
|
22
|
-
<meta property="article:published_time" content="2017-
|
22
|
+
<meta property="article:published_time" content="2017-03-22T08:06:48-07:00">
|
23
23
|
<meta name="twitter:card" content="summary">
|
24
24
|
<meta name="twitter:site" content="@jekyllrb">
|
25
25
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
@@ -27,8 +27,8 @@
|
|
27
27
|
{"@context": "http://schema.org",
|
28
28
|
"@type": "BlogPosting",
|
29
29
|
"headline": "Permalinks",
|
30
|
-
"datePublished": "2017-
|
31
|
-
"description": "
|
30
|
+
"datePublished": "2017-03-22T08:06:48-07:00",
|
31
|
+
"description": "Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern.",
|
32
32
|
"publisher": {"@type": "Organization",
|
33
33
|
"logo": {"@type": "ImageObject",
|
34
34
|
"url": "https://jekyllrb.com/img/logo-2x.png"}},
|
@@ -192,6 +192,10 @@
|
|
192
192
|
|
193
193
|
|
194
194
|
|
195
|
+
<option value="/docs/includes/">Includes</option>
|
196
|
+
|
197
|
+
|
198
|
+
|
195
199
|
<option value="/docs/permalinks/">Permalinks</option>
|
196
200
|
|
197
201
|
|
@@ -286,17 +290,58 @@
|
|
286
290
|
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/permalinks.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
287
291
|
</div>
|
288
292
|
<h1>Permalinks</h1>
|
289
|
-
<p>
|
290
|
-
permalinks
|
291
|
-
|
292
|
-
|
293
|
-
|
293
|
+
<p>Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
|
294
|
+
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as <code class="highlighter-rouge">date</code>) that automatically use a template-variable pattern.</p>
|
295
|
+
|
296
|
+
<p>You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is <code class="highlighter-rouge">/:categories/:year/:month/:day/:title.html</code>. Each of the colon-prefixed keywords is a template variable.</p>
|
297
|
+
|
298
|
+
<h2 id="where-to-configure-permalinks">Where to configure permalinks</h2>
|
299
|
+
|
300
|
+
<p>You can configure your site’s permalinks through the <a href="/docs/configuration/">Configuration</a> file or in the <a href="/docs/frontmatter/">Front Matter</a> for each post, page, or collection.</p>
|
301
|
+
|
302
|
+
<p>Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your <code class="highlighter-rouge">_config.yml</code> file like this:</p>
|
303
|
+
|
304
|
+
<div class="language-yaml highlighter-rouge">
|
305
|
+
<pre class="highlight"><code><span class="s">permalink</span><span class="pi">:</span> <span class="s">/:categories/:year/:month/:day/:title.html</span>
|
306
|
+
</code></pre>
|
307
|
+
</div>
|
308
|
+
|
309
|
+
<p>If you don’t specify any permalink setting, Jekyll uses the above pattern as the default.</p>
|
310
|
+
|
311
|
+
<p>The permalink can also be set using a built-in permalink style:</p>
|
312
|
+
|
313
|
+
<div class="language-yaml highlighter-rouge">
|
314
|
+
<pre class="highlight"><code><span class="s">permalink</span><span class="pi">:</span> <span class="s">date</span>
|
315
|
+
</code></pre>
|
316
|
+
</div>
|
294
317
|
|
295
|
-
<p>
|
296
|
-
are represented by colon-prefixed keywords. For example, the default <code class="highlighter-rouge">date</code>
|
297
|
-
permalink is defined according to the format <code class="highlighter-rouge">/:categories/:year/:month/:day/:title.html</code>.</p>
|
318
|
+
<p><code class="highlighter-rouge">date</code> is the same as <code class="highlighter-rouge">:categories/:year/:month/:day/:title.html</code>, the default. See <a href="#builtinpermalinkstyles">Built-in Permalink Styles</a> below for more options.</p>
|
298
319
|
|
299
|
-
<
|
320
|
+
<p>Setting the permalink in your post, page, or collection’s front matter overrides any global settings. Here’s an example:</p>
|
321
|
+
|
322
|
+
<div class="language-yaml highlighter-rouge">
|
323
|
+
<pre class="highlight"><code><span class="nn">---</span>
|
324
|
+
<span class="s">title</span><span class="pi">:</span> <span class="s">My page title</span>
|
325
|
+
<span class="s">permalink</span><span class="pi">:</span> <span class="s">/mypageurl/</span>
|
326
|
+
<span class="nn">---</span>
|
327
|
+
</code></pre>
|
328
|
+
</div>
|
329
|
+
|
330
|
+
<p>Even if your configuration file specifies the <code class="highlighter-rouge">date</code> style, the URL for this page would be <code class="highlighter-rouge">http://somedomain.com/mypageurl/</code>.</p>
|
331
|
+
|
332
|
+
<p>When you use permalinks that omit the <code class="highlighter-rouge">.html</code> file extension (called “pretty URLs”) Jekyll builds the file as index.html placed inside a folder with the page’s name. For example:</p>
|
333
|
+
|
334
|
+
<div class="highlighter-rouge">
|
335
|
+
<pre class="highlight"><code>├── mypageurl
|
336
|
+
│ └── index.html
|
337
|
+
</code></pre>
|
338
|
+
</div>
|
339
|
+
|
340
|
+
<p>With a URL such as <code class="highlighter-rouge">/mypageurl/</code>, servers automatically load the index.html file inside the folder, so users can simply navigate to <code class="highlighter-rouge">http://somedomain.com/mypageurl/</code> to get to <code class="highlighter-rouge">mypageurl/index.html</code>.</p>
|
341
|
+
|
342
|
+
<h2 id="template-variables">Template variables for permalinks</h2>
|
343
|
+
|
344
|
+
<p>The following table lists the template variables available for permalinks. You can use these variables in the <code class="highlighter-rouge">permalink</code> property in your config file.</p>
|
300
345
|
|
301
346
|
<div class="mobile-side-scroller">
|
302
347
|
<table>
|
@@ -312,7 +357,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
312
357
|
<p><code>year</code></p>
|
313
358
|
</td>
|
314
359
|
<td>
|
315
|
-
<p>Year from the
|
360
|
+
<p>Year from the post's filename</p>
|
316
361
|
</td>
|
317
362
|
</tr>
|
318
363
|
<tr>
|
@@ -320,7 +365,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
320
365
|
<p><code>month</code></p>
|
321
366
|
</td>
|
322
367
|
<td>
|
323
|
-
<p>Month from the
|
368
|
+
<p>Month from the post's filename</p>
|
324
369
|
</td>
|
325
370
|
</tr>
|
326
371
|
<tr>
|
@@ -328,7 +373,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
328
373
|
<p><code>i_month</code></p>
|
329
374
|
</td>
|
330
375
|
<td>
|
331
|
-
<p>Month from the
|
376
|
+
<p>Month from the post's filename without leading zeros.</p>
|
332
377
|
</td>
|
333
378
|
</tr>
|
334
379
|
<tr>
|
@@ -336,7 +381,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
336
381
|
<p><code>day</code></p>
|
337
382
|
</td>
|
338
383
|
<td>
|
339
|
-
<p>Day from the
|
384
|
+
<p>Day from the post's filename</p>
|
340
385
|
</td>
|
341
386
|
</tr>
|
342
387
|
<tr>
|
@@ -344,7 +389,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
344
389
|
<p><code>i_day</code></p>
|
345
390
|
</td>
|
346
391
|
<td>
|
347
|
-
<p>Day from the
|
392
|
+
<p>Day from the post's filename without leading zeros.</p>
|
348
393
|
</td>
|
349
394
|
</tr>
|
350
395
|
<tr>
|
@@ -352,7 +397,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
352
397
|
<p><code>short_year</code></p>
|
353
398
|
</td>
|
354
399
|
<td>
|
355
|
-
<p>Year from the
|
400
|
+
<p>Year from the post's filename without the century.</p>
|
356
401
|
</td>
|
357
402
|
</tr>
|
358
403
|
<tr>
|
@@ -361,7 +406,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
361
406
|
</td>
|
362
407
|
<td>
|
363
408
|
<p>
|
364
|
-
Hour of the day, 24-hour clock, zero-padded from the post
|
409
|
+
Hour of the day, 24-hour clock, zero-padded from the post's <code>date</code> front matter. (00..23)
|
365
410
|
</p>
|
366
411
|
</td>
|
367
412
|
</tr>
|
@@ -371,7 +416,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
371
416
|
</td>
|
372
417
|
<td>
|
373
418
|
<p>
|
374
|
-
Minute of the hour from the post
|
419
|
+
Minute of the hour from the post's <code>date</code> front matter. (00..59)
|
375
420
|
</p>
|
376
421
|
</td>
|
377
422
|
</tr>
|
@@ -381,7 +426,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
381
426
|
</td>
|
382
427
|
<td>
|
383
428
|
<p>
|
384
|
-
Second of the minute from the post
|
429
|
+
Second of the minute from the post's <code>date</code> front matter. (00..59)
|
385
430
|
</p>
|
386
431
|
</td>
|
387
432
|
</tr>
|
@@ -402,8 +447,8 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
402
447
|
</td>
|
403
448
|
<td>
|
404
449
|
<p>
|
405
|
-
Slugified title from the document’s filename (
|
406
|
-
except numbers and letters is replaced as hyphen
|
450
|
+
Slugified title from the document’s filename (any character
|
451
|
+
except numbers and letters is replaced as hyphen). May be
|
407
452
|
overridden via the document’s <code>slug</code> YAML front matter.
|
408
453
|
</p>
|
409
454
|
</td>
|
@@ -414,7 +459,7 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
414
459
|
</td>
|
415
460
|
<td>
|
416
461
|
<p>
|
417
|
-
The specified categories for this
|
462
|
+
The specified categories for this post. If a post has multiple
|
418
463
|
categories, Jekyll will create a hierarchy (e.g. <code>/category1/category2</code>).
|
419
464
|
Also Jekyll automatically parses out double slashes in the URLs,
|
420
465
|
so if no categories are present, it will ignore this.
|
@@ -425,10 +470,11 @@ permalink is defined according to the format <code class="highlighter-rouge">/:c
|
|
425
470
|
</table>
|
426
471
|
</div>
|
427
472
|
|
428
|
-
<
|
473
|
+
<p>Note that all template variables relating to time or categories are available to posts only.</p>
|
474
|
+
|
475
|
+
<h2 id="builtinpermalinkstyles">Built-in permalink styles</h2>
|
429
476
|
|
430
|
-
<p>
|
431
|
-
Jekyll also provides the following built-in styles for convenience.</p>
|
477
|
+
<p>Although you can specify a custom permalink pattern using <a href="#template-variables">template variables</a>, Jekyll also provides the following built-in styles for convenience.</p>
|
432
478
|
|
433
479
|
<div class="mobile-side-scroller">
|
434
480
|
<table>
|
@@ -475,26 +521,16 @@ Jekyll also provides the following built-in styles for convenience.</p>
|
|
475
521
|
</table>
|
476
522
|
</div>
|
477
523
|
|
478
|
-
<
|
524
|
+
<p>Rather than typing <code class="highlighter-rouge">permalink: /:categories/:year/:month/:day/:title/</code>, you can just type <code class="highlighter-rouge">permalink: pretty</code>.</p>
|
479
525
|
|
480
|
-
<
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
<p>These styles are modified to match the suffix style specified in the post
|
486
|
-
permalink setting. For example, a permalink style of <code class="highlighter-rouge">pretty</code>, which contains a
|
487
|
-
trailing slash, will update page permalinks to also contain a trailing slash:
|
488
|
-
<code class="highlighter-rouge">/:path/:basename/</code>. A permalink style of <code class="highlighter-rouge">date</code>, which contains a trailing
|
489
|
-
file extension, will update page permalinks to also contain a file extension:
|
490
|
-
<code class="highlighter-rouge">/:path/:basename:output_ext</code>. The same is true for any custom permalink style.</p>
|
526
|
+
<div class="note info">
|
527
|
+
<h5>Specifying permalinks through the YAML Front Matter</h5>
|
528
|
+
<p>Built-in permalink styles are not recognized in YAML Front Matter. As a result, <code>permalink: pretty</code> will not work.</p>
|
529
|
+
</div>
|
491
530
|
|
492
|
-
<
|
493
|
-
overridden in the <a href="../frontmatter/">YAML Front Matter</a> for the page or document.
|
494
|
-
Additionally, permalinks for a given collection can be customized <a href="../collections/">in the
|
495
|
-
collections configuration</a>.</p>
|
531
|
+
<h2 id="permalink-style-examples">Permalink style examples with posts</h2>
|
496
532
|
|
497
|
-
<
|
533
|
+
<p>Here are a few examples to clarify how permalink styles get applied with posts.</p>
|
498
534
|
|
499
535
|
<p>Given a post named: <code class="highlighter-rouge">/2009-04-29-slap-chop.md</code></p>
|
500
536
|
|
@@ -542,7 +578,7 @@ collections configuration</a>.</p>
|
|
542
578
|
<tr>
|
543
579
|
<td>
|
544
580
|
<p><code>/:year/:month/:title</code></p>
|
545
|
-
<p>See <a href="#extensionless-permalinks">
|
581
|
+
<p>See <a href="#extensionless-permalinks">Extensionless permalinks with no trailing slashes</a> for details.</p>
|
546
582
|
</td>
|
547
583
|
<td>
|
548
584
|
<p><code>/2009/04/slap-chop</code></p>
|
@@ -552,34 +588,73 @@ collections configuration</a>.</p>
|
|
552
588
|
</table>
|
553
589
|
</div>
|
554
590
|
|
555
|
-
<h2 id="
|
591
|
+
<h2 id="pages-and-collections">Permalink settings for pages and collections</h2>
|
592
|
+
|
593
|
+
<p>The permalink setting in your configuration file specifies the permalink style used for posts, pages, and collections. However, because pages and collections don’t have time or categories, these aspects of the permalink style are ignored with pages and collections.</p>
|
594
|
+
|
595
|
+
<p>For example:</p>
|
596
|
+
|
597
|
+
<ul>
|
598
|
+
<li>A permalink style of <code class="highlighter-rouge">/:categories/:year/:month/:day/:title.html</code> for posts becomes <code class="highlighter-rouge">/:title.html</code> for pages and collections.</li>
|
599
|
+
<li>A permalink style of <code class="highlighter-rouge">pretty</code> (or <code class="highlighter-rouge">/:categories/:year/:month/:day/:title/</code>), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: <code class="highlighter-rouge">/:title/</code>.</li>
|
600
|
+
<li>A permalink style of <code class="highlighter-rouge">date</code>, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: <code class="highlighter-rouge">/:title.html</code>. But no time or category information will be included.</li>
|
601
|
+
</ul>
|
602
|
+
|
603
|
+
<h2 id="permalinks-and-default-paths">Permalinks and default paths</h2>
|
604
|
+
|
605
|
+
<p>The path to the post or page in the built site differs for posts, pages, and collections:</p>
|
606
|
+
|
607
|
+
<h3 id="posts">Posts</h3>
|
608
|
+
|
609
|
+
<p>The subfolders into which you may have organized your posts inside the <code class="highlighter-rouge">_posts</code> directory will not be part of the permalink.</p>
|
610
|
+
|
611
|
+
<p>If you use a permalink style that omits the <code class="highlighter-rouge">.html</code> file extension, each post is rendered as an <code class="highlighter-rouge">index.html</code> file inside a folder with the post’s name (for example, <code class="highlighter-rouge">categoryname/2016/12/01/mypostname/index.html</code>).</p>
|
612
|
+
|
613
|
+
<h3 id="pages">Pages</h3>
|
614
|
+
|
615
|
+
<p>Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a <code class="highlighter-rouge">permalink</code> declared its front matter — in that case, the structure honors the permalink setting instead of the source folder structure.)</p>
|
616
|
+
|
617
|
+
<p>As with posts, if you use a permalink style that omits the <code class="highlighter-rouge">.html</code> file extension, each page is rendered as an <code class="highlighter-rouge">index.html</code> file inserted inside a folder with the page’s name (for example, <code class="highlighter-rouge">mypage/index.html</code>).</p>
|
618
|
+
|
619
|
+
<h3 id="collections">Collections</h3>
|
620
|
+
|
621
|
+
<p>By default, collections follow a similar structure in the <code class="highlighter-rouge">_site</code> folder as pages, except that the path is prefaced by the collection name. For example: <code class="highlighter-rouge">collectionname/mypage.html</code>. For permalink settings that omit the file extension, the path would be <code class="highlighter-rouge">collection_name/mypage/index.html</code>.</p>
|
622
|
+
|
623
|
+
<p>Collections have their own way of setting permalinks. Additionally, collections have unique template variables available available (such as <code class="highlighter-rouge">path</code> and <code class="highlighter-rouge">output_ext</code>). See the <a href="../collections/#permalinks">Configuring permalinks for collections</a> in Collections for more information.</p>
|
624
|
+
|
625
|
+
<h2 id="flattening-pages-in-_site-on-build">Flattening pages in _site on build</h2>
|
626
|
+
|
627
|
+
<p>If you want to flatten your pages (pull them out of subfolders) in the <code class="highlighter-rouge">_site</code> directory when your site builds (similar to posts), add the <code class="highlighter-rouge">permalink</code> property to the front matter of each page, with no path specified:</p>
|
628
|
+
|
629
|
+
<div class="highlighter-rouge">
|
630
|
+
<pre class="highlight"><code>---
|
631
|
+
title: My page
|
632
|
+
permalink: mypageurl.html
|
633
|
+
---
|
634
|
+
</code></pre>
|
635
|
+
</div>
|
636
|
+
|
637
|
+
<h2 id="extensionless-permalinks">Extensionless permalinks with no trailing slashes</h2>
|
556
638
|
|
557
|
-
<p>Jekyll supports permalinks that contain neither a trailing slash nor a file
|
558
|
-
extension, but this requires additional support from the web server to properly
|
559
|
-
serve. When using extensionless permalinks, output files written to disk will
|
560
|
-
still have the proper file extension (typically <code class="highlighter-rouge">.html</code>), so the web server
|
561
|
-
must be able to map requests without file extensions to these files.</p>
|
639
|
+
<p>Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically <code class="highlighter-rouge">.html</code>), so the web server must be able to map requests without file extensions to these files.</p>
|
562
640
|
|
563
|
-
<p>Both <a href="../github-pages/">GitHub Pages</a> and the Jekyll’s built-in WEBrick server
|
564
|
-
handle these requests properly without any additional work.</p>
|
641
|
+
<p>Both <a href="../github-pages/">GitHub Pages</a> and the Jekyll’s built-in WEBrick server handle these requests properly without any additional work.</p>
|
565
642
|
|
566
643
|
<h3 id="apache">Apache</h3>
|
567
644
|
|
568
|
-
<p>The Apache web server has
|
569
|
-
handle extensionless URLs by setting the <a href="https://httpd.apache.org/docs/current/content-negotiation.html#multiviews">multiviews</a> option in your
|
570
|
-
<code class="highlighter-rouge">httpd.conf</code> or <code class="highlighter-rouge">.htaccess</code> file:</p>
|
645
|
+
<p>The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the <a href="https://httpd.apache.org/docs/current/content-negotiation.html#multiviews">multiviews</a> option in your <code class="highlighter-rouge">httpd.conf</code> or <code class="highlighter-rouge">.htaccess</code> file:</p>
|
571
646
|
|
572
647
|
<figure class="highlight"><pre><code class="language-apache" data-lang="apache"><span class="nc">Options</span> +MultiViews</code></pre></figure>
|
573
648
|
|
574
649
|
<h3 id="nginx">Nginx</h3>
|
575
650
|
|
576
|
-
<p>The <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files">try_files</a> directive allows you to specify a list of files to search for
|
577
|
-
to process a request. The following configuration will instruct nginx to search
|
578
|
-
for a file with an <code class="highlighter-rouge">.html</code> extension if an exact match for the requested URI is
|
579
|
-
not found.</p>
|
651
|
+
<p>The <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files">try_files</a> directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an <code class="highlighter-rouge">.html</code> extension if an exact match for the requested URI is not found.</p>
|
580
652
|
|
581
653
|
<figure class="highlight"><pre><code class="language-nginx" data-lang="nginx"><span class="k">try_files</span> <span class="nv">$uri</span> <span class="nv">$uri</span><span class="s">.html</span> <span class="nv">$uri</span><span class="n">/</span> <span class="p">=</span><span class="mi">404</span><span class="p">;</span></code></pre></figure>
|
582
654
|
|
655
|
+
<h2 id="linking-without-regard-to-permalink-styles">Linking without regard to permalink styles</h2>
|
656
|
+
|
657
|
+
<p>You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the <code class="highlighter-rouge">link</code> tag, if you change your permalinks, your links won’t break. See <a href="../templates#link">Linking to pages</a> in Templates for more details.</p>
|
583
658
|
|
584
659
|
|
585
660
|
|
@@ -636,6 +711,9 @@ not found.</p>
|
|
636
711
|
|
637
712
|
|
638
713
|
|
714
|
+
|
715
|
+
|
716
|
+
|
639
717
|
|
640
718
|
|
641
719
|
|
@@ -645,7 +723,7 @@ not found.</p>
|
|
645
723
|
|
646
724
|
|
647
725
|
|
648
|
-
<a href="/docs/
|
726
|
+
<a href="/docs/includes/" class="prev">Back</a>
|
649
727
|
|
650
728
|
</div>
|
651
729
|
<div class="right align-left">
|
@@ -749,6 +827,10 @@ not found.</p>
|
|
749
827
|
|
750
828
|
|
751
829
|
|
830
|
+
<li class=""><a href="/docs/includes/">Includes</a></li>
|
831
|
+
|
832
|
+
|
833
|
+
|
752
834
|
<li class="current"><a href="/docs/permalinks/">Permalinks</a></li>
|
753
835
|
|
754
836
|
|
@@ -897,7 +979,7 @@ not found.</p>
|
|
897
979
|
</script>
|
898
980
|
|
899
981
|
|
900
|
-
<!-- Gauges (http://gaug.es/) -->
|
982
|
+
<!-- Gauges (http://get.gaug.es/) -->
|
901
983
|
<script>
|
902
984
|
var _gauges = _gauges || [];
|
903
985
|
(function() {
|
@@ -914,7 +996,7 @@ not found.</p>
|
|
914
996
|
|
915
997
|
|
916
998
|
|
917
|
-
<!-- Google Analytics (
|
999
|
+
<!-- Google Analytics (https://www.google.com/analytics) -->
|
918
1000
|
<script>
|
919
1001
|
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
920
1002
|
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|