jekyll-docs 3.5.2 → 3.6.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/docs/assets/index.html +14 -22
- data/site/docs/code_of_conduct/index.html +730 -0
- data/site/docs/collections/index.html +65 -80
- data/site/docs/conduct/index.html +4 -4
- data/site/docs/configuration/index.html +130 -156
- data/site/docs/continuous-integration/buddyworks/index.html +14 -16
- data/site/docs/continuous-integration/circleci/index.html +13 -21
- data/site/docs/continuous-integration/index.html +5 -5
- data/site/docs/continuous-integration/travis-ci/index.html +45 -73
- data/site/docs/contributing/index.html +10 -10
- data/site/docs/datafiles/index.html +37 -53
- data/site/docs/deployment-methods/index.html +54 -64
- data/site/docs/drafts/index.html +6 -8
- data/site/docs/extras/index.html +8 -12
- data/site/docs/frontmatter/index.html +10 -14
- data/site/docs/github-pages/index.html +10 -14
- data/site/docs/history/index.html +539 -440
- data/site/docs/home/index.html +4 -4
- data/site/docs/includes/index.html +42 -70
- data/site/docs/installation/index.html +23 -37
- data/site/docs/maintaining/affinity-team-captain/index.html +4 -4
- data/site/docs/maintaining/avoiding-burnout/index.html +4 -4
- data/site/docs/maintaining/becoming-a-maintainer/index.html +4 -4
- data/site/docs/maintaining/index.html +4 -4
- data/site/docs/maintaining/merging-a-pull-request/index.html +6 -8
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +4 -4
- data/site/docs/maintaining/special-labels/index.html +4 -4
- data/site/docs/maintaining/triaging-an-issue/index.html +4 -4
- data/site/docs/migrations/index.html +4 -4
- data/site/docs/pages/index.html +8 -12
- data/site/docs/pagination/index.html +13 -21
- data/site/docs/permalinks/index.html +43 -34
- data/site/docs/plugins/index.html +51 -79
- data/site/docs/posts/index.html +26 -48
- data/site/docs/quickstart/index.html +6 -8
- data/site/docs/resources/index.html +45 -21
- data/site/docs/sites/index.html +4 -4
- data/site/docs/static-files/index.html +12 -16
- data/site/docs/structure/index.html +6 -8
- data/site/docs/templates/index.html +36 -68
- data/site/docs/themes/index.html +32 -49
- data/site/docs/troubleshooting/index.html +44 -82
- data/site/docs/upgrading/0-to-2/index.html +7 -9
- data/site/docs/upgrading/2-to-3/index.html +19 -31
- data/site/docs/upgrading/index.html +4 -4
- data/site/docs/usage/index.html +20 -30
- data/site/docs/variables/index.html +26 -10
- data/site/docs/windows/index.html +36 -58
- data/site/feed.xml +47 -53
- data/site/help/index.html +3 -3
- 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 +16 -8
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +16 -8
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +16 -8
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +16 -8
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +16 -8
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +16 -8
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +16 -8
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +16 -8
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +16 -8
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +16 -8
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +16 -8
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +16 -8
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +16 -8
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +16 -8
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +16 -8
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +16 -8
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +16 -8
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +16 -8
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +16 -8
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +16 -8
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +16 -8
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +16 -8
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +16 -8
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +16 -8
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +16 -8
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +16 -8
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +16 -8
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +16 -8
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +16 -8
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +16 -8
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +16 -8
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +17 -9
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +16 -8
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +16 -8
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +16 -8
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +16 -8
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +16 -8
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +16 -8
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +16 -8
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +16 -8
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +16 -8
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +20 -12
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +16 -8
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +16 -8
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +16 -8
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +16 -8
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +16 -8
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +16 -8
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +16 -8
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +16 -8
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +16 -8
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +16 -8
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +27 -29
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +23 -17
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +20 -14
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +21 -13
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +18 -10
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +573 -0
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +565 -0
- data/site/news/index.html +122 -48
- data/site/news/releases/index.html +122 -48
- data/site/sitemap.xml +64 -52
- data/site/tutorials/convert-site-to-jekyll/index.html +80 -138
- data/site/tutorials/custom-404-page/index.html +13 -21
- data/site/tutorials/home/index.html +4 -4
- data/site/tutorials/navigation/index.html +144 -180
- data/site/tutorials/orderofinterpretation/index.html +27 -45
- metadata +8 -5
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Collections | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Collections">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/collections/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Not everything is a post or a page. Maybe you want to document the various methods in your open source project, members of a team, or talks at a conference. Collections allow you to define a new type of document that behave like Pages or Posts do normally, but also have their own unique properties and namespace.","url":"https://jekyllrb.com/docs/collections/","headline":"Collections","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/collections/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -308,32 +308,26 @@ namespace.</p>
|
|
308
308
|
<p>Add the following to your site’s <code class="highlighter-rouge">_config.yml</code> file, replacing <code class="highlighter-rouge">my_collection</code>
|
309
309
|
with the name of your collection:</p>
|
310
310
|
|
311
|
-
<div class="language-yaml highlighter-rouge">
|
312
|
-
<pre class="highlight"><code><span class="s">collections</span><span class="pi">:</span>
|
311
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
313
312
|
<span class="pi">-</span> <span class="s">my_collection</span>
|
314
|
-
</code></pre>
|
315
|
-
</div>
|
313
|
+
</code></pre></div></div>
|
316
314
|
|
317
315
|
<p>You can optionally specify metadata for your collection in the configuration:</p>
|
318
316
|
|
319
|
-
<div class="language-yaml highlighter-rouge">
|
320
|
-
<
|
321
|
-
|
322
|
-
|
323
|
-
</code></pre>
|
324
|
-
</div>
|
317
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
318
|
+
<span class="na">my_collection</span><span class="pi">:</span>
|
319
|
+
<span class="na">foo</span><span class="pi">:</span> <span class="s">bar</span>
|
320
|
+
</code></pre></div></div>
|
325
321
|
|
326
322
|
<p>Default attributes can also be set for a collection:</p>
|
327
323
|
|
328
|
-
<div class="language-yaml highlighter-rouge">
|
329
|
-
<
|
330
|
-
|
331
|
-
<span class="
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
</code></pre>
|
336
|
-
</div>
|
324
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
325
|
+
<span class="pi">-</span> <span class="na">scope</span><span class="pi">:</span>
|
326
|
+
<span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
327
|
+
<span class="na">type</span><span class="pi">:</span> <span class="s">my_collection</span>
|
328
|
+
<span class="na">values</span><span class="pi">:</span>
|
329
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s">page</span>
|
330
|
+
</code></pre></div></div>
|
337
331
|
|
338
332
|
<h3 id="step2">Step 2: Add your content</h3>
|
339
333
|
|
@@ -356,12 +350,10 @@ your <code>_config.yml</code> file, with the addition of the preceding <code>_</
|
|
356
350
|
document in your collection, set the <code class="highlighter-rouge">output</code> key to <code class="highlighter-rouge">true</code> in your collection
|
357
351
|
metadata in your <code class="highlighter-rouge">_config.yml</code>:</p>
|
358
352
|
|
359
|
-
<div class="language-yaml highlighter-rouge">
|
360
|
-
<
|
361
|
-
|
362
|
-
|
363
|
-
</code></pre>
|
364
|
-
</div>
|
353
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
354
|
+
<span class="na">my_collection</span><span class="pi">:</span>
|
355
|
+
<span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
|
356
|
+
</code></pre></div></div>
|
365
357
|
|
366
358
|
<p>This will produce a file for each document in the collection.
|
367
359
|
For example, if you have <code class="highlighter-rouge">_my_collection/some_subdir/some_doc.md</code>,
|
@@ -382,24 +374,20 @@ choice and written out to <code class="highlighter-rouge"><dest>/my_collec
|
|
382
374
|
<p>If you wish to specify a custom pattern for the URLs where your Collection pages
|
383
375
|
will reside, you may do so with the <a href="../permalinks/"><code class="highlighter-rouge">permalink</code> property</a>:</p>
|
384
376
|
|
385
|
-
<div class="language-yaml highlighter-rouge">
|
386
|
-
<
|
387
|
-
|
388
|
-
<span class="
|
389
|
-
|
390
|
-
</code></pre>
|
391
|
-
</div>
|
377
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
378
|
+
<span class="na">my_collection</span><span class="pi">:</span>
|
379
|
+
<span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
|
380
|
+
<span class="na">permalink</span><span class="pi">:</span> <span class="s">/:collection/:name</span>
|
381
|
+
</code></pre></div></div>
|
392
382
|
|
393
383
|
<h3 id="examples">Examples</h3>
|
394
384
|
|
395
385
|
<p>For a collection with the following source file structure,</p>
|
396
386
|
|
397
|
-
<div class="highlighter-rouge">
|
398
|
-
<pre class="highlight"><code>_my_collection/
|
387
|
+
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>_my_collection/
|
399
388
|
└── some_subdir
|
400
389
|
└── some_doc.md
|
401
|
-
</code></pre>
|
402
|
-
</div>
|
390
|
+
</code></pre></div></div>
|
403
391
|
|
404
392
|
<p>each of the following <code class="highlighter-rouge">permalink</code> configurations will produce the document structure shown below it.</p>
|
405
393
|
|
@@ -409,60 +397,55 @@ will reside, you may do so with the <a href="../permalinks/"><code class="highli
|
|
409
397
|
Same as <code class="highlighter-rouge">permalink: /:collection/:path</code>.</p>
|
410
398
|
|
411
399
|
<div class="highlighter-rouge">
|
412
|
-
<pre class="highlight"><code>_site/
|
400
|
+
<div class="highlight"><pre class="highlight"><code>_site/
|
413
401
|
├── my_collection
|
414
402
|
│ └── some_subdir
|
415
403
|
│ └── some_doc.html
|
416
404
|
...
|
417
|
-
</code></pre>
|
418
|
-
</div>
|
405
|
+
</code></pre></div> </div>
|
419
406
|
</li>
|
420
407
|
<li>
|
421
408
|
<p><code class="highlighter-rouge">permalink: pretty</code><br>
|
422
409
|
Same as <code class="highlighter-rouge">permalink: /:collection/:path/</code>.</p>
|
423
410
|
|
424
411
|
<div class="highlighter-rouge">
|
425
|
-
<pre class="highlight"><code>_site/
|
412
|
+
<div class="highlight"><pre class="highlight"><code>_site/
|
426
413
|
├── my_collection
|
427
414
|
│ └── some_subdir
|
428
415
|
│ └── some_doc
|
429
416
|
│ └── index.html
|
430
417
|
...
|
431
|
-
</code></pre>
|
432
|
-
</div>
|
418
|
+
</code></pre></div> </div>
|
433
419
|
</li>
|
434
420
|
<li>
|
435
421
|
<p><code class="highlighter-rouge">permalink: /doc/:path</code></p>
|
436
422
|
|
437
423
|
<div class="highlighter-rouge">
|
438
|
-
<pre class="highlight"><code>_site/
|
424
|
+
<div class="highlight"><pre class="highlight"><code>_site/
|
439
425
|
├── doc
|
440
426
|
│ └── some_subdir
|
441
427
|
│ └── some_doc.html
|
442
428
|
...
|
443
|
-
</code></pre>
|
444
|
-
</div>
|
429
|
+
</code></pre></div> </div>
|
445
430
|
</li>
|
446
431
|
<li>
|
447
432
|
<p><code class="highlighter-rouge">permalink: /doc/:name</code></p>
|
448
433
|
|
449
434
|
<div class="highlighter-rouge">
|
450
|
-
<pre class="highlight"><code>_site/
|
435
|
+
<div class="highlight"><pre class="highlight"><code>_site/
|
451
436
|
├── doc
|
452
437
|
│ └── some_doc.html
|
453
438
|
...
|
454
|
-
</code></pre>
|
455
|
-
</div>
|
439
|
+
</code></pre></div> </div>
|
456
440
|
</li>
|
457
441
|
<li>
|
458
442
|
<p><code class="highlighter-rouge">permalink: /:name</code></p>
|
459
443
|
|
460
444
|
<div class="highlighter-rouge">
|
461
|
-
<pre class="highlight"><code>_site/
|
445
|
+
<div class="highlight"><pre class="highlight"><code>_site/
|
462
446
|
├── some_doc.html
|
463
447
|
...
|
464
|
-
</code></pre>
|
465
|
-
</div>
|
448
|
+
</code></pre></div> </div>
|
466
449
|
</li>
|
467
450
|
</ul>
|
468
451
|
|
@@ -507,7 +490,13 @@ Same as <code class="highlighter-rouge">permalink: /:collection/:path/</code>.</
|
|
507
490
|
<p><code>:title</code></p>
|
508
491
|
</td>
|
509
492
|
<td>
|
510
|
-
<p>
|
493
|
+
<p>
|
494
|
+
The <code>:title</code> template variable will take the
|
495
|
+
<code>slug</code> <a href="/docs/frontmatter/">front matter</a>
|
496
|
+
variable value if any is present in the document; if none is
|
497
|
+
defined then <code>:title</code> will be equivalent to
|
498
|
+
<code>:name</code>, aka the slug generated from the filename.
|
499
|
+
</p>
|
511
500
|
</td>
|
512
501
|
</tr>
|
513
502
|
<tr>
|
@@ -723,31 +712,28 @@ you might have front matter in an individual file structured as follows (which
|
|
723
712
|
must use a supported markup format, and cannot be saved with a <code class="highlighter-rouge">.yaml</code>
|
724
713
|
extension):</p>
|
725
714
|
|
726
|
-
<div class="language-yaml highlighter-rouge">
|
727
|
-
<
|
728
|
-
<span class="
|
729
|
-
<span class="
|
730
|
-
<span class="
|
731
|
-
|
732
|
-
<span class="
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
</code></pre>
|
745
|
-
</div>
|
715
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Josquin:</span><span class="nv"> </span><span class="s">Missa</span><span class="nv"> </span><span class="s">De</span><span class="nv"> </span><span class="s">beata</span><span class="nv"> </span><span class="s">virgine</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">Missa</span><span class="nv"> </span><span class="s">Ave</span><span class="nv"> </span><span class="s">maris</span><span class="nv"> </span><span class="s">stella"</span>
|
716
|
+
<span class="na">artist</span><span class="pi">:</span> <span class="s2">"</span><span class="s">The</span><span class="nv"> </span><span class="s">Tallis</span><span class="nv"> </span><span class="s">Scholars"</span>
|
717
|
+
<span class="na">director</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Peter</span><span class="nv"> </span><span class="s">Phillips"</span>
|
718
|
+
<span class="na">works</span><span class="pi">:</span>
|
719
|
+
<span class="pi">-</span> <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Missa</span><span class="nv"> </span><span class="s">De</span><span class="nv"> </span><span class="s">beata</span><span class="nv"> </span><span class="s">virgine"</span>
|
720
|
+
<span class="na">composer</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Josquin</span><span class="nv"> </span><span class="s">des</span><span class="nv"> </span><span class="s">Prez"</span>
|
721
|
+
<span class="na">tracks</span><span class="pi">:</span>
|
722
|
+
<span class="pi">-</span> <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Kyrie"</span>
|
723
|
+
<span class="na">duration</span><span class="pi">:</span> <span class="s2">"</span><span class="s">4:25"</span>
|
724
|
+
<span class="pi">-</span> <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Gloria"</span>
|
725
|
+
<span class="na">duration</span><span class="pi">:</span> <span class="s2">"</span><span class="s">9:53"</span>
|
726
|
+
<span class="pi">-</span> <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Credo"</span>
|
727
|
+
<span class="na">duration</span><span class="pi">:</span> <span class="s2">"</span><span class="s">9:09"</span>
|
728
|
+
<span class="pi">-</span> <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Sanctus</span><span class="nv"> </span><span class="s">&</span><span class="nv"> </span><span class="s">Benedictus"</span>
|
729
|
+
<span class="na">duration</span><span class="pi">:</span> <span class="s2">"</span><span class="s">7:47"</span>
|
730
|
+
<span class="pi">-</span> <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Agnus</span><span class="nv"> </span><span class="s">Dei</span><span class="nv"> </span><span class="s">I,</span><span class="nv"> </span><span class="s">II</span><span class="nv"> </span><span class="s">&</span><span class="nv"> </span><span class="s">III"</span>
|
731
|
+
<span class="na">duration</span><span class="pi">:</span> <span class="s2">"</span><span class="s">6:49"</span>
|
732
|
+
</code></pre></div></div>
|
746
733
|
|
747
734
|
<p>Every album in the collection could be listed on a single page with a template:</p>
|
748
735
|
|
749
|
-
<div class="language-html highlighter-rouge">
|
750
|
-
<pre class="highlight"><code>
|
736
|
+
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
751
737
|
{% for album in site.albums %}
|
752
738
|
<span class="nt"><h2></span>{{ album.title }}<span class="nt"></h2></span>
|
753
739
|
<span class="nt"><p></span>Performed by {{ album.artist }}{% if album.director %}, directed by {{ album.director }}{% endif %}<span class="nt"></p></span>
|
@@ -762,8 +748,7 @@ extension):</p>
|
|
762
748
|
{% endfor %}
|
763
749
|
{% endfor %}
|
764
750
|
|
765
|
-
</code></pre>
|
766
|
-
</div>
|
751
|
+
</code></pre></div></div>
|
767
752
|
|
768
753
|
|
769
754
|
|
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Code of Conduct | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Code of Conduct">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/conduct/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.","url":"https://jekyllrb.com/docs/conduct/","headline":"Code of Conduct","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/conduct/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -4,13 +4,13 @@
|
|
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.6.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">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Configuration | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Configuration">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/configuration/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.","url":"https://jekyllrb.com/docs/configuration/","headline":"Configuration","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -705,14 +705,12 @@ before your site is served.</p>
|
|
705
705
|
|
706
706
|
<p>You can provide custom headers for your site by adding them to <code class="highlighter-rouge">_config.yml</code></p>
|
707
707
|
|
708
|
-
<div class="language-yaml highlighter-rouge">
|
709
|
-
<
|
710
|
-
<span class="
|
711
|
-
|
712
|
-
<span class="
|
713
|
-
|
714
|
-
</code></pre>
|
715
|
-
</div>
|
708
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># File: _config.yml</span>
|
709
|
+
<span class="na">webrick</span><span class="pi">:</span>
|
710
|
+
<span class="na">headers</span><span class="pi">:</span>
|
711
|
+
<span class="na">My-Header</span><span class="pi">:</span> <span class="s">My-Value</span>
|
712
|
+
<span class="na">My-Other-Header</span><span class="pi">:</span> <span class="s">My-Other-Value</span>
|
713
|
+
</code></pre></div></div>
|
716
714
|
|
717
715
|
<h3 id="defaults">Defaults</h3>
|
718
716
|
|
@@ -727,25 +725,21 @@ aggressive caching when you are in development mode.</p>
|
|
727
725
|
|
728
726
|
<p>For example, suppose you set this conditional statement in your code:</p>
|
729
727
|
|
730
|
-
<div class="language-liquid highlighter-rouge">
|
731
|
-
<pre class="highlight"><code>
|
728
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
732
729
|
<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>
|
733
730
|
<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>
|
734
731
|
<span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
|
735
732
|
|
736
|
-
</code></pre>
|
737
|
-
</div>
|
733
|
+
</code></pre></div></div>
|
738
734
|
|
739
735
|
<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>
|
740
736
|
|
741
|
-
<div class="language-sh highlighter-rouge">
|
742
|
-
|
743
|
-
</code></pre>
|
744
|
-
</div>
|
737
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">JEKYLL_ENV</span><span class="o">=</span>production jekyll build
|
738
|
+
</code></pre></div></div>
|
745
739
|
|
746
740
|
<p>Specifying an environment value allows you to make certain content available only within specific environments.</p>
|
747
741
|
|
748
|
-
<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"
|
742
|
+
<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">{% if jekyll.environment == "development" %}</code> tags will automatically appear in the build.</p>
|
749
743
|
|
750
744
|
<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>
|
751
745
|
|
@@ -763,15 +757,13 @@ aggressive caching when you are in development mode.</p>
|
|
763
757
|
|
764
758
|
<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>
|
765
759
|
|
766
|
-
<div class="language-yaml highlighter-rouge">
|
767
|
-
<pre class="highlight"><code><span class="s">defaults</span><span class="pi">:</span>
|
760
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
768
761
|
<span class="pi">-</span>
|
769
|
-
<span class="
|
770
|
-
<span class="
|
771
|
-
<span class="
|
772
|
-
<span class="
|
773
|
-
</code></pre>
|
774
|
-
</div>
|
762
|
+
<span class="na">scope</span><span class="pi">:</span>
|
763
|
+
<span class="na">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>
|
764
|
+
<span class="na">values</span><span class="pi">:</span>
|
765
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
|
766
|
+
</code></pre></div></div>
|
775
767
|
|
776
768
|
<div class="note info">
|
777
769
|
<h5>Please stop and rerun `jekyll serve` command.</h5>
|
@@ -787,56 +779,50 @@ aggressive caching when you are in development mode.</p>
|
|
787
779
|
|
788
780
|
<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>
|
789
781
|
|
790
|
-
<div class="language-yaml highlighter-rouge">
|
791
|
-
<pre class="highlight"><code><span class="s">defaults</span><span class="pi">:</span>
|
782
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
792
783
|
<span class="pi">-</span>
|
793
|
-
<span class="
|
794
|
-
<span class="
|
795
|
-
<span class="
|
796
|
-
<span class="
|
797
|
-
<span class="
|
798
|
-
</code></pre>
|
799
|
-
</div>
|
784
|
+
<span class="na">scope</span><span class="pi">:</span>
|
785
|
+
<span class="na">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>
|
786
|
+
<span class="na">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>
|
787
|
+
<span class="na">values</span><span class="pi">:</span>
|
788
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
|
789
|
+
</code></pre></div></div>
|
800
790
|
|
801
791
|
<p>Now, this will only set the layout for files where the type is <code class="highlighter-rouge">posts</code>.
|
802
792
|
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>
|
803
793
|
|
804
794
|
<p>As mentioned earlier, you can set multiple scope/values pairs for <code class="highlighter-rouge">defaults</code>.</p>
|
805
795
|
|
806
|
-
<div class="language-yaml highlighter-rouge">
|
807
|
-
<pre class="highlight"><code><span class="s">defaults</span><span class="pi">:</span>
|
796
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
808
797
|
<span class="pi">-</span>
|
809
|
-
<span class="
|
810
|
-
<span class="
|
811
|
-
<span class="
|
812
|
-
<span class="
|
813
|
-
<span class="
|
798
|
+
<span class="na">scope</span><span class="pi">:</span>
|
799
|
+
<span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
800
|
+
<span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
|
801
|
+
<span class="na">values</span><span class="pi">:</span>
|
802
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">my-site"</span>
|
814
803
|
<span class="pi">-</span>
|
815
|
-
<span class="
|
816
|
-
<span class="
|
817
|
-
<span class="
|
818
|
-
<span class="
|
819
|
-
<span class="
|
820
|
-
<span class="
|
821
|
-
</code></pre>
|
822
|
-
</div>
|
804
|
+
<span class="na">scope</span><span class="pi">:</span>
|
805
|
+
<span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
|
806
|
+
<span class="na">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>
|
807
|
+
<span class="na">values</span><span class="pi">:</span>
|
808
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span> <span class="c1"># overrides previous default layout</span>
|
809
|
+
<span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span>
|
810
|
+
</code></pre></div></div>
|
823
811
|
|
824
|
-
<p>With these defaults, all
|
812
|
+
<p>With these defaults, all pages 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>
|
825
813
|
|
826
|
-
<div class="language-yaml highlighter-rouge">
|
827
|
-
<
|
828
|
-
|
829
|
-
<span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
|
814
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
|
815
|
+
<span class="na">my_collection</span><span class="pi">:</span>
|
816
|
+
<span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
|
830
817
|
|
831
|
-
<span class="
|
818
|
+
<span class="na">defaults</span><span class="pi">:</span>
|
832
819
|
<span class="pi">-</span>
|
833
|
-
<span class="
|
834
|
-
<span class="
|
835
|
-
<span class="
|
836
|
-
<span class="
|
837
|
-
<span class="
|
838
|
-
</code></pre>
|
839
|
-
</div>
|
820
|
+
<span class="na">scope</span><span class="pi">:</span>
|
821
|
+
<span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span>
|
822
|
+
<span class="na">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>
|
823
|
+
<span class="na">values</span><span class="pi">:</span>
|
824
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">default"</span>
|
825
|
+
</code></pre></div></div>
|
840
826
|
|
841
827
|
<p>In this example, the <code class="highlighter-rouge">layout</code> is set to <code class="highlighter-rouge">default</code> inside the
|
842
828
|
<a href="../collections/">collection</a> with the name <code class="highlighter-rouge">my_collection</code>.</p>
|
@@ -845,35 +831,31 @@ The different types that are available to you are <code class="highlighter-rouge
|
|
845
831
|
|
846
832
|
<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>
|
847
833
|
|
848
|
-
<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
|
834
|
+
<p>You can see that in the second to last example above. First, we set the default page layout to <code class="highlighter-rouge">my-site</code>. Then, using a more specific path, we set the default layout for pages 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>
|
849
835
|
|
850
836
|
<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>
|
851
837
|
|
852
|
-
<div class="language-yaml highlighter-rouge">
|
853
|
-
<pre class="highlight"><code><span class="c1"># In _config.yml</span>
|
838
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In _config.yml</span>
|
854
839
|
<span class="nn">...</span>
|
855
|
-
<span class="
|
840
|
+
<span class="na">defaults</span><span class="pi">:</span>
|
856
841
|
<span class="pi">-</span>
|
857
|
-
<span class="
|
858
|
-
<span class="
|
859
|
-
<span class="
|
860
|
-
<span class="
|
861
|
-
<span class="
|
862
|
-
<span class="
|
863
|
-
<span class="
|
842
|
+
<span class="na">scope</span><span class="pi">:</span>
|
843
|
+
<span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">projects"</span>
|
844
|
+
<span class="na">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">pages"</span>
|
845
|
+
<span class="na">values</span><span class="pi">:</span>
|
846
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
|
847
|
+
<span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Mr.</span><span class="nv"> </span><span class="s">Hyde"</span>
|
848
|
+
<span class="na">category</span><span class="pi">:</span> <span class="s2">"</span><span class="s">project"</span>
|
864
849
|
<span class="nn">...</span>
|
865
|
-
</code></pre>
|
866
|
-
</div>
|
850
|
+
</code></pre></div></div>
|
867
851
|
|
868
|
-
<div class="language-yaml highlighter-rouge">
|
869
|
-
<pre class="highlight"><code><span class="c1"># In projects/foo_project.md</span>
|
852
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># In projects/foo_project.md</span>
|
870
853
|
<span class="nn">---</span>
|
871
|
-
<span class="
|
872
|
-
<span class="
|
854
|
+
<span class="na">author</span><span class="pi">:</span> <span class="s2">"</span><span class="s">John</span><span class="nv"> </span><span class="s">Smith"</span>
|
855
|
+
<span class="na">layout</span><span class="pi">:</span> <span class="s2">"</span><span class="s">foobar"</span>
|
873
856
|
<span class="nn">---</span>
|
874
857
|
<span class="s">The post text goes here...</span>
|
875
|
-
</code></pre>
|
876
|
-
</div>
|
858
|
+
</code></pre></div></div>
|
877
859
|
|
878
860
|
<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
|
879
861
|
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
|
@@ -894,80 +876,78 @@ file or on the command-line.</p>
|
|
894
876
|
</p>
|
895
877
|
</div>
|
896
878
|
|
897
|
-
<div class="language-yaml highlighter-rouge">
|
898
|
-
<
|
899
|
-
<span class="
|
900
|
-
<span class="
|
901
|
-
<span class="
|
902
|
-
<span class="
|
903
|
-
<span class="
|
904
|
-
<span class="
|
905
|
-
<span class="
|
906
|
-
|
907
|
-
<span class="s">output</span><span class="pi">:</span> <span class="s">true</span>
|
879
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Where things are</span>
|
880
|
+
<span class="na">source</span><span class="pi">:</span> <span class="s">.</span>
|
881
|
+
<span class="na">destination</span><span class="pi">:</span> <span class="s">./_site</span>
|
882
|
+
<span class="na">plugins_dir</span><span class="pi">:</span> <span class="s">_plugins</span>
|
883
|
+
<span class="na">layouts_dir</span><span class="pi">:</span> <span class="s">_layouts</span>
|
884
|
+
<span class="na">data_dir</span><span class="pi">:</span> <span class="s">_data</span>
|
885
|
+
<span class="na">includes_dir</span><span class="pi">:</span> <span class="s">_includes</span>
|
886
|
+
<span class="na">collections</span><span class="pi">:</span>
|
887
|
+
<span class="na">posts</span><span class="pi">:</span>
|
888
|
+
<span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
|
908
889
|
|
909
890
|
<span class="c1"># Handling Reading</span>
|
910
|
-
<span class="
|
911
|
-
<span class="
|
912
|
-
<span class="
|
913
|
-
<span class="
|
914
|
-
<span class="
|
915
|
-
<span class="
|
916
|
-
<span class="
|
891
|
+
<span class="na">safe</span><span class="pi">:</span> <span class="no">false</span>
|
892
|
+
<span class="na">include</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">.htaccess"</span><span class="pi">]</span>
|
893
|
+
<span class="na">exclude</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">Gemfile"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">Gemfile.lock"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">node_modules"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/bundle/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/cache/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/gems/"</span><span class="pi">,</span> <span class="s2">"</span><span class="s">vendor/ruby/"</span><span class="pi">]</span>
|
894
|
+
<span class="na">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>
|
895
|
+
<span class="na">encoding</span><span class="pi">:</span> <span class="s2">"</span><span class="s">utf-8"</span>
|
896
|
+
<span class="na">markdown_ext</span><span class="pi">:</span> <span class="s2">"</span><span class="s">markdown,mkdown,mkdn,mkd,md"</span>
|
897
|
+
<span class="na">strict_front_matter</span><span class="pi">:</span> <span class="no">false</span>
|
917
898
|
|
918
899
|
<span class="c1"># Filtering Content</span>
|
919
|
-
<span class="
|
920
|
-
<span class="
|
921
|
-
<span class="
|
922
|
-
<span class="
|
900
|
+
<span class="na">show_drafts</span><span class="pi">:</span> <span class="no">null</span>
|
901
|
+
<span class="na">limit_posts</span><span class="pi">:</span> <span class="s">0</span>
|
902
|
+
<span class="na">future</span><span class="pi">:</span> <span class="no">false</span>
|
903
|
+
<span class="na">unpublished</span><span class="pi">:</span> <span class="no">false</span>
|
923
904
|
|
924
905
|
<span class="c1"># Plugins</span>
|
925
|
-
<span class="
|
926
|
-
<span class="
|
906
|
+
<span class="na">whitelist</span><span class="pi">:</span> <span class="pi">[]</span>
|
907
|
+
<span class="na">plugins</span><span class="pi">:</span> <span class="pi">[]</span>
|
927
908
|
|
928
909
|
<span class="c1"># Conversion</span>
|
929
|
-
<span class="
|
930
|
-
<span class="
|
931
|
-
<span class="
|
932
|
-
<span class="
|
933
|
-
<span class="
|
910
|
+
<span class="na">markdown</span><span class="pi">:</span> <span class="s">kramdown</span>
|
911
|
+
<span class="na">highlighter</span><span class="pi">:</span> <span class="s">rouge</span>
|
912
|
+
<span class="na">lsi</span><span class="pi">:</span> <span class="no">false</span>
|
913
|
+
<span class="na">excerpt_separator</span><span class="pi">:</span> <span class="s2">"</span><span class="se">\n\n</span><span class="s">"</span>
|
914
|
+
<span class="na">incremental</span><span class="pi">:</span> <span class="no">false</span>
|
934
915
|
|
935
916
|
<span class="c1"># Serving</span>
|
936
|
-
<span class="
|
937
|
-
<span class="
|
938
|
-
<span class="
|
939
|
-
<span class="
|
940
|
-
<span class="
|
917
|
+
<span class="na">detach</span><span class="pi">:</span> <span class="no">false</span>
|
918
|
+
<span class="na">port</span><span class="pi">:</span> <span class="s">4000</span>
|
919
|
+
<span class="na">host</span><span class="pi">:</span> <span class="s">127.0.0.1</span>
|
920
|
+
<span class="na">baseurl</span><span class="pi">:</span> <span class="s2">"</span><span class="s">"</span> <span class="c1"># does not include hostname</span>
|
921
|
+
<span class="na">show_dir_listing</span><span class="pi">:</span> <span class="no">false</span>
|
941
922
|
|
942
923
|
<span class="c1"># Outputting</span>
|
943
|
-
<span class="
|
944
|
-
<span class="
|
945
|
-
<span class="
|
924
|
+
<span class="na">permalink</span><span class="pi">:</span> <span class="s">date</span>
|
925
|
+
<span class="na">paginate_path</span><span class="pi">:</span> <span class="s">/page:num</span>
|
926
|
+
<span class="na">timezone</span><span class="pi">:</span> <span class="no">null</span>
|
946
927
|
|
947
|
-
<span class="
|
948
|
-
<span class="
|
949
|
-
<span class="
|
928
|
+
<span class="na">quiet</span><span class="pi">:</span> <span class="no">false</span>
|
929
|
+
<span class="na">verbose</span><span class="pi">:</span> <span class="no">false</span>
|
930
|
+
<span class="na">defaults</span><span class="pi">:</span> <span class="pi">[]</span>
|
950
931
|
|
951
|
-
<span class="
|
952
|
-
<span class="
|
932
|
+
<span class="na">liquid</span><span class="pi">:</span>
|
933
|
+
<span class="na">error_mode</span><span class="pi">:</span> <span class="s">warn</span>
|
953
934
|
|
954
935
|
<span class="c1"># Markdown Processors</span>
|
955
|
-
<span class="
|
956
|
-
<span class="
|
957
|
-
|
958
|
-
<span class="
|
959
|
-
<span class="
|
960
|
-
|
961
|
-
<span class="
|
962
|
-
<span class="
|
963
|
-
<span class="
|
964
|
-
<span class="
|
965
|
-
<span class="
|
966
|
-
<span class="
|
967
|
-
<span class="
|
968
|
-
<span class="
|
969
|
-
</code></pre>
|
970
|
-
</div>
|
936
|
+
<span class="na">rdiscount</span><span class="pi">:</span>
|
937
|
+
<span class="na">extensions</span><span class="pi">:</span> <span class="pi">[]</span>
|
938
|
+
|
939
|
+
<span class="na">redcarpet</span><span class="pi">:</span>
|
940
|
+
<span class="na">extensions</span><span class="pi">:</span> <span class="pi">[]</span>
|
941
|
+
|
942
|
+
<span class="na">kramdown</span><span class="pi">:</span>
|
943
|
+
<span class="na">auto_ids</span><span class="pi">:</span> <span class="no">true</span>
|
944
|
+
<span class="na">entity_output</span><span class="pi">:</span> <span class="s">as_char</span>
|
945
|
+
<span class="na">toc_levels</span><span class="pi">:</span> <span class="s">1..6</span>
|
946
|
+
<span class="na">smart_quotes</span><span class="pi">:</span> <span class="s">lsquo,rsquo,ldquo,rdquo</span>
|
947
|
+
<span class="na">input</span><span class="pi">:</span> <span class="s">GFM</span>
|
948
|
+
<span class="na">hard_wrap</span><span class="pi">:</span> <span class="no">false</span>
|
949
|
+
<span class="na">footnote_nr</span><span class="pi">:</span> <span class="s">1</span>
|
950
|
+
</code></pre></div></div>
|
971
951
|
|
972
952
|
<h2 id="liquid-options">Liquid Options</h2>
|
973
953
|
|
@@ -1010,12 +990,10 @@ extension for disabling fenced code.</li>
|
|
1010
990
|
<p>Note that you can also specify a language for highlighting after the first
|
1011
991
|
delimiter:</p>
|
1012
992
|
|
1013
|
-
<div class="highlighter-rouge">
|
1014
|
-
<pre class="highlight"><code> ```ruby
|
993
|
+
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> ```ruby
|
1015
994
|
# ...ruby code
|
1016
995
|
```
|
1017
|
-
</code></pre>
|
1018
|
-
</div>
|
996
|
+
</code></pre></div></div>
|
1019
997
|
|
1020
998
|
<p>With both fenced code blocks and highlighter enabled, this will statically
|
1021
999
|
highlight the code; without any syntax highlighter, it will add a
|
@@ -1045,8 +1023,7 @@ extensions are:</p>
|
|
1045
1023
|
|
1046
1024
|
<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>
|
1047
1025
|
|
1048
|
-
<div class="language-ruby highlighter-rouge">
|
1049
|
-
<pre class="highlight"><code><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>
|
1026
|
+
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><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>
|
1050
1027
|
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
|
1051
1028
|
<span class="nb">require</span> <span class="s1">'funky_markdown'</span>
|
1052
1029
|
<span class="vi">@config</span> <span class="o">=</span> <span class="n">config</span>
|
@@ -1060,16 +1037,13 @@ extensions are:</p>
|
|
1060
1037
|
<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>
|
1061
1038
|
<span class="k">end</span>
|
1062
1039
|
<span class="k">end</span>
|
1063
|
-
</code></pre>
|
1064
|
-
</div>
|
1040
|
+
</code></pre></div></div>
|
1065
1041
|
|
1066
1042
|
<p>Once you’ve created your class and have it properly set up either as a plugin
|
1067
1043
|
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>
|
1068
1044
|
|
1069
|
-
<div class="language-yaml highlighter-rouge">
|
1070
|
-
|
1071
|
-
</code></pre>
|
1072
|
-
</div>
|
1045
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">markdown</span><span class="pi">:</span> <span class="s">MyCustomProcessor</span>
|
1046
|
+
</code></pre></div></div>
|
1073
1047
|
|
1074
1048
|
<h2 id="incremental-regeneration">Incremental Regeneration</h2>
|
1075
1049
|
<div class="note warning">
|
@@ -1090,7 +1064,7 @@ track of both file modification times and inter-document dependencies in the
|
|
1090
1064
|
<p>Under the current implementation, incremental regeneration will only generate a
|
1091
1065
|
document or page if either it, or one of its dependencies, is modified. Currently,
|
1092
1066
|
the only types of dependencies tracked are includes (using the
|
1093
|
-
<code class="highlighter-rouge"
|
1067
|
+
<code class="highlighter-rouge">{% include %}</code> tag) and layouts. This means that plain
|
1094
1068
|
references to other documents (for example, the common case of iterating over
|
1095
1069
|
<code class="highlighter-rouge">site.posts</code> in a post listings page) will not be detected as a dependency.</p>
|
1096
1070
|
|