jekyll-docs 3.6.2.0 → 3.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/jekyll-docs.rb +7 -5
- data/site/404.html +5 -6
- data/site/community/index.html +9 -297
- data/site/conduct/index.html +3 -2
- data/site/css/screen.css +1 -1
- data/site/docs/assets/index.html +46 -30
- data/site/docs/code_of_conduct/index.html +44 -28
- data/site/docs/collections/index.html +85 -48
- data/site/docs/conduct/index.html +44 -28
- data/site/docs/configuration/index.html +66 -35
- data/site/docs/continuous-integration/buddyworks/index.html +55 -39
- data/site/docs/continuous-integration/circleci/index.html +65 -49
- data/site/docs/continuous-integration/index.html +44 -28
- data/site/docs/continuous-integration/travis-ci/index.html +45 -29
- data/site/docs/contributing/index.html +53 -33
- data/site/docs/datafiles/index.html +71 -62
- data/site/docs/deployment-methods/index.html +49 -33
- data/site/docs/drafts/index.html +44 -28
- data/site/docs/extras/index.html +44 -28
- data/site/docs/frontmatter/index.html +55 -39
- data/site/docs/github-pages/index.html +107 -111
- data/site/docs/history/index.html +299 -115
- data/site/docs/home/index.html +45 -29
- data/site/docs/includes/index.html +51 -34
- data/site/docs/index.html +3 -2
- data/site/docs/installation/index.html +65 -49
- data/site/docs/maintaining/affinity-team-captain/index.html +46 -30
- data/site/docs/maintaining/avoiding-burnout/index.html +44 -28
- data/site/docs/maintaining/becoming-a-maintainer/index.html +45 -29
- data/site/docs/maintaining/index.html +44 -28
- data/site/docs/maintaining/merging-a-pull-request/index.html +45 -29
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +45 -29
- data/site/docs/maintaining/special-labels/index.html +44 -28
- data/site/docs/maintaining/triaging-an-issue/index.html +45 -29
- data/site/docs/migrations/index.html +44 -28
- data/site/docs/pages/index.html +48 -32
- data/site/docs/pagination/index.html +105 -84
- data/site/docs/permalinks/index.html +48 -32
- data/site/docs/plugins/index.html +97 -58
- data/site/docs/posts/index.html +126 -71
- data/site/docs/quickstart/index.html +48 -32
- data/site/docs/resources/index.html +46 -29
- data/site/docs/sites/index.html +44 -28
- data/site/docs/static-files/index.html +44 -28
- data/site/docs/structure/index.html +44 -28
- data/site/docs/support/index.html +725 -0
- data/site/docs/templates/index.html +77 -54
- data/site/docs/themes/index.html +63 -37
- data/site/docs/troubleshooting/index.html +56 -40
- data/site/docs/upgrading/0-to-2/index.html +45 -29
- data/site/docs/upgrading/2-to-3/index.html +50 -34
- data/site/docs/upgrading/index.html +63 -31
- data/site/docs/usage/index.html +68 -44
- data/site/docs/variables/index.html +44 -28
- data/site/docs/windows/index.html +66 -54
- data/site/feed.xml +81 -108
- data/site/github.html +3 -2
- data/site/help/index.html +66 -46
- data/site/img/jekyll-sticker.jpg +0 -0
- data/site/img/jekylllayoutconcept.png +0 -0
- data/site/img/twitter-card.png +0 -0
- data/site/index.html +43 -27
- data/site/issues.html +3 -2
- data/site/jekyllconf/index.html +315 -0
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +69 -33
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +69 -33
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +69 -33
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +69 -33
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +69 -33
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +81 -45
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +69 -33
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +69 -33
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +69 -33
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +69 -33
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +69 -33
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +69 -33
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +69 -33
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +69 -33
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +69 -33
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +69 -33
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +69 -33
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +69 -33
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +69 -33
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +69 -33
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +69 -33
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +69 -33
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +69 -33
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +69 -33
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +69 -33
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +69 -33
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +69 -33
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +70 -34
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +69 -33
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +69 -33
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +69 -33
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +70 -34
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +69 -33
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +70 -34
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +69 -33
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +69 -33
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +69 -33
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +69 -33
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +69 -33
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +71 -35
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +69 -33
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +69 -33
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +69 -33
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +69 -33
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +69 -33
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +69 -33
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +69 -33
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +69 -33
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +69 -33
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +69 -33
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +69 -33
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +70 -34
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +69 -33
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +69 -33
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +69 -33
- data/site/news/2017/01/02/jekyll-3-7-0-released/index.html +626 -0
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +69 -33
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +69 -33
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +69 -33
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +69 -33
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +71 -35
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +69 -33
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +69 -33
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +69 -33
- data/site/news/2017/10/19/diversity-open-source/index.html +631 -0
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +627 -0
- data/site/news/index.html +270 -49
- data/site/news/releases/index.html +204 -49
- data/site/redirects.json +1 -0
- data/site/sitemap.xml +77 -57
- data/site/tutorials/convert-site-to-jekyll/index.html +58 -31
- data/site/tutorials/custom-404-page/index.html +70 -42
- data/site/tutorials/home/index.html +53 -29
- data/site/tutorials/index.html +3 -2
- data/site/tutorials/navigation/index.html +70 -38
- data/site/tutorials/orderofinterpretation/index.html +61 -34
- data/site/tutorials/video-walkthroughs/index.html +352 -0
- metadata +17 -12
- data/site/CNAME +0 -1
- data/site/icomoon-selection.json +0 -96
- data/site/readme.md +0 -23
|
@@ -4,14 +4,16 @@
|
|
|
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.7.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
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
|
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
|
14
15
|
<title>Templates | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
+
<meta name="generator" content="Jekyll v3.7.0">
|
|
15
17
|
<meta property="og:title" content="Templates">
|
|
16
18
|
<meta property="og:locale" content="en_US">
|
|
17
19
|
<meta name="description" content="Jekyll uses the Liquid templating language to process templates. All of the standard Liquid tags and filters are supported. To make common tasks easier, Jekyll even adds a few handy filters and tags of its own, all of which you can find on this page. Jekyll even lets you come up with your own tags via plugins.">
|
|
@@ -20,12 +22,12 @@
|
|
|
20
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/templates/">
|
|
21
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
|
22
24
|
<meta property="og:type" content="article">
|
|
23
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
|
|
24
26
|
<meta name="twitter:card" content="summary">
|
|
25
27
|
<meta name="twitter:site" content="@jekyllrb">
|
|
26
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
|
27
29
|
<script type="application/ld+json">
|
|
28
|
-
{"
|
|
30
|
+
{"headline":"Templates","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/templates/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/templates/","description":"Jekyll uses the Liquid templating language to process templates. All of the standard Liquid tags and filters are supported. To make common tasks easier, Jekyll even adds a few handy filters and tags of its own, all of which you can find on this page. Jekyll even lets you come up with your own tags via plugins.","@type":"BlogPosting","@context":"http://schema.org"}</script>
|
|
29
31
|
<!-- End Jekyll SEO tag -->
|
|
30
32
|
|
|
31
33
|
<!--[if lt IE 9]>
|
|
@@ -37,8 +39,17 @@
|
|
|
37
39
|
|
|
38
40
|
<body class="wrap">
|
|
39
41
|
<header>
|
|
40
|
-
<
|
|
41
|
-
<
|
|
42
|
+
<div class="flexbox">
|
|
43
|
+
<div class="center-on-mobiles">
|
|
44
|
+
<h1>
|
|
45
|
+
<a href="/" class="logo">
|
|
46
|
+
<span class="sr-only">Jekyll</span>
|
|
47
|
+
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
|
48
|
+
</a>
|
|
49
|
+
</h1>
|
|
50
|
+
</div>
|
|
51
|
+
<nav class="main-nav hide-on-mobiles">
|
|
52
|
+
<ul>
|
|
42
53
|
<li class="">
|
|
43
54
|
<a href="/">Home</a>
|
|
44
55
|
</li>
|
|
@@ -48,29 +59,29 @@
|
|
|
48
59
|
<li class="">
|
|
49
60
|
<a href="/news/">News</a>
|
|
50
61
|
</li>
|
|
51
|
-
<li class="">
|
|
52
|
-
<a href="/community/">Community</a>
|
|
53
|
-
</li>
|
|
54
62
|
<li class="">
|
|
55
63
|
<a href="/help/">Help</a>
|
|
56
64
|
</li>
|
|
57
|
-
<li>
|
|
58
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
59
|
-
</li>
|
|
60
65
|
</ul>
|
|
61
66
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
<a href="/">
|
|
67
|
-
<span class="sr-only">Jekyll</span>
|
|
68
|
-
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
|
69
|
-
</a>
|
|
70
|
-
</h1>
|
|
67
|
+
</nav>
|
|
68
|
+
<div class="search hide-on-mobiles">
|
|
69
|
+
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
|
70
|
+
|
|
71
71
|
</div>
|
|
72
|
-
<
|
|
72
|
+
<div class="meta hide-on-mobiles">
|
|
73
73
|
<ul>
|
|
74
|
+
<li>
|
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
|
|
76
|
+
</li>
|
|
77
|
+
<li>
|
|
78
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
79
|
+
</li>
|
|
80
|
+
</ul>
|
|
81
|
+
</div>
|
|
82
|
+
</div>
|
|
83
|
+
<nav class="mobile-nav show-on-mobiles">
|
|
84
|
+
<ul>
|
|
74
85
|
<li class="">
|
|
75
86
|
<a href="/">Home</a>
|
|
76
87
|
</li>
|
|
@@ -80,9 +91,6 @@
|
|
|
80
91
|
<li class="">
|
|
81
92
|
<a href="/news/">News</a>
|
|
82
93
|
</li>
|
|
83
|
-
<li class="">
|
|
84
|
-
<a href="/community/">Community</a>
|
|
85
|
-
</li>
|
|
86
94
|
<li class="">
|
|
87
95
|
<a href="/help/">Help</a>
|
|
88
96
|
</li>
|
|
@@ -91,8 +99,7 @@
|
|
|
91
99
|
</li>
|
|
92
100
|
</ul>
|
|
93
101
|
|
|
94
|
-
|
|
95
|
-
</div>
|
|
102
|
+
</nav>
|
|
96
103
|
</header>
|
|
97
104
|
|
|
98
105
|
|
|
@@ -579,6 +586,18 @@ you come up with your own tags via plugins.</p>
|
|
|
579
586
|
<p>
|
|
580
587
|
<code class="output">the-_config.yml-file</code>
|
|
581
588
|
</p>
|
|
589
|
+
<p>
|
|
590
|
+
<code class="filter">{{ "The _cönfig.yml file" | slugify: 'ascii' }}</code>
|
|
591
|
+
</p>
|
|
592
|
+
<p>
|
|
593
|
+
<code class="output">the-c-nfig-yml-file</code>
|
|
594
|
+
</p>
|
|
595
|
+
<p>
|
|
596
|
+
<code class="filter">{{ "The cönfig.yml file" | slugify: 'latin' }}</code>
|
|
597
|
+
</p>
|
|
598
|
+
<p>
|
|
599
|
+
<code class="output">the-config-yml-file</code>
|
|
600
|
+
</p>
|
|
582
601
|
</td>
|
|
583
602
|
</tr>
|
|
584
603
|
<tr>
|
|
@@ -708,11 +727,12 @@ The default is <code class="highlighter-rouge">default</code>. They are as follo
|
|
|
708
727
|
<li>
|
|
709
728
|
<code class="highlighter-rouge">pretty</code>: spaces and non-alphanumeric characters except for <code class="highlighter-rouge">._~!$&'()+,;=@</code>
|
|
710
729
|
</li>
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
<
|
|
714
|
-
|
|
715
|
-
<
|
|
730
|
+
<li>
|
|
731
|
+
<code class="highlighter-rouge">ascii</code>: spaces, non-alphanumeric, and non-ASCII characters</li>
|
|
732
|
+
<li>
|
|
733
|
+
<code class="highlighter-rouge">latin</code>: like <code class="highlighter-rouge">default</code>, except Latin characters are first transliterated (e.g. <code class="highlighter-rouge">àèïòü</code> to <code class="highlighter-rouge">aeiou</code>)<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span>
|
|
734
|
+
<h2 id="tags">Tags</h2>
|
|
735
|
+
</li>
|
|
716
736
|
<li><a href="#includes">Includes</a></li>
|
|
717
737
|
<li><a href="#code-snippet-highlighting">Code snippet highlighting</a></li>
|
|
718
738
|
<li><a href="#links">Linking to pages, collections and posts (the new and improved way)</a></li>
|
|
@@ -745,13 +765,11 @@ languages</a></p>
|
|
|
745
765
|
|
|
746
766
|
<p>To render a code block with syntax highlighting, surround your code as follows:</p>
|
|
747
767
|
|
|
748
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
749
|
-
<span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span><span class="p">%}</span>
|
|
768
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span><span class="p">%}</span>
|
|
750
769
|
def foo
|
|
751
770
|
puts 'foo'
|
|
752
771
|
end
|
|
753
772
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endhighlight</span><span class="w"> </span><span class="p">%}</span>
|
|
754
|
-
|
|
755
773
|
</code></pre></div></div>
|
|
756
774
|
|
|
757
775
|
<p>The argument to the <code class="highlighter-rouge">highlight</code> tag (<code class="highlighter-rouge">ruby</code> in the example above) is the
|
|
@@ -760,6 +778,13 @@ you want to highlight, look for the “short name” on the <a href="https://git
|
|
|
760
778
|
wiki</a>
|
|
761
779
|
or the <a href="http://pygments.org/docs/lexers/">Pygments’ Lexers page</a>.</p>
|
|
762
780
|
|
|
781
|
+
<div class="note info">
|
|
782
|
+
<h5>Jekyll processes all Liquid filters in code blocks</h5>
|
|
783
|
+
<p>If you are using a language that contains curly braces, you
|
|
784
|
+
will likely need to place <code>{% raw %}</code> and
|
|
785
|
+
<code>{% endraw %}</code> tags around your code.</p>
|
|
786
|
+
</div>
|
|
787
|
+
|
|
763
788
|
<h4 id="line-numbers">Line numbers</h4>
|
|
764
789
|
|
|
765
790
|
<p>There is a second argument to <code class="highlighter-rouge">highlight</code> called <code class="highlighter-rouge">linenos</code> that is optional.
|
|
@@ -767,13 +792,11 @@ Including the <code class="highlighter-rouge">linenos</code> argument will force
|
|
|
767
792
|
numbers. For instance, the following code block would include line numbers next
|
|
768
793
|
to each line:</p>
|
|
769
794
|
|
|
770
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
771
|
-
<span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span>linenos<span class="w"> </span><span class="p">%}</span>
|
|
795
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span>linenos<span class="w"> </span><span class="p">%}</span>
|
|
772
796
|
def foo
|
|
773
797
|
puts 'foo'
|
|
774
798
|
end
|
|
775
799
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endhighlight</span><span class="w"> </span><span class="p">%}</span>
|
|
776
|
-
|
|
777
800
|
</code></pre></div></div>
|
|
778
801
|
|
|
779
802
|
<h4 id="stylesheets-for-syntax-highlighting">Stylesheets for syntax highlighting</h4>
|
|
@@ -794,22 +817,18 @@ numbers from the highlighted code.</p>
|
|
|
794
817
|
|
|
795
818
|
<p>You must include the file’s original extension when using the <code class="highlighter-rouge">link</code> tag. Here are some examples:</p>
|
|
796
819
|
|
|
797
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
798
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>
|
|
820
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>
|
|
799
821
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>
|
|
800
822
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>news/index.html<span class="w"> </span><span class="p">%}</span>
|
|
801
823
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>/assets/files/doc.pdf<span class="w"> </span><span class="p">%}</span>
|
|
802
|
-
|
|
803
824
|
</code></pre></div></div>
|
|
804
825
|
|
|
805
826
|
<p>You can also use the <code class="highlighter-rouge">link</code> tag to create a link in Markdown as follows:</p>
|
|
806
827
|
|
|
807
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
808
|
-
[Link to a document](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>)
|
|
828
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>[Link to a document](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>)
|
|
809
829
|
[Link to a post](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>)
|
|
810
830
|
[Link to a page](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>news/index.html<span class="w"> </span><span class="p">%}</span>)
|
|
811
831
|
[Link to a file](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>/assets/files/doc.pdf<span class="w"> </span><span class="p">%}</span>)
|
|
812
|
-
|
|
813
832
|
</code></pre></div></div>
|
|
814
833
|
|
|
815
834
|
<p>(Including <code class="highlighter-rouge">{{ site.baseurl }}</code> is optional — it depends on whether you want to preface the page URL with the <code class="highlighter-rouge">baseurl</code> value.)</p>
|
|
@@ -828,27 +847,22 @@ numbers from the highlighted code.</p>
|
|
|
828
847
|
|
|
829
848
|
<p>If you want to include a link to a post on your site, the <code class="highlighter-rouge">post_url</code> tag will generate the correct permalink URL for the post you specify.</p>
|
|
830
849
|
|
|
831
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
832
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
|
833
|
-
|
|
850
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
|
834
851
|
</code></pre></div></div>
|
|
835
852
|
|
|
836
853
|
<p>If you organize your posts in subdirectories, you need to include subdirectory path to the post:</p>
|
|
837
854
|
|
|
838
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
839
|
-
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span>/subdir/<span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
|
840
|
-
|
|
855
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span>/subdir/<span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
|
841
856
|
</code></pre></div></div>
|
|
842
857
|
|
|
843
858
|
<p>There is no need to include the file extension when using the <code class="highlighter-rouge">post_url</code> tag.</p>
|
|
844
859
|
|
|
845
860
|
<p>You can also use this tag to create a link to a post in Markdown as follows:</p>
|
|
846
861
|
|
|
847
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
848
|
-
[Name of Link](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>)
|
|
849
|
-
|
|
862
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>[Name of Link](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>)
|
|
850
863
|
</code></pre></div></div>
|
|
851
864
|
|
|
865
|
+
|
|
852
866
|
|
|
853
867
|
|
|
854
868
|
|
|
@@ -1125,7 +1139,7 @@ numbers from the highlighted code.</p>
|
|
|
1125
1139
|
<footer>
|
|
1126
1140
|
<div class="grid">
|
|
1127
1141
|
<div class="unit one-third center-on-mobiles">
|
|
1128
|
-
<p>The contents of this website are <br>©
|
|
1142
|
+
<p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
1129
1143
|
</div>
|
|
1130
1144
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
1131
1145
|
<p>
|
|
@@ -1203,6 +1217,15 @@ numbers from the highlighted code.</p>
|
|
|
1203
1217
|
</script>
|
|
1204
1218
|
|
|
1205
1219
|
|
|
1220
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
|
1221
|
+
<script type="text/javascript"> docsearch({
|
|
1222
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
|
1223
|
+
indexName: 'jekyllrb',
|
|
1224
|
+
inputSelector: '#docsearch-input',
|
|
1225
|
+
enhancedSearchInput: true,
|
|
1226
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
|
1227
|
+
});
|
|
1228
|
+
</script>
|
|
1206
1229
|
|
|
1207
1230
|
</body>
|
|
1208
1231
|
</html>
|
data/site/docs/themes/index.html
CHANGED
|
@@ -4,14 +4,16 @@
|
|
|
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.7.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
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
|
|
11
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
12
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.4.0 -->
|
|
14
15
|
<title>Themes | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
+
<meta name="generator" content="Jekyll v3.7.0">
|
|
15
17
|
<meta property="og:title" content="Themes">
|
|
16
18
|
<meta property="og:locale" content="en_US">
|
|
17
19
|
<meta name="description" content="Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site’s content.">
|
|
@@ -20,12 +22,12 @@
|
|
|
20
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/themes/">
|
|
21
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
|
22
24
|
<meta property="og:type" content="article">
|
|
23
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2018-01-03T02:41:17-08:00">
|
|
24
26
|
<meta name="twitter:card" content="summary">
|
|
25
27
|
<meta name="twitter:site" content="@jekyllrb">
|
|
26
28
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
|
27
29
|
<script type="application/ld+json">
|
|
28
|
-
{"
|
|
30
|
+
{"headline":"Themes","dateModified":"2018-01-03T02:41:17-08:00","datePublished":"2018-01-03T02:41:17-08:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/themes/"},"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/docs/themes/","description":"Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site’s content.","@type":"BlogPosting","@context":"http://schema.org"}</script>
|
|
29
31
|
<!-- End Jekyll SEO tag -->
|
|
30
32
|
|
|
31
33
|
<!--[if lt IE 9]>
|
|
@@ -37,8 +39,17 @@
|
|
|
37
39
|
|
|
38
40
|
<body class="wrap">
|
|
39
41
|
<header>
|
|
40
|
-
<
|
|
41
|
-
<
|
|
42
|
+
<div class="flexbox">
|
|
43
|
+
<div class="center-on-mobiles">
|
|
44
|
+
<h1>
|
|
45
|
+
<a href="/" class="logo">
|
|
46
|
+
<span class="sr-only">Jekyll</span>
|
|
47
|
+
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
|
48
|
+
</a>
|
|
49
|
+
</h1>
|
|
50
|
+
</div>
|
|
51
|
+
<nav class="main-nav hide-on-mobiles">
|
|
52
|
+
<ul>
|
|
42
53
|
<li class="">
|
|
43
54
|
<a href="/">Home</a>
|
|
44
55
|
</li>
|
|
@@ -48,29 +59,29 @@
|
|
|
48
59
|
<li class="">
|
|
49
60
|
<a href="/news/">News</a>
|
|
50
61
|
</li>
|
|
51
|
-
<li class="">
|
|
52
|
-
<a href="/community/">Community</a>
|
|
53
|
-
</li>
|
|
54
62
|
<li class="">
|
|
55
63
|
<a href="/help/">Help</a>
|
|
56
64
|
</li>
|
|
57
|
-
<li>
|
|
58
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
59
|
-
</li>
|
|
60
65
|
</ul>
|
|
61
66
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
<a href="/">
|
|
67
|
-
<span class="sr-only">Jekyll</span>
|
|
68
|
-
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
|
69
|
-
</a>
|
|
70
|
-
</h1>
|
|
67
|
+
</nav>
|
|
68
|
+
<div class="search hide-on-mobiles">
|
|
69
|
+
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
|
70
|
+
|
|
71
71
|
</div>
|
|
72
|
-
<
|
|
72
|
+
<div class="meta hide-on-mobiles">
|
|
73
73
|
<ul>
|
|
74
|
+
<li>
|
|
75
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.7.0">v3.7.0</a>
|
|
76
|
+
</li>
|
|
77
|
+
<li>
|
|
78
|
+
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
79
|
+
</li>
|
|
80
|
+
</ul>
|
|
81
|
+
</div>
|
|
82
|
+
</div>
|
|
83
|
+
<nav class="mobile-nav show-on-mobiles">
|
|
84
|
+
<ul>
|
|
74
85
|
<li class="">
|
|
75
86
|
<a href="/">Home</a>
|
|
76
87
|
</li>
|
|
@@ -80,9 +91,6 @@
|
|
|
80
91
|
<li class="">
|
|
81
92
|
<a href="/news/">News</a>
|
|
82
93
|
</li>
|
|
83
|
-
<li class="">
|
|
84
|
-
<a href="/community/">Community</a>
|
|
85
|
-
</li>
|
|
86
94
|
<li class="">
|
|
87
95
|
<a href="/help/">Help</a>
|
|
88
96
|
</li>
|
|
@@ -91,8 +99,7 @@
|
|
|
91
99
|
</li>
|
|
92
100
|
</ul>
|
|
93
101
|
|
|
94
|
-
|
|
95
|
-
</div>
|
|
102
|
+
</nav>
|
|
96
103
|
</header>
|
|
97
104
|
|
|
98
105
|
|
|
@@ -333,7 +340,7 @@
|
|
|
333
340
|
<li>
|
|
334
341
|
<p>Open the theme’s directory in Finder or Explorer:</p>
|
|
335
342
|
|
|
336
|
-
<div class="language-
|
|
343
|
+
<div class="language-sh highlighter-rouge">
|
|
337
344
|
<div class="highlight"><pre class="highlight"><code><span class="c"># On MacOS</span>
|
|
338
345
|
open <span class="k">$(</span>bundle show minima<span class="k">)</span>
|
|
339
346
|
<span class="c"># On Windows</span>
|
|
@@ -418,22 +425,32 @@ explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
|
|
|
418
425
|
<li>
|
|
419
426
|
<p>Add the theme to your site’s <code class="highlighter-rouge">Gemfile</code>:</p>
|
|
420
427
|
|
|
421
|
-
<div class="language-
|
|
422
|
-
<div class="highlight"><pre class="highlight"><code
|
|
428
|
+
<div class="language-ruby highlighter-rouge">
|
|
429
|
+
<div class="highlight"><pre class="highlight"><code><span class="c1"># ./Gemfile</span>
|
|
430
|
+
|
|
431
|
+
<span class="n">gem</span> <span class="s2">"jekyll-theme-awesome"</span>
|
|
423
432
|
</code></pre></div> </div>
|
|
433
|
+
<p>Or if you’ve started with the <code class="highlighter-rouge">jekyll new</code> command, replace <code class="highlighter-rouge">gem "minima", "~> 2.0"</code> with your theme-gem:</p>
|
|
434
|
+
|
|
435
|
+
<div class="language-diff highlighter-rouge">
|
|
436
|
+
<div class="highlight"><pre class="highlight"><code># ./Gemfile
|
|
437
|
+
|
|
438
|
+
<span class="gd">- gem "minima", "~> 2.0"
|
|
439
|
+
</span><span class="gi">+ gem "jekyll-theme-awesome"
|
|
440
|
+
</span></code></pre></div> </div>
|
|
424
441
|
</li>
|
|
425
442
|
<li>
|
|
426
443
|
<p>Install the theme:</p>
|
|
427
444
|
|
|
428
445
|
<div class="language-sh highlighter-rouge">
|
|
429
|
-
<div class="highlight"><pre class="highlight"><code>bundle install
|
|
446
|
+
<div class="highlight"><pre class="highlight"><code>bundle <span class="nb">install</span>
|
|
430
447
|
</code></pre></div> </div>
|
|
431
448
|
</li>
|
|
432
449
|
<li>
|
|
433
450
|
<p>Add the following to your site’s <code class="highlighter-rouge">_config.yml</code> to activate the theme:</p>
|
|
434
451
|
|
|
435
|
-
<div class="language-
|
|
436
|
-
<div class="highlight"><pre class="highlight"><code>theme
|
|
452
|
+
<div class="language-yaml highlighter-rouge">
|
|
453
|
+
<div class="highlight"><pre class="highlight"><code><span class="na">theme</span><span class="pi">:</span> <span class="s">jekyll-theme-awesome</span>
|
|
437
454
|
</code></pre></div> </div>
|
|
438
455
|
</li>
|
|
439
456
|
<li>
|
|
@@ -508,9 +525,9 @@ For <span class="nb">help </span>getting started, <span class="nb">read</span> /
|
|
|
508
525
|
<div class="language-css highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">@import</span> <span class="s1">"{{ site.theme }}"</span><span class="p">;</span>
|
|
509
526
|
</code></pre></div></div>
|
|
510
527
|
|
|
511
|
-
<h3 id="theme-gem-
|
|
512
|
-
|
|
513
|
-
<p>
|
|
528
|
+
<h3 id="theme-gem-dependencies350">Theme-gem dependencies<span class="version-badge" title="This feature is available starting version 3.5.0">3.5.0</span>
|
|
529
|
+
</h3>
|
|
530
|
+
<p>Jekyll will automatically require all whitelisted <code class="highlighter-rouge">runtime_dependencies</code> of your theme-gem even if they’re not explicitly included under the <code class="highlighter-rouge">plugins</code> array in the site’s config file. (Note: whitelisting is only required when building or serving with the <code class="highlighter-rouge">--safe</code> option.)</p>
|
|
514
531
|
|
|
515
532
|
<p>With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.</p>
|
|
516
533
|
|
|
@@ -852,7 +869,7 @@ git commit <span class="nt">-m</span> <span class="s2">"Init commit"</span>
|
|
|
852
869
|
<footer>
|
|
853
870
|
<div class="grid">
|
|
854
871
|
<div class="unit one-third center-on-mobiles">
|
|
855
|
-
<p>The contents of this website are <br>©
|
|
872
|
+
<p>The contents of this website are <br>© 2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
856
873
|
</div>
|
|
857
874
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
858
875
|
<p>
|
|
@@ -930,6 +947,15 @@ git commit <span class="nt">-m</span> <span class="s2">"Init commit"</span>
|
|
|
930
947
|
</script>
|
|
931
948
|
|
|
932
949
|
|
|
950
|
+
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
|
951
|
+
<script type="text/javascript"> docsearch({
|
|
952
|
+
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
|
953
|
+
indexName: 'jekyllrb',
|
|
954
|
+
inputSelector: '#docsearch-input',
|
|
955
|
+
enhancedSearchInput: true,
|
|
956
|
+
debug: false // Set debug to true if you want to inspect the dropdown
|
|
957
|
+
});
|
|
958
|
+
</script>
|
|
933
959
|
|
|
934
960
|
</body>
|
|
935
961
|
</html>
|