jekyll-docs 3.6.1.0 → 3.6.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/jekyll.rb +195 -0
- data/lib/jekyll/cleaner.rb +110 -0
- data/lib/jekyll/collection.rb +230 -0
- data/lib/jekyll/command.rb +78 -0
- data/lib/jekyll/commands/build.rb +102 -0
- data/lib/jekyll/commands/clean.rb +43 -0
- data/lib/jekyll/commands/doctor.rb +153 -0
- data/lib/jekyll/commands/help.rb +34 -0
- data/lib/jekyll/commands/new.rb +156 -0
- data/lib/jekyll/commands/new_theme.rb +40 -0
- data/lib/jekyll/commands/serve.rb +245 -0
- data/lib/jekyll/commands/serve/servlet.rb +62 -0
- data/lib/jekyll/configuration.rb +410 -0
- data/lib/jekyll/converter.rb +54 -0
- data/lib/jekyll/converters/identity.rb +23 -0
- data/lib/jekyll/converters/markdown.rb +104 -0
- data/lib/jekyll/converters/markdown/kramdown_parser.rb +123 -0
- data/lib/jekyll/converters/markdown/rdiscount_parser.rb +35 -0
- data/lib/jekyll/converters/markdown/redcarpet_parser.rb +108 -0
- data/lib/jekyll/converters/smartypants.rb +36 -0
- data/lib/jekyll/convertible.rb +251 -0
- data/lib/jekyll/deprecator.rb +52 -0
- data/lib/jekyll/document.rb +507 -0
- data/lib/jekyll/drops/collection_drop.rb +22 -0
- data/lib/jekyll/drops/document_drop.rb +69 -0
- data/lib/jekyll/drops/drop.rb +214 -0
- data/lib/jekyll/drops/excerpt_drop.rb +15 -0
- data/lib/jekyll/drops/jekyll_drop.rb +33 -0
- data/lib/jekyll/drops/site_drop.rb +47 -0
- data/lib/jekyll/drops/static_file_drop.rb +13 -0
- data/lib/jekyll/drops/unified_payload_drop.rb +25 -0
- data/lib/jekyll/drops/url_drop.rb +88 -0
- data/lib/jekyll/entry_filter.rb +123 -0
- data/lib/jekyll/errors.rb +20 -0
- data/lib/jekyll/excerpt.rb +126 -0
- data/lib/jekyll/external.rb +74 -0
- data/lib/jekyll/filters.rb +430 -0
- data/lib/jekyll/filters/grouping_filters.rb +65 -0
- data/lib/jekyll/filters/url_filters.rb +60 -0
- data/lib/jekyll/frontmatter_defaults.rb +197 -0
- data/lib/jekyll/generator.rb +5 -0
- data/lib/jekyll/hooks.rb +104 -0
- data/lib/jekyll/layout.rb +62 -0
- data/lib/jekyll/liquid_extensions.rb +24 -0
- data/lib/jekyll/liquid_renderer.rb +49 -0
- data/lib/jekyll/liquid_renderer/file.rb +56 -0
- data/lib/jekyll/liquid_renderer/table.rb +96 -0
- data/lib/jekyll/log_adapter.rb +147 -0
- data/lib/jekyll/mime.types +825 -0
- data/lib/jekyll/page.rb +187 -0
- data/lib/jekyll/plugin.rb +98 -0
- data/lib/jekyll/plugin_manager.rb +113 -0
- data/lib/jekyll/publisher.rb +23 -0
- data/lib/jekyll/reader.rb +134 -0
- data/lib/jekyll/readers/collection_reader.rb +22 -0
- data/lib/jekyll/readers/data_reader.rb +77 -0
- data/lib/jekyll/readers/layout_reader.rb +71 -0
- data/lib/jekyll/readers/page_reader.rb +25 -0
- data/lib/jekyll/readers/post_reader.rb +72 -0
- data/lib/jekyll/readers/static_file_reader.rb +25 -0
- data/lib/jekyll/readers/theme_assets_reader.rb +49 -0
- data/lib/jekyll/regenerator.rb +201 -0
- data/lib/jekyll/related_posts.rb +52 -0
- data/lib/jekyll/renderer.rb +269 -0
- data/lib/jekyll/site.rb +472 -0
- data/lib/jekyll/static_file.rb +162 -0
- data/lib/jekyll/stevenson.rb +61 -0
- data/lib/jekyll/tags/highlight.rb +141 -0
- data/lib/jekyll/tags/include.rb +215 -0
- data/lib/jekyll/tags/link.rb +37 -0
- data/lib/jekyll/tags/post_url.rb +103 -0
- data/lib/jekyll/theme.rb +68 -0
- data/lib/jekyll/theme_builder.rb +119 -0
- data/lib/jekyll/url.rb +161 -0
- data/lib/jekyll/utils.rb +340 -0
- data/lib/jekyll/utils/ansi.rb +59 -0
- data/lib/jekyll/utils/exec.rb +27 -0
- data/lib/jekyll/utils/platforms.rb +82 -0
- data/lib/jekyll/utils/rouge.rb +21 -0
- data/lib/jekyll/utils/win_tz.rb +75 -0
- data/lib/jekyll/version.rb +5 -0
- data/lib/site_template/404.html +24 -0
- data/lib/site_template/_config.yml +43 -0
- data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +25 -0
- data/lib/site_template/about.md +18 -0
- data/lib/site_template/index.md +6 -0
- data/lib/theme_template/CODE_OF_CONDUCT.md.erb +74 -0
- data/lib/theme_template/Gemfile +4 -0
- data/lib/theme_template/LICENSE.txt.erb +21 -0
- data/lib/theme_template/README.md.erb +52 -0
- data/lib/theme_template/_layouts/default.html +1 -0
- data/lib/theme_template/_layouts/page.html +5 -0
- data/lib/theme_template/_layouts/post.html +5 -0
- data/lib/theme_template/example/_config.yml.erb +1 -0
- data/lib/theme_template/example/_post.md +12 -0
- data/lib/theme_template/example/index.html +14 -0
- data/lib/theme_template/example/style.scss +7 -0
- data/lib/theme_template/gitignore.erb +5 -0
- data/lib/theme_template/theme.gemspec.erb +19 -0
- metadata +103 -156
- data/lib/jekyll-docs.rb +0 -31
- data/site/404.html +0 -153
- data/site/CNAME +0 -1
- data/site/community/index.html +0 -299
- data/site/conduct/index.html +0 -10
- data/site/css/screen.css +0 -1
- data/site/docs/assets/index.html +0 -724
- data/site/docs/code_of_conduct/index.html +0 -730
- data/site/docs/collections/index.html +0 -1097
- data/site/docs/conduct/index.html +0 -744
- data/site/docs/configuration/index.html +0 -1403
- data/site/docs/continuous-integration/buddyworks/index.html +0 -726
- data/site/docs/continuous-integration/circleci/index.html +0 -757
- data/site/docs/continuous-integration/index.html +0 -681
- data/site/docs/continuous-integration/travis-ci/index.html +0 -891
- data/site/docs/contributing/index.html +0 -863
- data/site/docs/datafiles/index.html +0 -780
- data/site/docs/deployment-methods/index.html +0 -875
- data/site/docs/drafts/index.html +0 -636
- data/site/docs/extras/index.html +0 -689
- data/site/docs/frontmatter/index.html +0 -821
- data/site/docs/github-pages/index.html +0 -819
- data/site/docs/history/index.html +0 -3955
- data/site/docs/home/index.html +0 -644
- data/site/docs/includes/index.html +0 -800
- data/site/docs/index.html +0 -10
- data/site/docs/installation/index.html +0 -732
- data/site/docs/maintaining/affinity-team-captain/index.html +0 -706
- data/site/docs/maintaining/avoiding-burnout/index.html +0 -709
- data/site/docs/maintaining/becoming-a-maintainer/index.html +0 -717
- data/site/docs/maintaining/index.html +0 -713
- data/site/docs/maintaining/merging-a-pull-request/index.html +0 -747
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +0 -725
- data/site/docs/maintaining/special-labels/index.html +0 -705
- data/site/docs/maintaining/triaging-an-issue/index.html +0 -735
- data/site/docs/migrations/index.html +0 -647
- data/site/docs/pages/index.html +0 -695
- data/site/docs/pagination/index.html +0 -870
- data/site/docs/permalinks/index.html +0 -1035
- data/site/docs/plugins/index.html +0 -1800
- data/site/docs/posts/index.html +0 -858
- data/site/docs/quickstart/index.html +0 -650
- data/site/docs/resources/index.html +0 -769
- data/site/docs/sites/index.html +0 -702
- data/site/docs/static-files/index.html +0 -720
- data/site/docs/structure/index.html +0 -822
- data/site/docs/templates/index.html +0 -1208
- data/site/docs/themes/index.html +0 -935
- data/site/docs/troubleshooting/index.html +0 -916
- data/site/docs/upgrading/0-to-2/index.html +0 -826
- data/site/docs/upgrading/2-to-3/index.html +0 -824
- data/site/docs/upgrading/index.html +0 -693
- data/site/docs/usage/index.html +0 -705
- data/site/docs/variables/index.html +0 -1048
- data/site/docs/windows/index.html +0 -799
- data/site/favicon.ico +0 -0
- data/site/feed.xml +0 -372
- data/site/fonts/FontAwesome.eot +0 -0
- data/site/fonts/FontAwesome.svg +0 -12
- data/site/fonts/FontAwesome.ttf +0 -0
- data/site/fonts/FontAwesome.woff +0 -0
- data/site/github.html +0 -10
- data/site/help/index.html +0 -244
- data/site/icomoon-selection.json +0 -96
- data/site/img/article-footer.png +0 -0
- data/site/img/footer-arrow.png +0 -0
- data/site/img/footer-logo.png +0 -0
- data/site/img/jekyll-sticker.jpg +0 -0
- data/site/img/jekylllayoutconcept.png +0 -0
- data/site/img/logo-2x.png +0 -0
- data/site/img/logo-rss.png +0 -0
- data/site/img/octojekyll.png +0 -0
- data/site/index.html +0 -267
- data/site/issues.html +0 -10
- data/site/js/html5shiv.min.js +0 -4
- data/site/js/respond.min.js +0 -5
- data/site/latest_version.txt +0 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +0 -570
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +0 -570
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +0 -571
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +0 -568
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +0 -570
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +0 -569
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +0 -565
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +0 -565
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +0 -572
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +0 -566
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +0 -564
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +0 -599
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +0 -568
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +0 -583
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +0 -565
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +0 -564
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +0 -573
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +0 -564
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +0 -569
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +0 -585
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +0 -565
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +0 -567
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +0 -582
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +0 -579
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +0 -568
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +0 -588
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +0 -574
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +0 -597
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +0 -575
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +0 -565
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +0 -572
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +0 -567
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +0 -568
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +0 -588
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +0 -563
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +0 -592
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +0 -576
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +0 -566
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +0 -599
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +0 -583
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +0 -578
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +0 -569
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +0 -565
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +0 -571
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +0 -566
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +0 -572
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +0 -576
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +0 -564
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +0 -566
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +0 -567
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +0 -676
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +0 -571
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +0 -566
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +0 -645
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +0 -569
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +0 -592
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +0 -649
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +0 -598
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +0 -594
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +0 -589
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +0 -569
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +0 -573
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +0 -565
- data/site/news/index.html +0 -3609
- data/site/news/releases/index.html +0 -3344
- data/site/philosophy.html +0 -46
- data/site/readme.md +0 -23
- data/site/robots.txt +0 -1
- data/site/sitemap.xml +0 -485
- data/site/tutorials/convert-site-to-jekyll/index.html +0 -793
- data/site/tutorials/custom-404-page/index.html +0 -358
- data/site/tutorials/home/index.html +0 -323
- data/site/tutorials/index.html +0 -10
- data/site/tutorials/navigation/index.html +0 -872
- data/site/tutorials/orderofinterpretation/index.html +0 -441
data/site/docs/home/index.html
DELETED
@@ -1,644 +0,0 @@
|
|
1
|
-
<!DOCTYPE HTML>
|
2
|
-
<html lang="en-US">
|
3
|
-
<head>
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.6.1">
|
8
|
-
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
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
|
-
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
|
-
<link rel="stylesheet" href="/css/screen.css">
|
12
|
-
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
|
-
<title>Welcome | Jekyll • Simple, blog-aware, static sites</title>
|
15
|
-
<meta property="og:title" content="Welcome">
|
16
|
-
<meta property="og:locale" content="en_US">
|
17
|
-
<meta name="description" content="This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing your content, customizing the way your site works and looks, deploying to various environments, and give you some advice on participating in the future development of Jekyll itself.">
|
18
|
-
<meta property="og:description" content="This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing your content, customizing the way your site works and looks, deploying to various environments, and give you some advice on participating in the future development of Jekyll itself.">
|
19
|
-
<link rel="canonical" href="https://jekyllrb.com/docs/home/">
|
20
|
-
<meta property="og:url" content="https://jekyllrb.com/docs/home/">
|
21
|
-
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
|
-
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-10-24T09:09:24-07:00">
|
24
|
-
<meta name="twitter:card" content="summary">
|
25
|
-
<meta name="twitter:site" content="@jekyllrb">
|
26
|
-
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
|
-
<script type="application/ld+json">
|
28
|
-
{"name":null,"description":"This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing your content, customizing the way your site works and looks, deploying to various environments, and give you some advice on participating in the future development of Jekyll itself.","url":"https://jekyllrb.com/docs/home/","headline":"Welcome","dateModified":"2017-10-24T09:09:24-07:00","datePublished":"2017-10-24T09:09:24-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/home/"},"@context":"http://schema.org"}</script>
|
29
|
-
<!-- End Jekyll SEO tag -->
|
30
|
-
|
31
|
-
<!--[if lt IE 9]>
|
32
|
-
<script src="/js/html5shiv.min.js"></script>
|
33
|
-
<script src="/js/respond.min.js"></script>
|
34
|
-
<![endif]-->
|
35
|
-
</head>
|
36
|
-
|
37
|
-
|
38
|
-
<body class="wrap">
|
39
|
-
<header>
|
40
|
-
<nav class="mobile-nav show-on-mobiles">
|
41
|
-
<ul>
|
42
|
-
<li class="">
|
43
|
-
<a href="/">Home</a>
|
44
|
-
</li>
|
45
|
-
<li class="current">
|
46
|
-
<a href="/docs/home/">Docs</a>
|
47
|
-
</li>
|
48
|
-
<li class="">
|
49
|
-
<a href="/news/">News</a>
|
50
|
-
</li>
|
51
|
-
<li class="">
|
52
|
-
<a href="/community/">Community</a>
|
53
|
-
</li>
|
54
|
-
<li class="">
|
55
|
-
<a href="/help/">Help</a>
|
56
|
-
</li>
|
57
|
-
<li>
|
58
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
59
|
-
</li>
|
60
|
-
</ul>
|
61
|
-
|
62
|
-
</nav>
|
63
|
-
<div class="grid">
|
64
|
-
<div class="unit one-third center-on-mobiles">
|
65
|
-
<h1>
|
66
|
-
<a href="/">
|
67
|
-
<span class="sr-only">Jekyll</span>
|
68
|
-
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
69
|
-
</a>
|
70
|
-
</h1>
|
71
|
-
</div>
|
72
|
-
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
73
|
-
<ul>
|
74
|
-
<li class="">
|
75
|
-
<a href="/">Home</a>
|
76
|
-
</li>
|
77
|
-
<li class="current">
|
78
|
-
<a href="/docs/home/">Docs</a>
|
79
|
-
</li>
|
80
|
-
<li class="">
|
81
|
-
<a href="/news/">News</a>
|
82
|
-
</li>
|
83
|
-
<li class="">
|
84
|
-
<a href="/community/">Community</a>
|
85
|
-
</li>
|
86
|
-
<li class="">
|
87
|
-
<a href="/help/">Help</a>
|
88
|
-
</li>
|
89
|
-
<li>
|
90
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
91
|
-
</li>
|
92
|
-
</ul>
|
93
|
-
|
94
|
-
</nav>
|
95
|
-
</div>
|
96
|
-
</header>
|
97
|
-
|
98
|
-
|
99
|
-
<section class="docs">
|
100
|
-
<div class="grid">
|
101
|
-
|
102
|
-
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
103
|
-
<select onchange="if (this.value) window.location.href=this.value">
|
104
|
-
<option value="">Navigate the docs…</option>
|
105
|
-
|
106
|
-
<optgroup label="Getting Started">
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
<option value="/docs/home/">Welcome</option>
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
<option value="/docs/quickstart/">Quick-start guide</option>
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
<option value="/docs/installation/">Installation</option>
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
<option value="/docs/windows/">Jekyll on Windows</option>
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
<option value="/docs/usage/">Basic Usage</option>
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
<option value="/docs/structure/">Directory structure</option>
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
<option value="/docs/configuration/">Configuration</option>
|
135
|
-
|
136
|
-
|
137
|
-
</optgroup>
|
138
|
-
|
139
|
-
<optgroup label="Your Content">
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
<option value="/docs/frontmatter/">Front Matter</option>
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
<option value="/docs/posts/">Writing posts</option>
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
<option value="/docs/drafts/">Working with drafts</option>
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
<option value="/docs/pages/">Creating pages</option>
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
<option value="/docs/static-files/">Static Files</option>
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
<option value="/docs/variables/">Variables</option>
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
<option value="/docs/collections/">Collections</option>
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
<option value="/docs/datafiles/">Data Files</option>
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
<option value="/docs/assets/">Assets</option>
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
<option value="/docs/migrations/">Blog migrations</option>
|
180
|
-
|
181
|
-
|
182
|
-
</optgroup>
|
183
|
-
|
184
|
-
<optgroup label="Customization">
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
<option value="/docs/templates/">Templates</option>
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
<option value="/docs/includes/">Includes</option>
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
<option value="/docs/permalinks/">Permalinks</option>
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
<option value="/docs/pagination/">Pagination</option>
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
<option value="/docs/plugins/">Plugins</option>
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
<option value="/docs/themes/">Themes</option>
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
<option value="/docs/extras/">Extras</option>
|
213
|
-
|
214
|
-
|
215
|
-
</optgroup>
|
216
|
-
|
217
|
-
<optgroup label="Deployment">
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
<option value="/docs/github-pages/">GitHub Pages</option>
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
<option value="/docs/deployment-methods/">Deployment methods</option>
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
<option value="/docs/continuous-integration/">Continuous Integration</option>
|
230
|
-
|
231
|
-
|
232
|
-
</optgroup>
|
233
|
-
|
234
|
-
<optgroup label="Miscellaneous">
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
<option value="/docs/troubleshooting/">Troubleshooting</option>
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
<option value="/docs/sites/">Sites using Jekyll</option>
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
<option value="/docs/resources/">Resources</option>
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
<option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
<option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
|
255
|
-
|
256
|
-
|
257
|
-
</optgroup>
|
258
|
-
|
259
|
-
<optgroup label="Meta">
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
<option value="/docs/contributing/">Contributing</option>
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
<option value="/docs/maintaining/">Maintaining Jekyll</option>
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
<option value="/docs/conduct/">Code of Conduct</option>
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
<option value="/docs/history/">History</option>
|
276
|
-
|
277
|
-
|
278
|
-
</optgroup>
|
279
|
-
|
280
|
-
</select>
|
281
|
-
</div>
|
282
|
-
|
283
|
-
|
284
|
-
<div class="unit four-fifths">
|
285
|
-
<article>
|
286
|
-
<div class="improve right hide-on-mobiles">
|
287
|
-
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/index.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
288
|
-
</div>
|
289
|
-
<h1>Welcome</h1>
|
290
|
-
<p>This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
291
|
-
as getting your site up and running, creating and managing your content,
|
292
|
-
customizing the way your site works and looks, deploying to various
|
293
|
-
environments, and give you some advice on participating in the future
|
294
|
-
development of Jekyll itself.</p>
|
295
|
-
|
296
|
-
<h2 id="so-what-is-jekyll-exactly">So what is Jekyll, exactly?</h2>
|
297
|
-
|
298
|
-
<p>Jekyll is a simple, blog-aware, static site generator. It takes a template
|
299
|
-
directory containing raw text files in various formats, runs it through
|
300
|
-
a converter (like <a href="https://daringfireball.net/projects/markdown/">Markdown</a>)
|
301
|
-
and our <a href="https://github.com/Shopify/liquid/wiki">Liquid</a> renderer, and
|
302
|
-
spits out a complete, ready-to-publish static website suitable
|
303
|
-
for serving with your favorite web server. Jekyll also happens to be the engine
|
304
|
-
behind <a href="https://pages.github.com">GitHub Pages</a>, which means you can use Jekyll
|
305
|
-
to host your project’s page, blog, or website from GitHub’s servers <strong>for
|
306
|
-
free</strong>.</p>
|
307
|
-
|
308
|
-
<h2 id="helpful-hints">Helpful Hints</h2>
|
309
|
-
|
310
|
-
<p>Throughout this guide there are a number of small-but-handy pieces of
|
311
|
-
information that can make using Jekyll easier, more interesting, and less
|
312
|
-
hazardous. Here’s what to look out for.</p>
|
313
|
-
|
314
|
-
<div class="note">
|
315
|
-
<h5>ProTips™ help you get more from Jekyll</h5>
|
316
|
-
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
|
317
|
-
</div>
|
318
|
-
|
319
|
-
<div class="note info">
|
320
|
-
<h5>Notes are handy pieces of information</h5>
|
321
|
-
<p>These are for the extra tidbits sometimes necessary to understand
|
322
|
-
Jekyll.</p>
|
323
|
-
</div>
|
324
|
-
|
325
|
-
<div class="note warning">
|
326
|
-
<h5>Warnings help you not blow things up</h5>
|
327
|
-
<p>Be aware of these messages if you wish to avoid certain death.</p>
|
328
|
-
</div>
|
329
|
-
|
330
|
-
<div class="note unreleased">
|
331
|
-
<h5>You'll see this by a feature that hasn't been released</h5>
|
332
|
-
<p>Some pieces of this website are for future versions of Jekyll that
|
333
|
-
are not yet released.</p>
|
334
|
-
</div>
|
335
|
-
|
336
|
-
<p>If you come across anything along the way that we haven’t covered, or if you
|
337
|
-
know of a tip you think others would find handy, please <a href="https://github.com/jekyll/jekyll/issues/new">file an
|
338
|
-
issue</a> and we’ll see about
|
339
|
-
including it in this guide.</p>
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
<div class="section-nav">
|
350
|
-
<div class="left align-right">
|
351
|
-
|
352
|
-
<span class="prev disabled">Back</span>
|
353
|
-
|
354
|
-
</div>
|
355
|
-
<div class="right align-left">
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
<a href="/docs/quickstart/" class="next">Next</a>
|
360
|
-
|
361
|
-
</div>
|
362
|
-
</div>
|
363
|
-
<div class="clear"></div>
|
364
|
-
|
365
|
-
</article>
|
366
|
-
</div>
|
367
|
-
|
368
|
-
<div class="unit one-fifth hide-on-mobiles">
|
369
|
-
<aside>
|
370
|
-
|
371
|
-
<h4>Getting Started</h4>
|
372
|
-
<ul>
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
<li class="current"><a href="/docs/home/">Welcome</a></li>
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
<li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
<li class=""><a href="/docs/installation/">Installation</a></li>
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
<li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
<li class=""><a href="/docs/usage/">Basic Usage</a></li>
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
<li class=""><a href="/docs/structure/">Directory structure</a></li>
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
<li class=""><a href="/docs/configuration/">Configuration</a></li>
|
401
|
-
|
402
|
-
</ul>
|
403
|
-
|
404
|
-
|
405
|
-
<h4>Your Content</h4>
|
406
|
-
<ul>
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
<li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
<li class=""><a href="/docs/posts/">Writing posts</a></li>
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
<li class=""><a href="/docs/drafts/">Working with drafts</a></li>
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
<li class=""><a href="/docs/pages/">Creating pages</a></li>
|
423
|
-
|
424
|
-
|
425
|
-
|
426
|
-
<li class=""><a href="/docs/static-files/">Static Files</a></li>
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
<li class=""><a href="/docs/variables/">Variables</a></li>
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
<li class=""><a href="/docs/collections/">Collections</a></li>
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
<li class=""><a href="/docs/datafiles/">Data Files</a></li>
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
<li class=""><a href="/docs/assets/">Assets</a></li>
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
<li class=""><a href="/docs/migrations/">Blog migrations</a></li>
|
447
|
-
|
448
|
-
</ul>
|
449
|
-
|
450
|
-
|
451
|
-
<h4>Customization</h4>
|
452
|
-
<ul>
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
<li class=""><a href="/docs/templates/">Templates</a></li>
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
<li class=""><a href="/docs/includes/">Includes</a></li>
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
<li class=""><a href="/docs/pagination/">Pagination</a></li>
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
<li class=""><a href="/docs/plugins/">Plugins</a></li>
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
<li class=""><a href="/docs/themes/">Themes</a></li>
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
<li class=""><a href="/docs/extras/">Extras</a></li>
|
481
|
-
|
482
|
-
</ul>
|
483
|
-
|
484
|
-
|
485
|
-
<h4>Deployment</h4>
|
486
|
-
<ul>
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
<li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
<li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
<li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
|
499
|
-
|
500
|
-
</ul>
|
501
|
-
|
502
|
-
|
503
|
-
<h4>Miscellaneous</h4>
|
504
|
-
<ul>
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
<li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
<li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
<li class=""><a href="/docs/resources/">Resources</a></li>
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
<li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
<li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
|
525
|
-
|
526
|
-
</ul>
|
527
|
-
|
528
|
-
|
529
|
-
<h4>Meta</h4>
|
530
|
-
<ul>
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
<li class=""><a href="/docs/contributing/">Contributing</a></li>
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
<li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
<li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
<li class=""><a href="/docs/history/">History</a></li>
|
547
|
-
|
548
|
-
</ul>
|
549
|
-
|
550
|
-
|
551
|
-
</aside>
|
552
|
-
</div>
|
553
|
-
|
554
|
-
|
555
|
-
<div class="clear"></div>
|
556
|
-
|
557
|
-
</div>
|
558
|
-
</section>
|
559
|
-
|
560
|
-
|
561
|
-
<footer>
|
562
|
-
<div class="grid">
|
563
|
-
<div class="unit one-third center-on-mobiles">
|
564
|
-
<p>The contents of this website are <br>© 2017 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
565
|
-
</div>
|
566
|
-
<div class="unit two-thirds align-right center-on-mobiles">
|
567
|
-
<p>
|
568
|
-
Proudly hosted by
|
569
|
-
<a href="https://github.com">
|
570
|
-
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
571
|
-
</a>
|
572
|
-
</p>
|
573
|
-
</div>
|
574
|
-
</div>
|
575
|
-
</footer>
|
576
|
-
|
577
|
-
<script>
|
578
|
-
var anchorForId = function (id) {
|
579
|
-
var anchor = document.createElement("a");
|
580
|
-
anchor.className = "header-link";
|
581
|
-
anchor.href = "#" + id;
|
582
|
-
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
583
|
-
anchor.title = "Permalink";
|
584
|
-
return anchor;
|
585
|
-
};
|
586
|
-
|
587
|
-
var linkifyAnchors = function (level, containingElement) {
|
588
|
-
var headers = containingElement.getElementsByTagName("h" + level);
|
589
|
-
for (var h = 0; h < headers.length; h++) {
|
590
|
-
var header = headers[h];
|
591
|
-
|
592
|
-
if (typeof header.id !== "undefined" && header.id !== "") {
|
593
|
-
header.appendChild(anchorForId(header.id));
|
594
|
-
}
|
595
|
-
}
|
596
|
-
};
|
597
|
-
|
598
|
-
document.onreadystatechange = function () {
|
599
|
-
if (this.readyState === "complete") {
|
600
|
-
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
601
|
-
if (!contentBlock) {
|
602
|
-
return;
|
603
|
-
}
|
604
|
-
for (var level = 1; level <= 6; level++) {
|
605
|
-
linkifyAnchors(level, contentBlock);
|
606
|
-
}
|
607
|
-
}
|
608
|
-
};
|
609
|
-
</script>
|
610
|
-
|
611
|
-
|
612
|
-
<!-- Gauges (http://get.gaug.es/) -->
|
613
|
-
<script>
|
614
|
-
var _gauges = _gauges || [];
|
615
|
-
(function() {
|
616
|
-
var t = document.createElement('script');
|
617
|
-
t.type = 'text/javascript';
|
618
|
-
t.async = true;
|
619
|
-
t.id = 'gauges-tracker';
|
620
|
-
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
621
|
-
t.src = '//secure.gaug.es/track.js';
|
622
|
-
var s = document.getElementsByTagName('script')[0];
|
623
|
-
s.parentNode.insertBefore(t, s);
|
624
|
-
})();
|
625
|
-
</script>
|
626
|
-
|
627
|
-
|
628
|
-
|
629
|
-
<!-- Google Analytics (https://www.google.com/analytics) -->
|
630
|
-
<script>
|
631
|
-
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
632
|
-
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
633
|
-
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
634
|
-
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
635
|
-
|
636
|
-
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
637
|
-
ga('send', 'pageview');
|
638
|
-
|
639
|
-
</script>
|
640
|
-
|
641
|
-
|
642
|
-
|
643
|
-
</body>
|
644
|
-
</html>
|