jekyll-docs 3.5.2 → 3.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/site/404.html +3 -3
- data/site/community/index.html +5 -5
- data/site/docs/assets/index.html +14 -22
- data/site/docs/code_of_conduct/index.html +730 -0
- data/site/docs/collections/index.html +65 -80
- data/site/docs/conduct/index.html +4 -4
- data/site/docs/configuration/index.html +130 -156
- data/site/docs/continuous-integration/buddyworks/index.html +14 -16
- data/site/docs/continuous-integration/circleci/index.html +13 -21
- data/site/docs/continuous-integration/index.html +5 -5
- data/site/docs/continuous-integration/travis-ci/index.html +45 -73
- data/site/docs/contributing/index.html +10 -10
- data/site/docs/datafiles/index.html +37 -53
- data/site/docs/deployment-methods/index.html +54 -64
- data/site/docs/drafts/index.html +6 -8
- data/site/docs/extras/index.html +8 -12
- data/site/docs/frontmatter/index.html +10 -14
- data/site/docs/github-pages/index.html +10 -14
- data/site/docs/history/index.html +539 -440
- data/site/docs/home/index.html +4 -4
- data/site/docs/includes/index.html +42 -70
- data/site/docs/installation/index.html +23 -37
- data/site/docs/maintaining/affinity-team-captain/index.html +4 -4
- data/site/docs/maintaining/avoiding-burnout/index.html +4 -4
- data/site/docs/maintaining/becoming-a-maintainer/index.html +4 -4
- data/site/docs/maintaining/index.html +4 -4
- data/site/docs/maintaining/merging-a-pull-request/index.html +6 -8
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +4 -4
- data/site/docs/maintaining/special-labels/index.html +4 -4
- data/site/docs/maintaining/triaging-an-issue/index.html +4 -4
- data/site/docs/migrations/index.html +4 -4
- data/site/docs/pages/index.html +8 -12
- data/site/docs/pagination/index.html +13 -21
- data/site/docs/permalinks/index.html +43 -34
- data/site/docs/plugins/index.html +51 -79
- data/site/docs/posts/index.html +26 -48
- data/site/docs/quickstart/index.html +6 -8
- data/site/docs/resources/index.html +45 -21
- data/site/docs/sites/index.html +4 -4
- data/site/docs/static-files/index.html +12 -16
- data/site/docs/structure/index.html +6 -8
- data/site/docs/templates/index.html +36 -68
- data/site/docs/themes/index.html +32 -49
- data/site/docs/troubleshooting/index.html +44 -82
- data/site/docs/upgrading/0-to-2/index.html +7 -9
- data/site/docs/upgrading/2-to-3/index.html +19 -31
- data/site/docs/upgrading/index.html +4 -4
- data/site/docs/usage/index.html +20 -30
- data/site/docs/variables/index.html +26 -10
- data/site/docs/windows/index.html +36 -58
- data/site/feed.xml +47 -53
- data/site/help/index.html +3 -3
- data/site/index.html +3 -3
- data/site/latest_version.txt +1 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +16 -8
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +16 -8
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +16 -8
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +16 -8
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +16 -8
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +16 -8
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +16 -8
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +16 -8
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +16 -8
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +16 -8
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +16 -8
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +16 -8
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +16 -8
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +16 -8
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +16 -8
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +16 -8
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +16 -8
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +16 -8
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +16 -8
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +16 -8
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +16 -8
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +16 -8
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +16 -8
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +16 -8
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +16 -8
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +16 -8
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +16 -8
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +16 -8
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +16 -8
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +16 -8
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +16 -8
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +16 -8
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +17 -9
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +16 -8
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +16 -8
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +16 -8
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +16 -8
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +16 -8
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +16 -8
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +16 -8
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +16 -8
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +16 -8
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +20 -12
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +16 -8
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +16 -8
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +16 -8
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +16 -8
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +16 -8
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +16 -8
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +16 -8
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +16 -8
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +16 -8
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +16 -8
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +16 -8
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +27 -29
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +23 -17
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +20 -14
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +21 -13
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +18 -10
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +573 -0
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +565 -0
- data/site/news/index.html +122 -48
- data/site/news/releases/index.html +122 -48
- data/site/sitemap.xml +64 -52
- data/site/tutorials/convert-site-to-jekyll/index.html +80 -138
- data/site/tutorials/custom-404-page/index.html +13 -21
- data/site/tutorials/home/index.html +4 -4
- data/site/tutorials/navigation/index.html +144 -180
- data/site/tutorials/orderofinterpretation/index.html +27 -45
- metadata +8 -5
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Quick-start guide | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Quick-start guide">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/quickstart/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"If you already have a full Ruby development environment with all headers and RubyGems installed (see Jekyll’s requirements), you can create a new Jekyll site by doing the following:","url":"https://jekyllrb.com/docs/quickstart/","headline":"Quick-start guide","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/quickstart/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -289,8 +289,7 @@
|
|
289
289
|
<h1>Quick-start guide</h1>
|
290
290
|
<p>If you already have a full <a href="https://www.ruby-lang.org/en/downloads/">Ruby</a> development environment with all headers and <a href="https://rubygems.org/pages/download">RubyGems</a> installed (see Jekyll’s <a href="/docs/installation/#requirements">requirements</a>), you can create a new Jekyll site by doing the following:</p>
|
291
291
|
|
292
|
-
<div class="language-sh highlighter-rouge">
|
293
|
-
<pre class="highlight"><code><span class="c"># Install Jekyll and Bundler gems through RubyGems</span>
|
292
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"># Install Jekyll and Bundler gems through RubyGems</span>
|
294
293
|
~ <span class="nv">$ </span>gem install jekyll bundler
|
295
294
|
|
296
295
|
<span class="c"># Create a new Jekyll site at ./myblog</span>
|
@@ -303,8 +302,7 @@
|
|
303
302
|
~/myblog <span class="nv">$ </span>bundle <span class="nb">exec </span>jekyll serve
|
304
303
|
|
305
304
|
<span class="c"># Now browse to http://localhost:4000</span>
|
306
|
-
</code></pre>
|
307
|
-
</div>
|
305
|
+
</code></pre></div></div>
|
308
306
|
|
309
307
|
<p>If you encounter any unexpected errors during the above, please refer to the <a href="/docs/troubleshooting/#configuration-problems">troubleshooting</a> page or the already-mentioned <a href="/docs/installation/#requirements">requirements</a> page, as you might be missing development headers or other prerequisites.</p>
|
310
308
|
|
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Resources | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Resources">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/resources/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.","url":"https://jekyllrb.com/docs/resources/","headline":"Resources","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/resources/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -289,7 +289,22 @@
|
|
289
289
|
<h1>Resources</h1>
|
290
290
|
<p>Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.</p>
|
291
291
|
|
292
|
-
<
|
292
|
+
<h2 id="editors">Editors</h2>
|
293
|
+
|
294
|
+
<ul>
|
295
|
+
<li>
|
296
|
+
<a href="https://atom.io/packages/jekyll">jekyll-atom</a>: A collection of snippets and tools for Jekyll in Atom</li>
|
297
|
+
<li>
|
298
|
+
<a href="https://atom.io/packages/markdown-writer">markdown-writer</a>: An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.</li>
|
299
|
+
<li>
|
300
|
+
<a href="https://github.com/23maverick23/sublime-jekyll">sublime-jekyll</a>: A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via <a href="https://packagecontrol.io/packages/Jekyll">Package Control</a>.</li>
|
301
|
+
<li>
|
302
|
+
<a href="https://github.com/parkr/vim-jekyll">vim-jekyll</a>: A vim plugin to generate new posts and run <code class="highlighter-rouge">jekyll build</code> all without leaving vim.</li>
|
303
|
+
<li>
|
304
|
+
<a href="https://wordpress.org/plugins/wp2jekyll/">Wordpress2Jekyll</a>: A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.</li>
|
305
|
+
</ul>
|
306
|
+
|
307
|
+
<h2 id="useful-guides">Useful Guides</h2>
|
293
308
|
|
294
309
|
<ul>
|
295
310
|
<li>
|
@@ -303,32 +318,41 @@
|
|
303
318
|
<li><a href="https://gist.github.com/jedschneider/2890453">Tips for working with GitHub Pages Integration</a></li>
|
304
319
|
</ul>
|
305
320
|
|
306
|
-
<
|
321
|
+
<h2 id="integrations">Integrations</h2>
|
307
322
|
|
308
323
|
<ul>
|
309
|
-
<li>
|
324
|
+
<li>
|
325
|
+
<p>Use a saas service as a backend for forms (contact forms, hiring forms, etc.)</p>
|
326
|
+
|
310
327
|
<ul>
|
311
|
-
<li><a href="https://formspree.io/">Formspree (
|
328
|
+
<li><a href="https://formspree.io/">Formspree (open source)</a></li>
|
312
329
|
<li><a href="https://formkeep.com/guides/contact-form-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll">FormKeep</a></li>
|
313
330
|
<li><a href="https://getsimpleform.com/">Simple Form</a></li>
|
314
331
|
<li><a href="https://www.formingo.co/guides/jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=Jekyll%20Documentation">Formingo</a></li>
|
332
|
+
<li>
|
333
|
+
<a href="https://staticman.net">Staticman</a>: Add user-generated content to a Jekyll site (free and open source)</li>
|
334
|
+
<li>
|
335
|
+
<a href="https://snipcart.com/blog/static-site-e-commerce-part-2-integrating-snipcart-with-jekyll">Snipcart</a>: Add a shopping cart to a Jekyll site</li>
|
336
|
+
<li>
|
337
|
+
<a href="https://www.contentful.com/ecosystem/jekyll/">Contentful</a>: use Jekyll together with the API-driven Contentful CMS.</li>
|
338
|
+
<li>
|
339
|
+
<a href="https://blog.algolia.com/instant-search-blog-documentation-jekyll-plugin/">Algolia</a>: Add a powerful instant search to your Jekyll site</li>
|
315
340
|
</ul>
|
316
341
|
</li>
|
317
|
-
<li>
|
318
|
-
<a href="http://jekyllbootstrap.com">Jekyll Bootstrap</a>, 0 to Blog in 3 minutes. Provides detailed explanations, examples, and helper-code to make getting started with Jekyll easier.</li>
|
319
|
-
<li>
|
320
|
-
<a href="http://www.justkez.com/integrating-twitter-with-jekyll/">Integrating Twitter with Jekyll</a>
|
321
|
-
<blockquote>
|
322
|
-
<p>“Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the WordPress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”</p>
|
323
|
-
</blockquote>
|
324
|
-
</li>
|
325
|
-
<li>
|
326
|
-
<a href="https://staticman.net">Staticman</a>: Add user-generated content to a Jekyll site (free and open source)</li>
|
327
342
|
</ul>
|
328
343
|
|
329
|
-
<
|
344
|
+
<h2 id="other-commentary">Other commentary</h2>
|
330
345
|
|
331
346
|
<ul>
|
347
|
+
<li>
|
348
|
+
<p><a href="https://mademistakes.com/articles/using-jekyll-2016/">How I’m using Jekyll in 2016</a></p>
|
349
|
+
</li>
|
350
|
+
<li>
|
351
|
+
<p><a href="https://mademistakes.com/articles/improving-jekyll-static-comments/">Static Comments with Jekyll & Staticman</a></p>
|
352
|
+
</li>
|
353
|
+
<li>
|
354
|
+
<p><a href="https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html">Adding Ajax pagination to Jekyll</a></p>
|
355
|
+
</li>
|
332
356
|
<li>
|
333
357
|
<p><a href="https://mikewest.org/2009/11/my-jekyll-fork">‘My Jekyll Fork’, by Mike West</a></p>
|
334
358
|
|
@@ -344,10 +368,10 @@
|
|
344
368
|
</blockquote>
|
345
369
|
</li>
|
346
370
|
<li>
|
347
|
-
<a href="http://www.justkez.com/generating-a-tag-cloud-in-jekyll/">Generating a Tag Cloud in Jekyll</a> – A guide to implementing a tag cloud and per-tag content pages using Jekyll.</
|
371
|
+
<p><a href="http://www.justkez.com/generating-a-tag-cloud-in-jekyll/">Generating a Tag Cloud in Jekyll</a> – A guide to implementing a tag cloud and per-tag content pages using Jekyll.</p>
|
372
|
+
</li>
|
348
373
|
<li>A way to <a href="https://github.com/rfelix/jekyll_ext">extend Jekyll</a> without forking and modifying the Jekyll gem codebase and some <a href="https://wiki.github.com/rfelix/jekyll_ext/extensions">portable Jekyll extensions</a> that can be reused and shared.</li>
|
349
374
|
<li><a href="http://numbers.brighterplanet.com/2010/08/09/sharing-rails-views-with-jekyll">Using your Rails layouts in Jekyll</a></li>
|
350
|
-
<li><a href="https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html">Adding Ajax pagination to Jekyll</a></li>
|
351
375
|
</ul>
|
352
376
|
|
353
377
|
|
data/site/docs/sites/index.html
CHANGED
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Sites using Jekyll | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Sites using Jekyll">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/sites/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"It’s interesting to see what designs and features others have come up with. Below are some Jekyll-powered blogs which were hand-picked for learning purposes.","url":"https://jekyllrb.com/docs/sites/","headline":"Sites using Jekyll","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/sites/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Static Files | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Static Files">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/static-files/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"In addition to renderable and convertible content, we also have static files.","url":"https://jekyllrb.com/docs/static-files/","headline":"Static Files","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/static-files/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -360,26 +360,22 @@ following metadata:</p>
|
|
360
360
|
|
361
361
|
<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>
|
362
362
|
|
363
|
-
<div class="language-yaml highlighter-rouge">
|
364
|
-
<
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
</code></pre>
|
370
|
-
</div>
|
363
|
+
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">defaults</span><span class="pi">:</span>
|
364
|
+
<span class="pi">-</span> <span class="na">scope</span><span class="pi">:</span>
|
365
|
+
<span class="na">path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">assets/img"</span>
|
366
|
+
<span class="na">values</span><span class="pi">:</span>
|
367
|
+
<span class="na">image</span><span class="pi">:</span> <span class="no">true</span>
|
368
|
+
</code></pre></div></div>
|
371
369
|
|
372
370
|
<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>
|
373
371
|
|
374
372
|
<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>
|
375
373
|
|
376
|
-
<div class="language-liquid highlighter-rouge">
|
377
|
-
<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>
|
374
|
+
<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>
|
378
375
|
<span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span>myimage<span class="w"> </span>in<span class="w"> </span>image_files<span class="w"> </span><span class="p">%}</span>
|
379
376
|
<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>
|
380
377
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endfor</span><span class="w"> </span><span class="p">%}</span>
|
381
|
-
</code></pre>
|
382
|
-
</div>
|
378
|
+
</code></pre></div></div>
|
383
379
|
|
384
380
|
<p>When you build your site, the output will list the path to each file that meets this front matter condition.</p>
|
385
381
|
|
@@ -4,13 +4,13 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Directory structure | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Directory structure">
|
16
16
|
<meta property="og:locale" content="en_US">
|
@@ -20,12 +20,12 @@
|
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/structure/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Jekyll 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.","url":"https://jekyllrb.com/docs/structure/","headline":"Directory structure","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/structure/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -297,8 +297,7 @@ product.</p>
|
|
297
297
|
|
298
298
|
<p>A basic Jekyll site usually looks something like this:</p>
|
299
299
|
|
300
|
-
<div class="language-sh highlighter-rouge">
|
301
|
-
<pre class="highlight"><code>.
|
300
|
+
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">.</span>
|
302
301
|
├── _config.yml
|
303
302
|
├── _data
|
304
303
|
| └── members.yml
|
@@ -320,8 +319,7 @@ product.</p>
|
|
320
319
|
├── _site
|
321
320
|
├── .jekyll-metadata
|
322
321
|
└── index.html <span class="c"># can also be an 'index.md' with valid YAML Frontmatter</span>
|
323
|
-
</code></pre>
|
324
|
-
</div>
|
322
|
+
</code></pre></div></div>
|
325
323
|
|
326
324
|
<div class="note info">
|
327
325
|
<h5>Directory structure of Jekyll sites using gem-based themes</h5>
|
@@ -4,28 +4,28 @@
|
|
4
4
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
5
|
<meta charset="UTF-8">
|
6
6
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.
|
7
|
+
<meta name="generator" content="Jekyll v3.6.0">
|
8
8
|
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
9
|
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
10
|
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
11
|
<link rel="stylesheet" href="/css/screen.css">
|
12
12
|
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.
|
13
|
+
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
14
|
<title>Templates | Jekyll • Simple, blog-aware, static sites</title>
|
15
15
|
<meta property="og:title" content="Templates">
|
16
16
|
<meta property="og:locale" content="en_US">
|
17
|
-
<meta name="description" content="Jekyll uses the Liquid templating language to process templates. All of the standard Liquid tags and filters are supported. Jekyll even adds a few handy filters and tags of its own
|
18
|
-
<meta property="og:description" content="Jekyll uses the Liquid templating language to process templates. All of the standard Liquid tags and filters are supported. Jekyll even adds a few handy filters and tags of its own
|
17
|
+
<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.">
|
18
|
+
<meta property="og: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.">
|
19
19
|
<link rel="canonical" href="https://jekyllrb.com/docs/templates/">
|
20
20
|
<meta property="og:url" content="https://jekyllrb.com/docs/templates/">
|
21
21
|
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
22
|
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-
|
23
|
+
<meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
|
24
24
|
<meta name="twitter:card" content="summary">
|
25
25
|
<meta name="twitter:site" content="@jekyllrb">
|
26
26
|
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
27
|
<script type="application/ld+json">
|
28
|
-
{"
|
28
|
+
{"name":null,"description":"Jekyll 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.","url":"https://jekyllrb.com/docs/templates/","headline":"Templates","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/templates/"},"@context":"http://schema.org"}</script>
|
29
29
|
<!-- End Jekyll SEO tag -->
|
30
30
|
|
31
31
|
<!--[if lt IE 9]>
|
@@ -290,8 +290,9 @@
|
|
290
290
|
<p>Jekyll uses the <a href="https://shopify.github.io/liquid/">Liquid</a> templating language to
|
291
291
|
process templates. All of the standard Liquid <a href="https://shopify.github.io/liquid/tags/control-flow/">tags</a> and
|
292
292
|
<a href="https://shopify.github.io/liquid/filters/abs/">filters</a> are
|
293
|
-
supported. Jekyll even adds a few handy filters
|
294
|
-
|
293
|
+
supported. To make common tasks easier, Jekyll even adds a few handy filters
|
294
|
+
and tags of its own, all of which you can find on this page. Jekyll even lets
|
295
|
+
you come up with your own tags via plugins.</p>
|
295
296
|
|
296
297
|
<h2 id="filters">Filters</h2>
|
297
298
|
|
@@ -711,14 +712,19 @@ The default is <code class="highlighter-rouge">default</code>. They are as follo
|
|
711
712
|
|
712
713
|
<h2 id="tags">Tags</h2>
|
713
714
|
|
715
|
+
<ul>
|
716
|
+
<li><a href="#includes">Includes</a></li>
|
717
|
+
<li><a href="#code-snippet-highlighting">Code snippet highlighting</a></li>
|
718
|
+
<li><a href="#links">Linking to pages, collections and posts (the new and improved way)</a></li>
|
719
|
+
<li><a href="#linking-to-posts">Linking to posts (the old way)</a></li>
|
720
|
+
</ul>
|
721
|
+
|
714
722
|
<h3 id="includes">Includes</h3>
|
715
723
|
|
716
724
|
<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>
|
717
725
|
|
718
|
-
<div class="language-liquid highlighter-rouge">
|
719
|
-
|
720
|
-
</code></pre>
|
721
|
-
</div>
|
726
|
+
<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><span class="na">footer</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="p">%}</span>
|
727
|
+
</code></pre></div></div>
|
722
728
|
|
723
729
|
<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>
|
724
730
|
|
@@ -739,16 +745,14 @@ languages</a></p>
|
|
739
745
|
|
740
746
|
<p>To render a code block with syntax highlighting, surround your code as follows:</p>
|
741
747
|
|
742
|
-
<div class="language-liquid highlighter-rouge">
|
743
|
-
<pre class="highlight"><code>
|
748
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
744
749
|
<span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span><span class="p">%}</span>
|
745
750
|
def foo
|
746
751
|
puts 'foo'
|
747
752
|
end
|
748
753
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endhighlight</span><span class="w"> </span><span class="p">%}</span>
|
749
754
|
|
750
|
-
</code></pre>
|
751
|
-
</div>
|
755
|
+
</code></pre></div></div>
|
752
756
|
|
753
757
|
<p>The argument to the <code class="highlighter-rouge">highlight</code> tag (<code class="highlighter-rouge">ruby</code> in the example above) is the
|
754
758
|
language identifier. To find the appropriate identifier to use for the language
|
@@ -763,16 +767,14 @@ Including the <code class="highlighter-rouge">linenos</code> argument will force
|
|
763
767
|
numbers. For instance, the following code block would include line numbers next
|
764
768
|
to each line:</p>
|
765
769
|
|
766
|
-
<div class="language-liquid highlighter-rouge">
|
767
|
-
<pre class="highlight"><code>
|
770
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
768
771
|
<span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span>linenos<span class="w"> </span><span class="p">%}</span>
|
769
772
|
def foo
|
770
773
|
puts 'foo'
|
771
774
|
end
|
772
775
|
<span class="p">{%</span><span class="w"> </span><span class="nt">endhighlight</span><span class="w"> </span><span class="p">%}</span>
|
773
776
|
|
774
|
-
</code></pre>
|
775
|
-
</div>
|
777
|
+
</code></pre></div></div>
|
776
778
|
|
777
779
|
<h4 id="stylesheets-for-syntax-highlighting">Stylesheets for syntax highlighting</h4>
|
778
780
|
|
@@ -784,30 +786,6 @@ site. If you use <code class="highlighter-rouge">linenos</code>, you might want
|
|
784
786
|
definition for the <code class="highlighter-rouge">.lineno</code> class in <code class="highlighter-rouge">syntax.css</code> to distinguish the line
|
785
787
|
numbers from the highlighted code.</p>
|
786
788
|
|
787
|
-
<h3 id="gist">Gist</h3>
|
788
|
-
|
789
|
-
<p>Use the <code class="highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works
|
790
|
-
with public or secret gists:</p>
|
791
|
-
|
792
|
-
<div class="language-liquid highlighter-rouge">
|
793
|
-
<pre class="highlight"><code>
|
794
|
-
<span class="p">{%</span><span class="w"> </span><span class="nt">gist</span><span class="w"> </span>parkr/<span class="mi">931</span>c<span class="mi">1</span>c<span class="mi">8</span>d<span class="mi">465</span>a<span class="mi">04042403</span><span class="w"> </span><span class="p">%}</span>
|
795
|
-
|
796
|
-
</code></pre>
|
797
|
-
</div>
|
798
|
-
|
799
|
-
<p>You may also optionally specify the filename in the gist to display:</p>
|
800
|
-
|
801
|
-
<div class="language-liquid highlighter-rouge">
|
802
|
-
<pre class="highlight"><code>
|
803
|
-
<span class="p">{%</span><span class="w"> </span><span class="nt">gist</span><span class="w"> </span>parkr/<span class="mi">931</span>c<span class="mi">1</span>c<span class="mi">8</span>d<span class="mi">465</span>a<span class="mi">04042403</span><span class="w"> </span>jekyll-private-gist.markdown<span class="w"> </span><span class="p">%}</span>
|
804
|
-
|
805
|
-
</code></pre>
|
806
|
-
</div>
|
807
|
-
|
808
|
-
<p>To use the <code class="highlighter-rouge">gist</code> tag, you’ll need to add the
|
809
|
-
<a href="https://github.com/jekyll/jekyll-gist">jekyll-gist</a> gem to your project.</p>
|
810
|
-
|
811
789
|
<h2 id="links">Links</h2>
|
812
790
|
|
813
791
|
<h3 id="link">Linking to pages</h3>
|
@@ -816,70 +794,60 @@ with public or secret gists:</p>
|
|
816
794
|
|
817
795
|
<p>You must include the file’s original extension when using the <code class="highlighter-rouge">link</code> tag. Here are some examples:</p>
|
818
796
|
|
819
|
-
<div class="language-liquid highlighter-rouge">
|
820
|
-
<pre class="highlight"><code>
|
797
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
821
798
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>
|
822
799
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>
|
823
800
|
<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>
|
824
801
|
<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>
|
825
802
|
|
826
|
-
</code></pre>
|
827
|
-
</div>
|
803
|
+
</code></pre></div></div>
|
828
804
|
|
829
805
|
<p>You can also use the <code class="highlighter-rouge">link</code> tag to create a link in Markdown as follows:</p>
|
830
806
|
|
831
|
-
<div class="language-liquid highlighter-rouge">
|
832
|
-
<pre class="highlight"><code>
|
807
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
833
808
|
[Link to a document](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_collection/name-of-document.md<span class="w"> </span><span class="p">%}</span>)
|
834
809
|
[Link to a post](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">link</span><span class="w"> </span>_posts/<span class="mi">2016</span>-<span class="mi">07</span>-<span class="mi">26</span>-name-of-post.md<span class="w"> </span><span class="p">%}</span>)
|
835
810
|
[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>)
|
836
811
|
[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>)
|
837
812
|
|
838
|
-
</code></pre>
|
839
|
-
</div>
|
813
|
+
</code></pre></div></div>
|
840
814
|
|
841
|
-
<p>(Including <code class="highlighter-rouge"
|
815
|
+
<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>
|
842
816
|
|
843
817
|
<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>
|
844
818
|
|
845
819
|
<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>
|
846
820
|
|
847
|
-
<p>If you’re unsure of the path, add <code class="highlighter-rouge"
|
821
|
+
<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>
|
848
822
|
|
849
|
-
<p>One major benefit of using the <code class="highlighter-rouge">link</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>
|
823
|
+
<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>
|
850
824
|
|
851
|
-
<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"
|
825
|
+
<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>
|
852
826
|
|
853
827
|
<h3 id="linking-to-posts">Linking to posts</h3>
|
854
828
|
|
855
829
|
<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>
|
856
830
|
|
857
|
-
<div class="language-liquid highlighter-rouge">
|
858
|
-
<pre class="highlight"><code>
|
831
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
859
832
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
860
833
|
|
861
|
-
</code></pre>
|
862
|
-
</div>
|
834
|
+
</code></pre></div></div>
|
863
835
|
|
864
836
|
<p>If you organize your posts in subdirectories, you need to include subdirectory path to the post:</p>
|
865
837
|
|
866
|
-
<div class="language-liquid highlighter-rouge">
|
867
|
-
<pre class="highlight"><code>
|
838
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
868
839
|
<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span>/subdir/<span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>
|
869
840
|
|
870
|
-
</code></pre>
|
871
|
-
</div>
|
841
|
+
</code></pre></div></div>
|
872
842
|
|
873
843
|
<p>There is no need to include the file extension when using the <code class="highlighter-rouge">post_url</code> tag.</p>
|
874
844
|
|
875
845
|
<p>You can also use this tag to create a link to a post in Markdown as follows:</p>
|
876
846
|
|
877
|
-
<div class="language-liquid highlighter-rouge">
|
878
|
-
<pre class="highlight"><code>
|
847
|
+
<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
879
848
|
[Name of Link](<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">baseurl</span><span class="w"> </span><span class="p">}}{%</span><span class="w"> </span><span class="nt">post_url</span><span class="w"> </span><span class="mi">2010</span>-<span class="mi">07</span>-<span class="mi">21</span>-name-of-post<span class="w"> </span><span class="p">%}</span>)
|
880
849
|
|
881
|
-
</code></pre>
|
882
|
-
</div>
|
850
|
+
</code></pre></div></div>
|
883
851
|
|
884
852
|
|
885
853
|
|