jekyll-docs 3.8.1 → 3.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/site/404.html +5 -4
- data/site/community/index.html +1 -1
- data/site/conduct/index.html +1 -1
- data/site/docs/assets/index.html +35 -35
- data/site/docs/code_of_conduct/index.html +8 -7
- data/site/docs/collections/index.html +44 -43
- data/site/docs/conduct/index.html +8 -7
- data/site/docs/configuration/index.html +81 -81
- data/site/docs/continuous-integration/buddyworks/index.html +10 -9
- data/site/docs/continuous-integration/circleci/index.html +13 -12
- data/site/docs/continuous-integration/index.html +8 -7
- data/site/docs/continuous-integration/travis-ci/index.html +32 -31
- data/site/docs/contributing/index.html +47 -47
- data/site/docs/datafiles/index.html +24 -23
- data/site/docs/deployment-methods/index.html +30 -29
- data/site/docs/drafts/index.html +11 -10
- data/site/docs/extras/index.html +9 -8
- data/site/docs/frontmatter/index.html +8 -7
- data/site/docs/github-pages/index.html +32 -32
- data/site/docs/history/index.html +722 -656
- data/site/docs/home/index.html +8 -7
- data/site/docs/includes/index.html +44 -43
- data/site/docs/index.html +1 -1
- data/site/docs/installation/index.html +16 -15
- data/site/docs/maintaining/affinity-team-captain/index.html +24 -24
- data/site/docs/maintaining/avoiding-burnout/index.html +8 -7
- data/site/docs/maintaining/becoming-a-maintainer/index.html +22 -22
- data/site/docs/maintaining/index.html +8 -7
- data/site/docs/maintaining/merging-a-pull-request/index.html +36 -36
- data/site/docs/maintaining/releasing-a-new-version/index.html +32 -32
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +23 -23
- data/site/docs/maintaining/special-labels/index.html +27 -27
- data/site/docs/maintaining/triaging-an-issue/index.html +25 -25
- data/site/docs/migrations/index.html +9 -8
- data/site/docs/pages/index.html +12 -11
- data/site/docs/pagination/index.html +25 -24
- data/site/docs/permalinks/index.html +33 -32
- data/site/docs/plugins/index.html +70 -70
- data/site/docs/posts/index.html +50 -50
- data/site/docs/quickstart/index.html +18 -17
- data/site/docs/resources/index.html +9 -8
- data/site/docs/sites/index.html +8 -7
- data/site/docs/static-files/index.html +14 -13
- data/site/docs/structure/index.html +8 -7
- data/site/docs/support/index.html +9 -8
- data/site/docs/templates/index.html +44 -43
- data/site/docs/themes/index.html +76 -76
- data/site/docs/troubleshooting/index.html +48 -47
- data/site/docs/upgrading/0-to-2/index.html +51 -50
- data/site/docs/upgrading/2-to-3/index.html +35 -34
- data/site/docs/upgrading/index.html +11 -10
- data/site/docs/usage/index.html +15 -14
- data/site/docs/variables/index.html +8 -7
- data/site/docs/windows/index.html +29 -28
- data/site/feed.xml +53 -65
- data/site/github.html +1 -1
- data/site/help/index.html +19 -19
- data/site/index.html +7 -6
- data/site/issues.html +1 -1
- data/site/jekyllconf/index.html +9 -8
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +42 -29
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +27 -13
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +28 -14
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +29 -15
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +28 -14
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +25 -11
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +27 -13
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +27 -13
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +30 -16
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +28 -14
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +25 -11
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +34 -20
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +26 -12
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +26 -12
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +25 -11
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +27 -13
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +43 -30
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +26 -12
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +43 -30
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +46 -33
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +25 -11
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +42 -29
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +30 -16
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +27 -13
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +26 -12
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +33 -19
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +32 -18
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +48 -35
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +25 -11
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +27 -13
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +42 -29
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +25 -11
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +42 -29
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +25 -11
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +42 -29
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +30 -16
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +29 -15
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +27 -13
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +30 -16
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +47 -34
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +26 -12
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +27 -13
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +25 -11
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +26 -12
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +26 -12
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +25 -11
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +31 -17
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +26 -12
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +26 -12
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +42 -29
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +29 -15
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +43 -30
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +42 -29
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +51 -37
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +26 -12
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +27 -13
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +43 -30
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +47 -34
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +52 -39
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +51 -38
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +27 -13
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +30 -16
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +26 -12
- data/site/news/2017/10/19/diversity-open-source/index.html +27 -13
- data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +45 -32
- data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +48 -35
- data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +53 -40
- data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +42 -29
- data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +50 -37
- data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +47 -34
- data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +620 -0
- data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +615 -0
- data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +623 -0
- data/site/news/index.html +351 -230
- data/site/news/releases/index.html +349 -228
- data/site/philosophy.html +1 -1
- data/site/sitemap.xml +72 -60
- data/site/team/index.html +19 -19
- data/site/tutorials/convert-site-to-jekyll/index.html +97 -96
- data/site/tutorials/custom-404-page/index.html +16 -15
- data/site/tutorials/home/index.html +10 -9
- data/site/tutorials/index.html +1 -1
- data/site/tutorials/navigation/index.html +102 -101
- data/site/tutorials/orderofinterpretation/index.html +32 -31
- data/site/tutorials/using-jekyll-with-bundler/index.html +19 -18
- data/site/tutorials/video-walkthroughs/index.html +8 -7
- metadata +13 -25
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
|
9
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Static Files | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Static Files" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="In addition to renderable and convertible content, we also have static files." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/static-files/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Static Files" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/static-files/","headline":"Static Files","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"In addition to renderable and convertible content, we also have static files.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/static-files/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -300,7 +301,7 @@ files</strong>.</p>
|
|
|
300
301
|
<p>A static file is a file that does not contain any YAML front matter. These
|
|
301
302
|
include images, PDFs, and other un-rendered content.</p>
|
|
302
303
|
|
|
303
|
-
<p>They’re accessible in Liquid via <code class="highlighter-rouge">site.static_files</code> and contain the
|
|
304
|
+
<p>They’re accessible in Liquid via <code class="language-plaintext highlighter-rouge">site.static_files</code> and contain the
|
|
304
305
|
following metadata:</p>
|
|
305
306
|
|
|
306
307
|
<div class="mobile-side-scroller">
|
|
@@ -357,7 +358,7 @@ following metadata:</p>
|
|
|
357
358
|
</table>
|
|
358
359
|
</div>
|
|
359
360
|
|
|
360
|
-
<p>Note that in the above table, <code class="highlighter-rouge">file</code> can be anything. It’s simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn’t a global site or page variable.</p>
|
|
361
|
+
<p>Note that in the above table, <code class="language-plaintext highlighter-rouge">file</code> can be anything. It’s simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn’t a global site or page variable.</p>
|
|
361
362
|
|
|
362
363
|
<h2 id="add-front-matter-to-static-files">Add front matter to static files</h2>
|
|
363
364
|
|
|
@@ -365,7 +366,7 @@ following metadata:</p>
|
|
|
365
366
|
|
|
366
367
|
<p>Here’s an example:</p>
|
|
367
368
|
|
|
368
|
-
<p>In your <code class="highlighter-rouge">_config.yml</code> file, add the following values to the <code class="highlighter-rouge">defaults</code> property:</p>
|
|
369
|
+
<p>In your <code class="language-plaintext highlighter-rouge">_config.yml</code> file, add the following values to the <code class="language-plaintext highlighter-rouge">defaults</code> property:</p>
|
|
369
370
|
|
|
370
371
|
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
|
371
372
|
<span class="pi">-</span> <span class="na">scope</span><span class="pi">:</span>
|
|
@@ -374,12 +375,12 @@ following metadata:</p>
|
|
|
374
375
|
<span class="na">image</span><span class="pi">:</span> <span class="no">true</span>
|
|
375
376
|
</code></pre></div></div>
|
|
376
377
|
|
|
377
|
-
<p>This assumes that your Jekyll site has a folder path of <code class="highlighter-rouge">assets/img</code> where you have images (static files) stored. When Jekyll builds the site, it will treat each image as if it had the front matter value of <code class="highlighter-rouge">image: true</code>.</p>
|
|
378
|
+
<p>This assumes that your Jekyll site has a folder path of <code class="language-plaintext highlighter-rouge">assets/img</code> where you have images (static files) stored. When Jekyll builds the site, it will treat each image as if it had the front matter value of <code class="language-plaintext highlighter-rouge">image: true</code>.</p>
|
|
378
379
|
|
|
379
|
-
<p>Suppose you want to list all your image assets as contained in <code class="highlighter-rouge">assets/img</code>. You could use this for loop to look in the <code class="highlighter-rouge">static_files</code> object and get all static files that have this front matter property:</p>
|
|
380
|
+
<p>Suppose you want to list all your image assets as contained in <code class="language-plaintext highlighter-rouge">assets/img</code>. You could use this for loop to look in the <code class="language-plaintext highlighter-rouge">static_files</code> object and get all static files that have this front matter property:</p>
|
|
380
381
|
|
|
381
382
|
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">assign</span><span class="w"> </span><span class="nv">image_files</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">static_files</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">where</span><span class="p">:</span><span class="w"> </span><span class="s2">"image"</span><span class="p">,</span><span class="w"> </span><span class="kc">true</span><span class="w"> </span><span class="p">%}</span>
|
|
382
|
-
<span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span>myimage
|
|
383
|
+
<span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span><span class="nv">myimage</span><span class="w"> </span><span class="nt">in</span><span class="w"> </span><span class="nv">image_files</span><span class="w"> </span><span class="p">%}</span>
|
|
383
384
|
<span class="p">{{</span><span class="w"> </span><span class="nv">myimage</span><span class="p">.</span><span class="nv">path</span><span class="w"> </span><span class="p">}}</span>
|
|
384
385
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endfor</span><span class="w"> </span><span class="p">%}</span>
|
|
385
386
|
</code></pre></div></div>
|
|
@@ -644,7 +645,7 @@ following metadata:</p>
|
|
|
644
645
|
<footer>
|
|
645
646
|
<div class="grid">
|
|
646
647
|
<div class="unit one-third center-on-mobiles">
|
|
647
|
-
<p>The contents of this website are <br />©
|
|
648
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
648
649
|
</div>
|
|
649
650
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
650
651
|
<p>
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
|
9
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Directory structure | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Directory structure" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/structure/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Directory structure" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"description":"Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product.","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/structure/","headline":"Directory structure","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/structure/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -746,7 +747,7 @@ product.</p>
|
|
|
746
747
|
<footer>
|
|
747
748
|
<div class="grid">
|
|
748
749
|
<div class="unit one-third center-on-mobiles">
|
|
749
|
-
<p>The contents of this website are <br />©
|
|
750
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
750
751
|
</div>
|
|
751
752
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
752
753
|
<p>
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
|
9
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Support | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Support" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
19
|
<meta name="description" content="Getting Help" />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/support/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Support" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/support/","headline":"Support","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Getting Help","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/support/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -311,7 +312,7 @@
|
|
|
311
312
|
<h2 id="report-a-bug">Report a bug</h2>
|
|
312
313
|
|
|
313
314
|
<ul>
|
|
314
|
-
<li>If you think you’ve found a bug within a Jekyll plugin, open an issue in that plugin’s repository — First <a href="https://rubygems.org/">look for the plugin on rubygems</a> then click on the <code class="highlighter-rouge">Homepage</code> link to access the plugin repository.</li>
|
|
315
|
+
<li>If you think you’ve found a bug within a Jekyll plugin, open an issue in that plugin’s repository — First <a href="https://rubygems.org/">look for the plugin on rubygems</a> then click on the <code class="language-plaintext highlighter-rouge">Homepage</code> link to access the plugin repository.</li>
|
|
315
316
|
<li>If you think you’ve found a bug within Jekyll itself, <a href="https://github.com/jekyll/jekyll/issues/new">open an issue</a>.</li>
|
|
316
317
|
</ul>
|
|
317
318
|
|
|
@@ -630,7 +631,7 @@
|
|
|
630
631
|
<footer>
|
|
631
632
|
<div class="grid">
|
|
632
633
|
<div class="unit one-third center-on-mobiles">
|
|
633
|
-
<p>The contents of this website are <br />©
|
|
634
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
634
635
|
</div>
|
|
635
636
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
636
637
|
<p>
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
6
|
-
<meta name="generator" content="Jekyll v3.
|
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
|
7
7
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
|
8
8
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
|
9
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
@@ -11,9 +11,9 @@
|
|
|
11
11
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
12
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
13
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
14
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
15
15
|
<title>Templates | Jekyll • Simple, blog-aware, static sites</title>
|
|
16
|
-
<meta name="generator" content="Jekyll v3.
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
17
|
<meta property="og:title" content="Templates" />
|
|
18
18
|
<meta property="og:locale" content="en_US" />
|
|
19
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." />
|
|
@@ -22,12 +22,13 @@
|
|
|
22
22
|
<meta property="og:url" content="https://jekyllrb.com/docs/templates/" />
|
|
23
23
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
24
|
<meta property="og:type" content="article" />
|
|
25
|
-
<meta property="article:published_time" content="
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
26
|
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Templates" />
|
|
27
28
|
<meta name="twitter:site" content="@jekyllrb" />
|
|
28
29
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
29
30
|
<script type="application/ld+json">
|
|
30
|
-
{"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.","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/templates/","headline":"Templates","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"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.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/templates/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
31
32
|
<!-- End Jekyll SEO tag -->
|
|
32
33
|
|
|
33
34
|
<!--[if lt IE 9]>
|
|
@@ -72,7 +73,7 @@
|
|
|
72
73
|
<div class="meta hide-on-mobiles">
|
|
73
74
|
<ul>
|
|
74
75
|
<li>
|
|
75
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
76
77
|
</li>
|
|
77
78
|
<li>
|
|
78
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -738,18 +739,18 @@ you come up with your own tags via plugins.</p>
|
|
|
738
739
|
</table>
|
|
739
740
|
</div>
|
|
740
741
|
|
|
741
|
-
<h3 id="options-for-the-slugify-filter">Options for the <code class="highlighter-rouge">slugify</code> filter</h3>
|
|
742
|
+
<h3 id="options-for-the-slugify-filter">Options for the <code class="language-plaintext highlighter-rouge">slugify</code> filter</h3>
|
|
742
743
|
|
|
743
|
-
<p>The <code class="highlighter-rouge">slugify</code> filter accepts an option, each specifying what to filter.
|
|
744
|
-
The default is <code class="highlighter-rouge">default</code>. They are as follows (with what they filter):</p>
|
|
744
|
+
<p>The <code class="language-plaintext highlighter-rouge">slugify</code> filter accepts an option, each specifying what to filter.
|
|
745
|
+
The default is <code class="language-plaintext highlighter-rouge">default</code>. They are as follows (with what they filter):</p>
|
|
745
746
|
|
|
746
747
|
<ul>
|
|
747
|
-
<li><code class="highlighter-rouge">none</code>: no characters</li>
|
|
748
|
-
<li><code class="highlighter-rouge">raw</code>: spaces</li>
|
|
749
|
-
<li><code class="highlighter-rouge">default</code>: spaces and non-alphanumeric characters</li>
|
|
750
|
-
<li><code class="highlighter-rouge">pretty</code>: spaces and non-alphanumeric characters except for <code class="highlighter-rouge">._~!$&'()+,;=@</code></li>
|
|
751
|
-
<li><code class="highlighter-rouge">ascii</code>: spaces, non-alphanumeric, and non-ASCII characters</li>
|
|
752
|
-
<li><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>
|
|
748
|
+
<li><code class="language-plaintext highlighter-rouge">none</code>: no characters</li>
|
|
749
|
+
<li><code class="language-plaintext highlighter-rouge">raw</code>: spaces</li>
|
|
750
|
+
<li><code class="language-plaintext highlighter-rouge">default</code>: spaces and non-alphanumeric characters</li>
|
|
751
|
+
<li><code class="language-plaintext highlighter-rouge">pretty</code>: spaces and non-alphanumeric characters except for <code class="language-plaintext highlighter-rouge">._~!$&'()+,;=@</code></li>
|
|
752
|
+
<li><code class="language-plaintext highlighter-rouge">ascii</code>: spaces, non-alphanumeric, and non-ASCII characters</li>
|
|
753
|
+
<li><code class="language-plaintext highlighter-rouge">latin</code>: like <code class="language-plaintext highlighter-rouge">default</code>, except Latin characters are first transliterated (e.g. <code class="language-plaintext highlighter-rouge">àèïòü</code> to <code class="language-plaintext highlighter-rouge">aeiou</code>)<span class="version-badge" title="This feature is available starting version 3.7.0">3.7.0</span>
|
|
753
754
|
<h2 id="tags">Tags</h2>
|
|
754
755
|
</li>
|
|
755
756
|
<li><a href="#includes">Includes</a></li>
|
|
@@ -760,12 +761,12 @@ The default is <code class="highlighter-rouge">default</code>. They are as follo
|
|
|
760
761
|
|
|
761
762
|
<h3 id="includes">Includes</h3>
|
|
762
763
|
|
|
763
|
-
<p>If you have small page snippets that you want to include in multiple places on your site, save the snippets as <em>include files</em> and insert them where required, by using the <code class="highlighter-rouge">include</code> tag:</p>
|
|
764
|
+
<p>If you have small page snippets that you want to include in multiple places on your site, save the snippets as <em>include files</em> and insert them where required, by using the <code class="language-plaintext highlighter-rouge">include</code> tag:</p>
|
|
764
765
|
|
|
765
|
-
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span
|
|
766
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span>footer.html<span class="w"> </span><span class="p">%}</span>
|
|
766
767
|
</code></pre></div></div>
|
|
767
768
|
|
|
768
|
-
<p>Jekyll expects all <em>include files</em> to be placed in an <code class="highlighter-rouge">_includes</code> directory at the root of your source directory. In the above example, this will embed the contents of <code class="highlighter-rouge">_includes/footer.html</code> into the calling file.</p>
|
|
769
|
+
<p>Jekyll expects all <em>include files</em> to be placed in an <code class="language-plaintext highlighter-rouge">_includes</code> directory at the root of your source directory. In the above example, this will embed the contents of <code class="language-plaintext highlighter-rouge">_includes/footer.html</code> into the calling file.</p>
|
|
769
770
|
|
|
770
771
|
<p>For more advanced information on using includes, see <a href="../includes">Includes</a>.</p>
|
|
771
772
|
|
|
@@ -773,13 +774,13 @@ The default is <code class="highlighter-rouge">default</code>. They are as follo
|
|
|
773
774
|
|
|
774
775
|
<p>Jekyll has built in support for syntax highlighting of over 60 languages
|
|
775
776
|
thanks to <a href="http://rouge.jneen.net">Rouge</a>. Rouge is the default highlighter
|
|
776
|
-
in Jekyll 3 and above. To use it in Jekyll 2, set <code class="highlighter-rouge">highlighter</code> to <code class="highlighter-rouge">rouge</code>
|
|
777
|
-
and ensure the <code class="highlighter-rouge">rouge</code> gem is installed properly.</p>
|
|
777
|
+
in Jekyll 3 and above. To use it in Jekyll 2, set <code class="language-plaintext highlighter-rouge">highlighter</code> to <code class="language-plaintext highlighter-rouge">rouge</code>
|
|
778
|
+
and ensure the <code class="language-plaintext highlighter-rouge">rouge</code> gem is installed properly.</p>
|
|
778
779
|
|
|
779
780
|
<p>Alternatively, you can use <a href="http://pygments.org">Pygments</a> to highlight
|
|
780
781
|
your code snippets. To use Pygments, you must have Python installed on your
|
|
781
|
-
system, have the <code class="highlighter-rouge">pygments.rb</code> gem installed and set <code class="highlighter-rouge">highlighter</code> to
|
|
782
|
-
<code class="highlighter-rouge">pygments</code> in your site’s configuration file. Pygments supports <a href="http://pygments.org/languages/">over 100
|
|
782
|
+
system, have the <code class="language-plaintext highlighter-rouge">pygments.rb</code> gem installed and set <code class="language-plaintext highlighter-rouge">highlighter</code> to
|
|
783
|
+
<code class="language-plaintext highlighter-rouge">pygments</code> in your site’s configuration file. Pygments supports <a href="http://pygments.org/languages/">over 100
|
|
783
784
|
languages</a></p>
|
|
784
785
|
|
|
785
786
|
<p>To render a code block with syntax highlighting, surround your code as follows:</p>
|
|
@@ -791,7 +792,7 @@ end
|
|
|
791
792
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endhighlight</span><span class="w"> </span><span class="p">%}</span>
|
|
792
793
|
</code></pre></div></div>
|
|
793
794
|
|
|
794
|
-
<p>The argument to the <code class="highlighter-rouge">highlight</code> tag (<code class="highlighter-rouge">ruby</code> in the example above) is the
|
|
795
|
+
<p>The argument to the <code class="language-plaintext highlighter-rouge">highlight</code> tag (<code class="language-plaintext highlighter-rouge">ruby</code> in the example above) is the
|
|
795
796
|
language identifier. To find the appropriate identifier to use for the language
|
|
796
797
|
you want to highlight, look for the “short name” on the <a href="https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers">Rouge
|
|
797
798
|
wiki</a>
|
|
@@ -806,8 +807,8 @@ or the <a href="http://pygments.org/docs/lexers/">Pygments’ Lexers page</a>.</
|
|
|
806
807
|
|
|
807
808
|
<h4 id="line-numbers">Line numbers</h4>
|
|
808
809
|
|
|
809
|
-
<p>There is a second argument to <code class="highlighter-rouge">highlight</code> called <code class="highlighter-rouge">linenos</code> that is optional.
|
|
810
|
-
Including the <code class="highlighter-rouge">linenos</code> argument will force the highlighted code to include line
|
|
810
|
+
<p>There is a second argument to <code class="language-plaintext highlighter-rouge">highlight</code> called <code class="language-plaintext highlighter-rouge">linenos</code> that is optional.
|
|
811
|
+
Including the <code class="language-plaintext highlighter-rouge">linenos</code> argument will force the highlighted code to include line
|
|
811
812
|
numbers. For instance, the following code block would include line numbers next
|
|
812
813
|
to each line:</p>
|
|
813
814
|
|
|
@@ -824,61 +825,61 @@ end
|
|
|
824
825
|
stylesheet. For an example stylesheet you can look at
|
|
825
826
|
<a href="https://github.com/mojombo/tpw/tree/master/css/syntax.css">syntax.css</a>. These
|
|
826
827
|
are the same styles as used by GitHub and you are free to use them for your own
|
|
827
|
-
site. If you use <code class="highlighter-rouge">linenos</code>, you might want to include an additional CSS class
|
|
828
|
-
definition for the <code class="highlighter-rouge">.lineno</code> class in <code class="highlighter-rouge">syntax.css</code> to distinguish the line
|
|
828
|
+
site. If you use <code class="language-plaintext highlighter-rouge">linenos</code>, you might want to include an additional CSS class
|
|
829
|
+
definition for the <code class="language-plaintext highlighter-rouge">.lineno</code> class in <code class="language-plaintext highlighter-rouge">syntax.css</code> to distinguish the line
|
|
829
830
|
numbers from the highlighted code.</p>
|
|
830
831
|
|
|
831
832
|
<h2 id="links">Links</h2>
|
|
832
833
|
|
|
833
834
|
<h3 id="link">Linking to pages</h3>
|
|
834
835
|
|
|
835
|
-
<p>To link to a post, a page, collection item, or file, the <code class="highlighter-rouge">link</code> tag will generate the correct permalink URL for the path you specify. For example, if you use the <code class="highlighter-rouge">link</code> tag to link to <code class="highlighter-rouge">mypage.html</code>, even if you change your permalink style to include the file extension or omit it, the URL formed by the <code class="highlighter-rouge">link</code> tag will always be valid.</p>
|
|
836
|
+
<p>To link to a post, a page, collection item, or file, the <code class="language-plaintext highlighter-rouge">link</code> tag will generate the correct permalink URL for the path you specify. For example, if you use the <code class="language-plaintext highlighter-rouge">link</code> tag to link to <code class="language-plaintext highlighter-rouge">mypage.html</code>, even if you change your permalink style to include the file extension or omit it, the URL formed by the <code class="language-plaintext highlighter-rouge">link</code> tag will always be valid.</p>
|
|
836
837
|
|
|
837
|
-
<p>You must include the file’s original extension when using the <code class="highlighter-rouge">link</code> tag. Here are some examples:</p>
|
|
838
|
+
<p>You must include the file’s original extension when using the <code class="language-plaintext highlighter-rouge">link</code> tag. Here are some examples:</p>
|
|
838
839
|
|
|
839
840
|
<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>
|
|
840
|
-
<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
|
|
841
|
+
<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/2016-07-26-name-of-post.md<span class="w"> </span><span class="p">%}</span>
|
|
841
842
|
<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>
|
|
842
843
|
<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>
|
|
843
844
|
</code></pre></div></div>
|
|
844
845
|
|
|
845
|
-
<p>You can also use the <code class="highlighter-rouge">link</code> tag to create a link in Markdown as follows:</p>
|
|
846
|
+
<p>You can also use the <code class="language-plaintext highlighter-rouge">link</code> tag to create a link in Markdown as follows:</p>
|
|
846
847
|
|
|
847
848
|
<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>)
|
|
848
|
-
[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
|
|
849
|
+
[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/2016-07-26-name-of-post.md<span class="w"> </span><span class="p">%}</span>)
|
|
849
850
|
[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>)
|
|
850
851
|
[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>)
|
|
851
852
|
</code></pre></div></div>
|
|
852
853
|
|
|
853
|
-
<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>
|
|
854
|
+
<p>(Including <code class="language-plaintext highlighter-rouge">{{ site.baseurl }}</code> is optional — it depends on whether you want to preface the page URL with the <code class="language-plaintext highlighter-rouge">baseurl</code> value.)</p>
|
|
854
855
|
|
|
855
856
|
<p>The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page.</p>
|
|
856
857
|
|
|
857
|
-
<p>For example, suppose you’re creating a link in <code class="highlighter-rouge">page_a.md</code> (stored in <code class="highlighter-rouge">pages/folder1/folder2</code>) to <code class="highlighter-rouge">page_b.md</code> (stored in <code class="highlighter-rouge">pages/folder1</code>). Your path in the link would not be <code class="highlighter-rouge">../page_b.html</code>. Instead, it would be <code class="highlighter-rouge">/pages/folder1/page_b.md</code>.</p>
|
|
858
|
+
<p>For example, suppose you’re creating a link in <code class="language-plaintext highlighter-rouge">page_a.md</code> (stored in <code class="language-plaintext highlighter-rouge">pages/folder1/folder2</code>) to <code class="language-plaintext highlighter-rouge">page_b.md</code> (stored in <code class="language-plaintext highlighter-rouge">pages/folder1</code>). Your path in the link would not be <code class="language-plaintext highlighter-rouge">../page_b.html</code>. Instead, it would be <code class="language-plaintext highlighter-rouge">/pages/folder1/page_b.md</code>.</p>
|
|
858
859
|
|
|
859
|
-
<p>If you’re unsure of the path, add <code class="highlighter-rouge">{{ page.path }}</code> to the page and it will display the path.</p>
|
|
860
|
+
<p>If you’re unsure of the path, add <code class="language-plaintext highlighter-rouge">{{ page.path }}</code> to the page and it will display the path.</p>
|
|
860
861
|
|
|
861
|
-
<p>One major benefit of using the <code class="highlighter-rouge">link</code> or <code class="highlighter-rouge">post_url</code> tag is link validation. If the link doesn’t exist, Jekyll won’t build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).</p>
|
|
862
|
+
<p>One major benefit of using the <code class="language-plaintext highlighter-rouge">link</code> or <code class="language-plaintext highlighter-rouge">post_url</code> tag is link validation. If the link doesn’t exist, Jekyll won’t build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).</p>
|
|
862
863
|
|
|
863
|
-
<p>Note you cannot add filters to <code class="highlighter-rouge">link</code> tags. For example, you cannot append a string using Liquid filters, such as <code class="highlighter-rouge">{% link mypage.html | append: "#section1" %} </code>. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques.</p>
|
|
864
|
+
<p>Note you cannot add filters to <code class="language-plaintext highlighter-rouge">link</code> tags. For example, you cannot append a string using Liquid filters, such as <code class="language-plaintext highlighter-rouge">{% link mypage.html | append: "#section1" %} </code>. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques.</p>
|
|
864
865
|
|
|
865
866
|
<h3 id="linking-to-posts">Linking to posts</h3>
|
|
866
867
|
|
|
867
|
-
<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>
|
|
868
|
+
<p>If you want to include a link to a post on your site, the <code class="language-plaintext highlighter-rouge">post_url</code> tag will generate the correct permalink URL for the post you specify.</p>
|
|
868
869
|
|
|
869
|
-
<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
|
|
870
|
+
<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="o">-</span><span class="mi">07</span><span class="o">-</span><span class="mi">21</span><span class="o">-</span>name-of-post<span class="w"> </span><span class="p">%}</span>
|
|
870
871
|
</code></pre></div></div>
|
|
871
872
|
|
|
872
873
|
<p>If you organize your posts in subdirectories, you need to include subdirectory path to the post:</p>
|
|
873
874
|
|
|
874
|
-
<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
|
|
875
|
+
<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/2010-07-21-name-of-post<span class="w"> </span><span class="p">%}</span>
|
|
875
876
|
</code></pre></div></div>
|
|
876
877
|
|
|
877
|
-
<p>There is no need to include the file extension when using the <code class="highlighter-rouge">post_url</code> tag.</p>
|
|
878
|
+
<p>There is no need to include the file extension when using the <code class="language-plaintext highlighter-rouge">post_url</code> tag.</p>
|
|
878
879
|
|
|
879
880
|
<p>You can also use this tag to create a link to a post in Markdown as follows:</p>
|
|
880
881
|
|
|
881
|
-
<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
|
|
882
|
+
<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="o">-</span><span class="mi">07</span><span class="o">-</span><span class="mi">21</span><span class="o">-</span>name-of-post<span class="w"> </span><span class="p">%}</span>)
|
|
882
883
|
</code></pre></div></div>
|
|
883
884
|
|
|
884
885
|
|
|
@@ -1158,7 +1159,7 @@ numbers from the highlighted code.</p>
|
|
|
1158
1159
|
<footer>
|
|
1159
1160
|
<div class="grid">
|
|
1160
1161
|
<div class="unit one-third center-on-mobiles">
|
|
1161
|
-
<p>The contents of this website are <br />©
|
|
1162
|
+
<p>The contents of this website are <br />© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
1162
1163
|
</div>
|
|
1163
1164
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
1164
1165
|
<p>
|
data/site/docs/themes/index.html
CHANGED
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
<!DOCTYPE HTML>
|
|
2
2
|
<html lang="en-US">
|
|
3
3
|
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
5
4
|
<meta charset="UTF-8">
|
|
6
5
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
|
8
|
-
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites"
|
|
6
|
+
<meta name="generator" content="Jekyll v3.9.0">
|
|
7
|
+
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
|
|
9
8
|
<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
9
|
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
|
11
10
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
|
12
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"
|
|
11
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
|
13
12
|
<link rel="stylesheet" href="/css/screen.css">
|
|
14
13
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
15
|
-
<!-- Begin Jekyll SEO tag v2.
|
|
14
|
+
<!-- Begin Jekyll SEO tag v2.6.1 -->
|
|
16
15
|
<title>Themes | Jekyll • Simple, blog-aware, static sites</title>
|
|
17
|
-
<meta name="generator" content="Jekyll v3.
|
|
18
|
-
<meta property="og:title" content="Themes"
|
|
19
|
-
<meta property="og:locale" content="en_US"
|
|
20
|
-
<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 specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site’s content."
|
|
21
|
-
<meta property="og: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 specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site’s content."
|
|
22
|
-
<link rel="canonical" href="https://jekyllrb.com/docs/themes/"
|
|
23
|
-
<meta property="og:url" content="https://jekyllrb.com/docs/themes/"
|
|
24
|
-
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites"
|
|
25
|
-
<meta property="og:type" content="article"
|
|
26
|
-
<meta property="article:published_time" content="
|
|
27
|
-
<meta name="twitter:card" content="summary"
|
|
28
|
-
<meta
|
|
29
|
-
<meta name="
|
|
16
|
+
<meta name="generator" content="Jekyll v3.9.0" />
|
|
17
|
+
<meta property="og:title" content="Themes" />
|
|
18
|
+
<meta property="og:locale" content="en_US" />
|
|
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 specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site’s content." />
|
|
20
|
+
<meta property="og: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 specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site’s content." />
|
|
21
|
+
<link rel="canonical" href="https://jekyllrb.com/docs/themes/" />
|
|
22
|
+
<meta property="og:url" content="https://jekyllrb.com/docs/themes/" />
|
|
23
|
+
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
|
|
24
|
+
<meta property="og:type" content="article" />
|
|
25
|
+
<meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
|
|
26
|
+
<meta name="twitter:card" content="summary" />
|
|
27
|
+
<meta property="twitter:title" content="Themes" />
|
|
28
|
+
<meta name="twitter:site" content="@jekyllrb" />
|
|
29
|
+
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
|
|
30
30
|
<script type="application/ld+json">
|
|
31
|
-
{"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 specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site’s content.","
|
|
31
|
+
{"url":"https://jekyllrb.com/docs/themes/","headline":"Themes","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"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 specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site’s content.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/themes/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
|
|
32
32
|
<!-- End Jekyll SEO tag -->
|
|
33
33
|
|
|
34
34
|
<!--[if lt IE 9]>
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
<div class="meta hide-on-mobiles">
|
|
74
74
|
<ul>
|
|
75
75
|
<li>
|
|
76
|
-
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.
|
|
76
|
+
<a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
|
|
77
77
|
</li>
|
|
78
78
|
<li>
|
|
79
79
|
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
|
@@ -299,13 +299,13 @@
|
|
|
299
299
|
|
|
300
300
|
<h2 id="understanding-gem-based-themes">Understanding gem-based themes</h2>
|
|
301
301
|
|
|
302
|
-
<p>When you <a href="/docs/quickstart">create a new Jekyll site</a> (by running the <code class="highlighter-rouge">jekyll new <PATH></code> command), Jekyll installs a site that uses a gem-based theme called <a href="https://github.com/jekyll/minima">Minima</a>.</p>
|
|
302
|
+
<p>When you <a href="/docs/quickstart">create a new Jekyll site</a> (by running the <code class="language-plaintext highlighter-rouge">jekyll new <PATH></code> command), Jekyll installs a site that uses a gem-based theme called <a href="https://github.com/jekyll/minima">Minima</a>.</p>
|
|
303
303
|
|
|
304
|
-
<p>With gem-based themes, some of the site’s directories (such as the <code class="highlighter-rouge">assets</code>, <code class="highlighter-rouge">_layouts</code>, <code class="highlighter-rouge">_includes</code>, and <code class="highlighter-rouge">_sass</code> directories) are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.</p>
|
|
304
|
+
<p>With gem-based themes, some of the site’s directories (such as the <code class="language-plaintext highlighter-rouge">assets</code>, <code class="language-plaintext highlighter-rouge">_layouts</code>, <code class="language-plaintext highlighter-rouge">_includes</code>, and <code class="language-plaintext highlighter-rouge">_sass</code> directories) are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.</p>
|
|
305
305
|
|
|
306
306
|
<p>In the case of Minima, you see only the following files in your Jekyll site directory:</p>
|
|
307
307
|
|
|
308
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>├── Gemfile
|
|
308
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>├── Gemfile
|
|
309
309
|
├── Gemfile.lock
|
|
310
310
|
├── _config.yml
|
|
311
311
|
├── _posts
|
|
@@ -314,11 +314,11 @@
|
|
|
314
314
|
└── index.md
|
|
315
315
|
</code></pre></div></div>
|
|
316
316
|
|
|
317
|
-
<p>The <code class="highlighter-rouge">Gemfile</code> and <code class="highlighter-rouge">Gemfile.lock</code> files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.</p>
|
|
317
|
+
<p>The <code class="language-plaintext highlighter-rouge">Gemfile</code> and <code class="language-plaintext highlighter-rouge">Gemfile.lock</code> files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.</p>
|
|
318
318
|
|
|
319
319
|
<p>Gem-based themes make it easy for theme developers to make updates available to anyone who has the theme gem. When there’s an update, theme developers push the update to RubyGems.</p>
|
|
320
320
|
|
|
321
|
-
<p>If you have the theme gem, you can (if you desire) run <code class="highlighter-rouge">bundle update</code> to update all gems in your project. Or you can run <code class="highlighter-rouge">bundle update <THEME></code>, replacing <code class="highlighter-rouge"><THEME></code> with the theme name, such as <code class="highlighter-rouge">minima</code>, to just update the theme gem. Any new files or updates the theme developer has made (such as to stylesheets or includes) will be pulled into your project automatically.</p>
|
|
321
|
+
<p>If you have the theme gem, you can (if you desire) run <code class="language-plaintext highlighter-rouge">bundle update</code> to update all gems in your project. Or you can run <code class="language-plaintext highlighter-rouge">bundle update <THEME></code>, replacing <code class="language-plaintext highlighter-rouge"><THEME></code> with the theme name, such as <code class="language-plaintext highlighter-rouge">minima</code>, to just update the theme gem. Any new files or updates the theme developer has made (such as to stylesheets or includes) will be pulled into your project automatically.</p>
|
|
322
322
|
|
|
323
323
|
<p>The goal of gem-based themes is to allow you to get all the benefits of a robust, continually updated theme without having all the theme’s files getting in your way and over-complicating what might be your primary focus: creating content.</p>
|
|
324
324
|
|
|
@@ -326,31 +326,31 @@
|
|
|
326
326
|
|
|
327
327
|
<p>Jekyll themes set default layouts, includes, and stylesheets. However, you can override any of the theme defaults with your own site content.</p>
|
|
328
328
|
|
|
329
|
-
<p>To replace layouts or includes in your theme, make a copy in your <code class="highlighter-rouge">_layouts</code> or <code class="highlighter-rouge">_includes</code> directory of the specific file you wish to modify, or create the file from scratch giving it the same name as the file you wish to override.</p>
|
|
329
|
+
<p>To replace layouts or includes in your theme, make a copy in your <code class="language-plaintext highlighter-rouge">_layouts</code> or <code class="language-plaintext highlighter-rouge">_includes</code> directory of the specific file you wish to modify, or create the file from scratch giving it the same name as the file you wish to override.</p>
|
|
330
330
|
|
|
331
|
-
<p>For example, if your selected theme has a <code class="highlighter-rouge">page</code> layout, you can override the theme’s layout by creating your own <code class="highlighter-rouge">page</code> layout in the <code class="highlighter-rouge">_layouts</code> directory (that is, <code class="highlighter-rouge">_layouts/page.html</code>).</p>
|
|
331
|
+
<p>For example, if your selected theme has a <code class="language-plaintext highlighter-rouge">page</code> layout, you can override the theme’s layout by creating your own <code class="language-plaintext highlighter-rouge">page</code> layout in the <code class="language-plaintext highlighter-rouge">_layouts</code> directory (that is, <code class="language-plaintext highlighter-rouge">_layouts/page.html</code>).</p>
|
|
332
332
|
|
|
333
333
|
<p>To locate a theme’s files on your computer:</p>
|
|
334
334
|
|
|
335
335
|
<ol>
|
|
336
336
|
<li>
|
|
337
|
-
<p>Run <code class="highlighter-rouge">bundle show</code> followed by the name of the theme’s gem, e.g., <code class="highlighter-rouge">bundle show minima</code> for Jekyll’s default theme.</p>
|
|
337
|
+
<p>Run <code class="language-plaintext highlighter-rouge">bundle show</code> followed by the name of the theme’s gem, e.g., <code class="language-plaintext highlighter-rouge">bundle show minima</code> for Jekyll’s default theme.</p>
|
|
338
338
|
|
|
339
|
-
<p>This returns the location of the gem-based theme files. For example, the Minima theme’s files might be located in <code class="highlighter-rouge">/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0</code> on macOS.</p>
|
|
339
|
+
<p>This returns the location of the gem-based theme files. For example, the Minima theme’s files might be located in <code class="language-plaintext highlighter-rouge">/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0</code> on macOS.</p>
|
|
340
340
|
</li>
|
|
341
341
|
<li>
|
|
342
342
|
<p>Open the theme’s directory in Finder or Explorer:</p>
|
|
343
343
|
|
|
344
344
|
<div class="language-sh highlighter-rouge">
|
|
345
345
|
<div class="highlight"><pre class="highlight"><code><span class="c"># On MacOS</span>
|
|
346
|
-
open <span class="
|
|
346
|
+
open <span class="si">$(</span>bundle show minima<span class="si">)</span>
|
|
347
347
|
<span class="c"># On Windows</span>
|
|
348
348
|
explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
|
|
349
349
|
</code></pre></div> </div>
|
|
350
350
|
|
|
351
351
|
<p>A Finder or Explorer window opens showing the theme’s files and directories. The Minima theme gem contains these files:</p>
|
|
352
352
|
|
|
353
|
-
<div class="highlighter-rouge">
|
|
353
|
+
<div class="language-plaintext highlighter-rouge">
|
|
354
354
|
<div class="highlight"><pre class="highlight"><code> ├── LICENSE.txt
|
|
355
355
|
├── README.md
|
|
356
356
|
├── _includes
|
|
@@ -382,17 +382,17 @@ explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
|
|
|
382
382
|
|
|
383
383
|
<p>With a clear understanding of the theme’s files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.</p>
|
|
384
384
|
|
|
385
|
-
<p>Let’s say, for a second example, you want to override Minima’s footer. In your Jekyll site, create an <code class="highlighter-rouge">_includes</code> folder and add a file in it called <code class="highlighter-rouge">footer.html</code>. Jekyll will now use your site’s <code class="highlighter-rouge">footer.html</code> file instead of the <code class="highlighter-rouge">footer.html</code> file from the Minima theme gem.</p>
|
|
385
|
+
<p>Let’s say, for a second example, you want to override Minima’s footer. In your Jekyll site, create an <code class="language-plaintext highlighter-rouge">_includes</code> folder and add a file in it called <code class="language-plaintext highlighter-rouge">footer.html</code>. Jekyll will now use your site’s <code class="language-plaintext highlighter-rouge">footer.html</code> file instead of the <code class="language-plaintext highlighter-rouge">footer.html</code> file from the Minima theme gem.</p>
|
|
386
386
|
|
|
387
|
-
<p>To modify any stylesheet you must take the extra step of also copying the main sass file (<code class="highlighter-rouge">_sass/minima.scss</code> in the Minima theme) into the <code class="highlighter-rouge">_sass</code> directory in your site’s source.</p>
|
|
387
|
+
<p>To modify any stylesheet you must take the extra step of also copying the main sass file (<code class="language-plaintext highlighter-rouge">_sass/minima.scss</code> in the Minima theme) into the <code class="language-plaintext highlighter-rouge">_sass</code> directory in your site’s source.</p>
|
|
388
388
|
|
|
389
389
|
<p>Jekyll will look first to your site’s content before looking to the theme’s defaults for any requested file in the following folders:</p>
|
|
390
390
|
|
|
391
391
|
<ul>
|
|
392
|
-
<li><code class="highlighter-rouge">/assets</code></li>
|
|
393
|
-
<li><code class="highlighter-rouge">/_layouts</code></li>
|
|
394
|
-
<li><code class="highlighter-rouge">/_includes</code></li>
|
|
395
|
-
<li><code class="highlighter-rouge">/_sass</code></li>
|
|
392
|
+
<li><code class="language-plaintext highlighter-rouge">/assets</code></li>
|
|
393
|
+
<li><code class="language-plaintext highlighter-rouge">/_layouts</code></li>
|
|
394
|
+
<li><code class="language-plaintext highlighter-rouge">/_includes</code></li>
|
|
395
|
+
<li><code class="language-plaintext highlighter-rouge">/_sass</code></li>
|
|
396
396
|
</ul>
|
|
397
397
|
|
|
398
398
|
<p>Note that making copies of theme files will prevent you from receiving any theme updates on those files. An alternative, to continue getting theme updates on all stylesheets, is to use higher specificity CSS selectors in your own additional, originally named CSS files.</p>
|
|
@@ -403,17 +403,17 @@ explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
|
|
|
403
403
|
|
|
404
404
|
<p>Suppose you want to get rid of the gem-based theme and convert it to a regular theme, where all files are present in your Jekyll site directory, with nothing stored in the theme gem.</p>
|
|
405
405
|
|
|
406
|
-
<p>To do this, copy the files from the theme gem’s directory into your Jekyll site directory. (For example, copy them to <code class="highlighter-rouge">/myblog</code> if you created your Jekyll site at <code class="highlighter-rouge">/myblog</code>. See the previous section for details.)</p>
|
|
406
|
+
<p>To do this, copy the files from the theme gem’s directory into your Jekyll site directory. (For example, copy them to <code class="language-plaintext highlighter-rouge">/myblog</code> if you created your Jekyll site at <code class="language-plaintext highlighter-rouge">/myblog</code>. See the previous section for details.)</p>
|
|
407
407
|
|
|
408
408
|
<p>Then you must tell Jekyll about the plugins that were referenced by the theme. You can find these plugins in the theme’s gemspec file as runtime dependencies. If you were converting the Minima theme, for example, you might see:</p>
|
|
409
409
|
|
|
410
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
|
|
410
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
|
|
411
411
|
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
|
412
412
|
</code></pre></div></div>
|
|
413
413
|
|
|
414
|
-
<p>You should include these references in the <code class="highlighter-rouge">Gemfile</code> in one of two ways.</p>
|
|
414
|
+
<p>You should include these references in the <code class="language-plaintext highlighter-rouge">Gemfile</code> in one of two ways.</p>
|
|
415
415
|
|
|
416
|
-
<p>You could list them individually in both <code class="highlighter-rouge">Gemfile</code> and <code class="highlighter-rouge">_config.yml</code>.</p>
|
|
416
|
+
<p>You could list them individually in both <code class="language-plaintext highlighter-rouge">Gemfile</code> and <code class="language-plaintext highlighter-rouge">_config.yml</code>.</p>
|
|
417
417
|
|
|
418
418
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># ./Gemfile</span>
|
|
419
419
|
|
|
@@ -428,7 +428,7 @@ spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
|
|
428
428
|
<span class="pi">-</span> <span class="s">jekyll-seo-tag</span>
|
|
429
429
|
</code></pre></div></div>
|
|
430
430
|
|
|
431
|
-
<p>Or you could list them explicitly as Jekyll plugins in your Gemfile, and not update <code class="highlighter-rouge">_config.yml</code>, like this:</p>
|
|
431
|
+
<p>Or you could list them explicitly as Jekyll plugins in your Gemfile, and not update <code class="language-plaintext highlighter-rouge">_config.yml</code>, like this:</p>
|
|
432
432
|
|
|
433
433
|
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># ./Gemfile</span>
|
|
434
434
|
|
|
@@ -438,43 +438,43 @@ spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
|
|
438
438
|
<span class="k">end</span>
|
|
439
439
|
</code></pre></div></div>
|
|
440
440
|
|
|
441
|
-
<p>Either way, don’t forget to <code class="highlighter-rouge">bundle update</code>.</p>
|
|
441
|
+
<p>Either way, don’t forget to <code class="language-plaintext highlighter-rouge">bundle update</code>.</p>
|
|
442
442
|
|
|
443
|
-
<p>However, if you’re publishing on GitHub Pages you should update only your <code class="highlighter-rouge">_config.yml</code> as GitHub Pages doesn’t load plugins via Bundler.</p>
|
|
443
|
+
<p>However, if you’re publishing on GitHub Pages you should update only your <code class="language-plaintext highlighter-rouge">_config.yml</code> as GitHub Pages doesn’t load plugins via Bundler.</p>
|
|
444
444
|
|
|
445
|
-
<p>Finally, remove references to the theme gem in <code class="highlighter-rouge">Gemfile</code> and configuration. For example, to remove <code class="highlighter-rouge">minima</code>:</p>
|
|
445
|
+
<p>Finally, remove references to the theme gem in <code class="language-plaintext highlighter-rouge">Gemfile</code> and configuration. For example, to remove <code class="language-plaintext highlighter-rouge">minima</code>:</p>
|
|
446
446
|
|
|
447
447
|
<ul>
|
|
448
|
-
<li>Open <code class="highlighter-rouge">Gemfile</code> and remove <code class="highlighter-rouge">gem "minima", "~> 2.0"</code>.</li>
|
|
449
|
-
<li>Open <code class="highlighter-rouge">_config.yml</code> and remove <code class="highlighter-rouge">theme: minima</code>.</li>
|
|
448
|
+
<li>Open <code class="language-plaintext highlighter-rouge">Gemfile</code> and remove <code class="language-plaintext highlighter-rouge">gem "minima", "~> 2.0"</code>.</li>
|
|
449
|
+
<li>Open <code class="language-plaintext highlighter-rouge">_config.yml</code> and remove <code class="language-plaintext highlighter-rouge">theme: minima</code>.</li>
|
|
450
450
|
</ul>
|
|
451
451
|
|
|
452
|
-
<p>Now <code class="highlighter-rouge">bundle update</code> will no longer get updates for the theme gem.</p>
|
|
452
|
+
<p>Now <code class="language-plaintext highlighter-rouge">bundle update</code> will no longer get updates for the theme gem.</p>
|
|
453
453
|
|
|
454
454
|
<h2 id="installing-a-theme">Installing a gem-based theme</h2>
|
|
455
455
|
|
|
456
|
-
<p>The <code class="highlighter-rouge">jekyll new <PATH></code> command isn’t the only way to create a new Jekyll site with a gem-based theme. You can also find gem-based themes online and incorporate them into your Jekyll project.</p>
|
|
456
|
+
<p>The <code class="language-plaintext highlighter-rouge">jekyll new <PATH></code> command isn’t the only way to create a new Jekyll site with a gem-based theme. You can also find gem-based themes online and incorporate them into your Jekyll project.</p>
|
|
457
457
|
|
|
458
|
-
<p>For example, search for <a href="https://rubygems.org/search?utf8=%E2%9C%93&query=jekyll-theme">jekyll theme on RubyGems</a> to find other gem-based themes. (Note that not all themes are using <code class="highlighter-rouge">jekyll-theme</code> as a convention in the theme name.)</p>
|
|
458
|
+
<p>For example, search for <a href="https://rubygems.org/search?utf8=%E2%9C%93&query=jekyll-theme">jekyll theme on RubyGems</a> to find other gem-based themes. (Note that not all themes are using <code class="language-plaintext highlighter-rouge">jekyll-theme</code> as a convention in the theme name.)</p>
|
|
459
459
|
|
|
460
460
|
<p>To install a gem-based theme:</p>
|
|
461
461
|
|
|
462
462
|
<ol>
|
|
463
463
|
<li>
|
|
464
|
-
<p>Add the theme to your site’s <code class="highlighter-rouge">Gemfile</code>:</p>
|
|
464
|
+
<p>Add the theme to your site’s <code class="language-plaintext highlighter-rouge">Gemfile</code>:</p>
|
|
465
465
|
|
|
466
466
|
<div class="language-ruby highlighter-rouge">
|
|
467
467
|
<div class="highlight"><pre class="highlight"><code><span class="c1"># ./Gemfile</span>
|
|
468
468
|
|
|
469
469
|
<span class="n">gem</span> <span class="s2">"jekyll-theme-awesome"</span>
|
|
470
470
|
</code></pre></div> </div>
|
|
471
|
-
<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>
|
|
471
|
+
<p>Or if you’ve started with the <code class="language-plaintext highlighter-rouge">jekyll new</code> command, replace <code class="language-plaintext highlighter-rouge">gem "minima", "~> 2.0"</code> with your theme-gem:</p>
|
|
472
472
|
|
|
473
473
|
<div class="language-diff highlighter-rouge">
|
|
474
|
-
<div class="highlight"><pre class="highlight"><code
|
|
474
|
+
<div class="highlight"><pre class="highlight"><code><span class="err">#</span> ./Gemfile
|
|
475
475
|
|
|
476
|
-
|
|
477
|
-
|
|
476
|
+
- gem "minima", "~> 2.0"
|
|
477
|
+
<span class="gi">+ gem "jekyll-theme-awesome"
|
|
478
478
|
</span></code></pre></div> </div>
|
|
479
479
|
</li>
|
|
480
480
|
<li>
|
|
@@ -485,7 +485,7 @@ spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
|
|
485
485
|
</code></pre></div> </div>
|
|
486
486
|
</li>
|
|
487
487
|
<li>
|
|
488
|
-
<p>Add the following to your site’s <code class="highlighter-rouge">_config.yml</code> to activate the theme:</p>
|
|
488
|
+
<p>Add the following to your site’s <code class="language-plaintext highlighter-rouge">_config.yml</code> to activate the theme:</p>
|
|
489
489
|
|
|
490
490
|
<div class="language-yaml highlighter-rouge">
|
|
491
491
|
<div class="highlight"><pre class="highlight"><code><span class="na">theme</span><span class="pi">:</span> <span class="s">jekyll-theme-awesome</span>
|
|
@@ -500,7 +500,7 @@ spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
|
|
500
500
|
</li>
|
|
501
501
|
</ol>
|
|
502
502
|
|
|
503
|
-
<p class="note info">You can have multiple themes listed in your site’s <code class="highlighter-rouge">Gemfile</code>, but only one theme can be selected in your site’s <code class="highlighter-rouge">_config.yml</code>.</p>
|
|
503
|
+
<p class="note info">You can have multiple themes listed in your site’s <code class="language-plaintext highlighter-rouge">Gemfile</code>, but only one theme can be selected in your site’s <code class="language-plaintext highlighter-rouge">_config.yml</code>.</p>
|
|
504
504
|
|
|
505
505
|
<p>If you’re publishing your Jekyll site on <a href="https://pages.github.com/">GitHub Pages</a>, note that GitHub Pages supports only some gem-based themes. See <a href="https://pages.github.com/themes/">Supported Themes</a> in GitHub’s documentation to see which themes are supported.</p>
|
|
506
506
|
|
|
@@ -508,7 +508,7 @@ spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
|
|
508
508
|
|
|
509
509
|
<p>If you’re a Jekyll theme developer (rather than just a consumer of themes), you can package up your theme in RubyGems and allow users to install it through Bundler.</p>
|
|
510
510
|
|
|
511
|
-
<p>If you’re unfamiliar with creating Ruby gems, don’t worry. Jekyll will help you scaffold a new theme with the <code class="highlighter-rouge">new-theme</code> command. Run <code class="highlighter-rouge">jekyll new-theme</code> with the theme name as an argument.</p>
|
|
511
|
+
<p>If you’re unfamiliar with creating Ruby gems, don’t worry. Jekyll will help you scaffold a new theme with the <code class="language-plaintext highlighter-rouge">new-theme</code> command. Run <code class="language-plaintext highlighter-rouge">jekyll new-theme</code> with the theme name as an argument.</p>
|
|
512
512
|
|
|
513
513
|
<p>Here is an example:</p>
|
|
514
514
|
|
|
@@ -529,59 +529,59 @@ Your new Jekyll theme, jekyll-theme-awesome, is ready <span class="k">for </span
|
|
|
529
529
|
For <span class="nb">help </span>getting started, <span class="nb">read</span> /path/to/jekyll-theme-awesome/README.md.
|
|
530
530
|
</code></pre></div></div>
|
|
531
531
|
|
|
532
|
-
<p>Add your template files in the corresponding folders. Then complete the <code class="highlighter-rouge">.gemspec</code> and the README files according to your needs.</p>
|
|
532
|
+
<p>Add your template files in the corresponding folders. Then complete the <code class="language-plaintext highlighter-rouge">.gemspec</code> and the README files according to your needs.</p>
|
|
533
533
|
|
|
534
534
|
<h3 id="layouts-and-includes">Layouts and includes</h3>
|
|
535
535
|
|
|
536
|
-
<p>Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme’s <code class="highlighter-rouge">/_layouts</code> folder, and place includes in your themes <code class="highlighter-rouge">/_includes</code> folder.</p>
|
|
536
|
+
<p>Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme’s <code class="language-plaintext highlighter-rouge">/_layouts</code> folder, and place includes in your themes <code class="language-plaintext highlighter-rouge">/_includes</code> folder.</p>
|
|
537
537
|
|
|
538
|
-
<p>For example, if your theme has a <code class="highlighter-rouge">/_layouts/page.html</code> file, and a page has <code class="highlighter-rouge">layout: page</code> in its YAML front matter, Jekyll will first look to the site’s <code class="highlighter-rouge">_layouts</code> folder for the <code class="highlighter-rouge">page</code> layout, and if none exists, will use your theme’s <code class="highlighter-rouge">page</code> layout.</p>
|
|
538
|
+
<p>For example, if your theme has a <code class="language-plaintext highlighter-rouge">/_layouts/page.html</code> file, and a page has <code class="language-plaintext highlighter-rouge">layout: page</code> in its YAML front matter, Jekyll will first look to the site’s <code class="language-plaintext highlighter-rouge">_layouts</code> folder for the <code class="language-plaintext highlighter-rouge">page</code> layout, and if none exists, will use your theme’s <code class="language-plaintext highlighter-rouge">page</code> layout.</p>
|
|
539
539
|
|
|
540
540
|
<h3 id="assets">Assets</h3>
|
|
541
541
|
|
|
542
|
-
<p>Any file in <code class="highlighter-rouge">/assets</code> will be copied over to the user’s site upon build unless they have a file with the same relative path. You can ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave like pages and static files in Jekyll:</p>
|
|
542
|
+
<p>Any file in <code class="language-plaintext highlighter-rouge">/assets</code> will be copied over to the user’s site upon build unless they have a file with the same relative path. You can ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave like pages and static files in Jekyll:</p>
|
|
543
543
|
|
|
544
544
|
<ul>
|
|
545
545
|
<li>If the file has <a href="/docs/frontmatter/">YAML front matter</a> at the top, it will be rendered.</li>
|
|
546
546
|
<li>If the file does not have YAML front matter, it will simply be copied over into the resulting site.</li>
|
|
547
547
|
</ul>
|
|
548
548
|
|
|
549
|
-
<p>This allows theme creators to ship a default <code class="highlighter-rouge">/assets/styles.scss</code> file which their layouts can depend on as <code class="highlighter-rouge">/assets/styles.css</code>.</p>
|
|
549
|
+
<p>This allows theme creators to ship a default <code class="language-plaintext highlighter-rouge">/assets/styles.scss</code> file which their layouts can depend on as <code class="language-plaintext highlighter-rouge">/assets/styles.css</code>.</p>
|
|
550
550
|
|
|
551
|
-
<p>All files in <code class="highlighter-rouge">/assets</code> will be output into the compiled site in the <code class="highlighter-rouge">/assets</code> folder just as you’d expect from using Jekyll on your sites.</p>
|
|
551
|
+
<p>All files in <code class="language-plaintext highlighter-rouge">/assets</code> will be output into the compiled site in the <code class="language-plaintext highlighter-rouge">/assets</code> folder just as you’d expect from using Jekyll on your sites.</p>
|
|
552
552
|
|
|
553
553
|
<h3 id="stylesheets">Stylesheets</h3>
|
|
554
554
|
|
|
555
|
-
<p>Your theme’s stylesheets should be placed in your theme’s <code class="highlighter-rouge">_sass</code> folder, again, just as you would when authoring a Jekyll site.</p>
|
|
555
|
+
<p>Your theme’s stylesheets should be placed in your theme’s <code class="language-plaintext highlighter-rouge">_sass</code> folder, again, just as you would when authoring a Jekyll site.</p>
|
|
556
556
|
|
|
557
|
-
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>_sass
|
|
557
|
+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>_sass
|
|
558
558
|
├── jekyll-theme-awesome.scss
|
|
559
559
|
</code></pre></div></div>
|
|
560
560
|
|
|
561
|
-
<p>Your theme’s styles can be included in the user’s stylesheet using the <code class="highlighter-rouge">@import</code> directive.</p>
|
|
561
|
+
<p>Your theme’s styles can be included in the user’s stylesheet using the <code class="language-plaintext highlighter-rouge">@import</code> directive.</p>
|
|
562
562
|
|
|
563
563
|
<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>
|
|
564
564
|
</code></pre></div></div>
|
|
565
565
|
|
|
566
566
|
<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>
|
|
567
567
|
</h3>
|
|
568
|
-
<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>
|
|
568
|
+
<p>Jekyll will automatically require all whitelisted <code class="language-plaintext highlighter-rouge">runtime_dependencies</code> of your theme-gem even if they’re not explicitly included under the <code class="language-plaintext highlighter-rouge">plugins</code> array in the site’s config file. (Note: whitelisting is only required when building or serving with the <code class="language-plaintext highlighter-rouge">--safe</code> option.)</p>
|
|
569
569
|
|
|
570
570
|
<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>
|
|
571
571
|
|
|
572
572
|
<h3 id="documenting-your-theme">Documenting your theme</h3>
|
|
573
573
|
|
|
574
|
-
<p>Your theme should include a <code class="highlighter-rouge">/README.md</code> file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site’s configuration file?</p>
|
|
574
|
+
<p>Your theme should include a <code class="language-plaintext highlighter-rouge">/README.md</code> file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site’s configuration file?</p>
|
|
575
575
|
|
|
576
576
|
<h3 id="adding-a-screenshot">Adding a screenshot</h3>
|
|
577
577
|
|
|
578
|
-
<p>Themes are visual. Show users what your theme looks like by including a screenshot as <code class="highlighter-rouge">/screenshot.png</code> within your theme’s repository where it can be retrieved programmatically. You can also include this screenshot within your theme’s documentation.</p>
|
|
578
|
+
<p>Themes are visual. Show users what your theme looks like by including a screenshot as <code class="language-plaintext highlighter-rouge">/screenshot.png</code> within your theme’s repository where it can be retrieved programmatically. You can also include this screenshot within your theme’s documentation.</p>
|
|
579
579
|
|
|
580
580
|
<h3 id="previewing-your-theme">Previewing your theme</h3>
|
|
581
581
|
|
|
582
|
-
<p>To preview your theme as you’re authoring it, it may be helpful to add dummy content in, for example, <code class="highlighter-rouge">/index.html</code> and <code class="highlighter-rouge">/page.html</code> files. This will allow you to use the <code class="highlighter-rouge">jekyll build</code> and <code class="highlighter-rouge">jekyll serve</code> commands to preview your theme, just as you’d preview a Jekyll site.</p>
|
|
582
|
+
<p>To preview your theme as you’re authoring it, it may be helpful to add dummy content in, for example, <code class="language-plaintext highlighter-rouge">/index.html</code> and <code class="language-plaintext highlighter-rouge">/page.html</code> files. This will allow you to use the <code class="language-plaintext highlighter-rouge">jekyll build</code> and <code class="language-plaintext highlighter-rouge">jekyll serve</code> commands to preview your theme, just as you’d preview a Jekyll site.</p>
|
|
583
583
|
|
|
584
|
-
<p class="info note">If you do preview your theme locally, be sure to add <code class="highlighter-rouge">/_site</code> to your theme’s <code class="highlighter-rouge">.gitignore</code> file to prevent the compiled site from also being included when you distribute your theme.</p>
|
|
584
|
+
<p class="info note">If you do preview your theme locally, be sure to add <code class="language-plaintext highlighter-rouge">/_site</code> to your theme’s <code class="language-plaintext highlighter-rouge">.gitignore</code> file to prevent the compiled site from also being included when you distribute your theme.</p>
|
|
585
585
|
|
|
586
586
|
<h3 id="publishing-your-theme">Publishing your theme</h3>
|
|
587
587
|
|
|
@@ -598,21 +598,21 @@ git commit <span class="nt">-m</span> <span class="s2">"Init commit"</span>
|
|
|
598
598
|
</code></pre></div> </div>
|
|
599
599
|
</li>
|
|
600
600
|
<li>
|
|
601
|
-
<p>Next, package your theme, by running the following command, replacing <code class="highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
|
|
601
|
+
<p>Next, package your theme, by running the following command, replacing <code class="language-plaintext highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
|
|
602
602
|
|
|
603
603
|
<div class="language-sh highlighter-rouge">
|
|
604
604
|
<div class="highlight"><pre class="highlight"><code>gem build jekyll-theme-awesome.gemspec
|
|
605
605
|
</code></pre></div> </div>
|
|
606
606
|
</li>
|
|
607
607
|
<li>
|
|
608
|
-
<p>Finally, push your packaged theme up to the RubyGems service, by running the following command, again replacing <code class="highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
|
|
608
|
+
<p>Finally, push your packaged theme up to the RubyGems service, by running the following command, again replacing <code class="language-plaintext highlighter-rouge">jekyll-theme-awesome</code> with the name of your theme:</p>
|
|
609
609
|
|
|
610
610
|
<div class="language-sh highlighter-rouge">
|
|
611
611
|
<div class="highlight"><pre class="highlight"><code>gem push jekyll-theme-awesome-<span class="k">*</span>.gem
|
|
612
612
|
</code></pre></div> </div>
|
|
613
613
|
</li>
|
|
614
614
|
<li>
|
|
615
|
-
<p>To release a new version of your theme, update the version number in the gemspec file, ( <code class="highlighter-rouge">jekyll-theme-awesome.gemspec</code> in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a> while bumping your theme-version.</p>
|
|
615
|
+
<p>To release a new version of your theme, update the version number in the gemspec file, ( <code class="language-plaintext highlighter-rouge">jekyll-theme-awesome.gemspec</code> in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow <a href="http://semver.org/">Semantic Versioning</a> while bumping your theme-version.</p>
|
|
616
616
|
</li>
|
|
617
617
|
</ol>
|
|
618
618
|
|
|
@@ -907,7 +907,7 @@ git commit <span class="nt">-m</span> <span class="s2">"Init commit"</span>
|
|
|
907
907
|
<footer>
|
|
908
908
|
<div class="grid">
|
|
909
909
|
<div class="unit one-third center-on-mobiles">
|
|
910
|
-
<p>The contents of this website are <br>©
|
|
910
|
+
<p>The contents of this website are <br>© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
|
911
911
|
</div>
|
|
912
912
|
<div class="unit two-thirds align-right center-on-mobiles">
|
|
913
913
|
<p>
|