jekyll-docs 3.6.0 → 3.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (253) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll.rb +195 -0
  3. data/lib/jekyll/cleaner.rb +110 -0
  4. data/lib/jekyll/collection.rb +230 -0
  5. data/lib/jekyll/command.rb +78 -0
  6. data/lib/jekyll/commands/build.rb +102 -0
  7. data/lib/jekyll/commands/clean.rb +43 -0
  8. data/lib/jekyll/commands/doctor.rb +153 -0
  9. data/lib/jekyll/commands/help.rb +34 -0
  10. data/lib/jekyll/commands/new.rb +156 -0
  11. data/lib/jekyll/commands/new_theme.rb +40 -0
  12. data/lib/jekyll/commands/serve.rb +245 -0
  13. data/lib/jekyll/commands/serve/servlet.rb +62 -0
  14. data/lib/jekyll/configuration.rb +410 -0
  15. data/lib/jekyll/converter.rb +54 -0
  16. data/lib/jekyll/converters/identity.rb +23 -0
  17. data/lib/jekyll/converters/markdown.rb +104 -0
  18. data/lib/jekyll/converters/markdown/kramdown_parser.rb +123 -0
  19. data/lib/jekyll/converters/markdown/rdiscount_parser.rb +35 -0
  20. data/lib/jekyll/converters/markdown/redcarpet_parser.rb +108 -0
  21. data/lib/jekyll/converters/smartypants.rb +36 -0
  22. data/lib/jekyll/convertible.rb +251 -0
  23. data/lib/jekyll/deprecator.rb +52 -0
  24. data/lib/jekyll/document.rb +507 -0
  25. data/lib/jekyll/drops/collection_drop.rb +22 -0
  26. data/lib/jekyll/drops/document_drop.rb +69 -0
  27. data/lib/jekyll/drops/drop.rb +214 -0
  28. data/lib/jekyll/drops/excerpt_drop.rb +15 -0
  29. data/lib/jekyll/drops/jekyll_drop.rb +33 -0
  30. data/lib/jekyll/drops/site_drop.rb +47 -0
  31. data/lib/jekyll/drops/static_file_drop.rb +13 -0
  32. data/lib/jekyll/drops/unified_payload_drop.rb +25 -0
  33. data/lib/jekyll/drops/url_drop.rb +88 -0
  34. data/lib/jekyll/entry_filter.rb +123 -0
  35. data/lib/jekyll/errors.rb +20 -0
  36. data/lib/jekyll/excerpt.rb +126 -0
  37. data/lib/jekyll/external.rb +74 -0
  38. data/lib/jekyll/filters.rb +430 -0
  39. data/lib/jekyll/filters/grouping_filters.rb +65 -0
  40. data/lib/jekyll/filters/url_filters.rb +60 -0
  41. data/lib/jekyll/frontmatter_defaults.rb +197 -0
  42. data/lib/jekyll/generator.rb +5 -0
  43. data/lib/jekyll/hooks.rb +104 -0
  44. data/lib/jekyll/layout.rb +62 -0
  45. data/lib/jekyll/liquid_extensions.rb +24 -0
  46. data/lib/jekyll/liquid_renderer.rb +49 -0
  47. data/lib/jekyll/liquid_renderer/file.rb +56 -0
  48. data/lib/jekyll/liquid_renderer/table.rb +96 -0
  49. data/lib/jekyll/log_adapter.rb +147 -0
  50. data/lib/jekyll/mime.types +825 -0
  51. data/lib/jekyll/page.rb +187 -0
  52. data/lib/jekyll/plugin.rb +98 -0
  53. data/lib/jekyll/plugin_manager.rb +113 -0
  54. data/lib/jekyll/publisher.rb +23 -0
  55. data/lib/jekyll/reader.rb +134 -0
  56. data/lib/jekyll/readers/collection_reader.rb +22 -0
  57. data/lib/jekyll/readers/data_reader.rb +77 -0
  58. data/lib/jekyll/readers/layout_reader.rb +71 -0
  59. data/lib/jekyll/readers/page_reader.rb +25 -0
  60. data/lib/jekyll/readers/post_reader.rb +72 -0
  61. data/lib/jekyll/readers/static_file_reader.rb +25 -0
  62. data/lib/jekyll/readers/theme_assets_reader.rb +49 -0
  63. data/lib/jekyll/regenerator.rb +201 -0
  64. data/lib/jekyll/related_posts.rb +52 -0
  65. data/lib/jekyll/renderer.rb +269 -0
  66. data/lib/jekyll/site.rb +471 -0
  67. data/lib/jekyll/static_file.rb +162 -0
  68. data/lib/jekyll/stevenson.rb +61 -0
  69. data/lib/jekyll/tags/highlight.rb +141 -0
  70. data/lib/jekyll/tags/include.rb +215 -0
  71. data/lib/jekyll/tags/link.rb +37 -0
  72. data/lib/jekyll/tags/post_url.rb +103 -0
  73. data/lib/jekyll/theme.rb +68 -0
  74. data/lib/jekyll/theme_builder.rb +119 -0
  75. data/lib/jekyll/url.rb +161 -0
  76. data/lib/jekyll/utils.rb +337 -0
  77. data/lib/jekyll/utils/ansi.rb +59 -0
  78. data/lib/jekyll/utils/exec.rb +27 -0
  79. data/lib/jekyll/utils/platforms.rb +82 -0
  80. data/lib/jekyll/utils/rouge.rb +21 -0
  81. data/lib/jekyll/utils/win_tz.rb +75 -0
  82. data/lib/jekyll/version.rb +5 -0
  83. data/lib/site_template/404.html +24 -0
  84. data/lib/site_template/_config.yml +43 -0
  85. data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +25 -0
  86. data/lib/site_template/about.md +18 -0
  87. data/lib/site_template/index.md +6 -0
  88. data/lib/theme_template/CODE_OF_CONDUCT.md.erb +74 -0
  89. data/lib/theme_template/Gemfile +4 -0
  90. data/lib/theme_template/LICENSE.txt.erb +21 -0
  91. data/lib/theme_template/README.md.erb +52 -0
  92. data/lib/theme_template/_layouts/default.html +1 -0
  93. data/lib/theme_template/_layouts/page.html +5 -0
  94. data/lib/theme_template/_layouts/post.html +5 -0
  95. data/lib/theme_template/example/_config.yml.erb +1 -0
  96. data/lib/theme_template/example/_post.md +12 -0
  97. data/lib/theme_template/example/index.html +14 -0
  98. data/lib/theme_template/example/style.scss +7 -0
  99. data/lib/theme_template/gitignore.erb +5 -0
  100. data/lib/theme_template/theme.gemspec.erb +19 -0
  101. metadata +103 -156
  102. data/lib/jekyll-docs.rb +0 -31
  103. data/site/404.html +0 -153
  104. data/site/CNAME +0 -1
  105. data/site/community/index.html +0 -299
  106. data/site/conduct/index.html +0 -10
  107. data/site/css/screen.css +0 -1
  108. data/site/docs/assets/index.html +0 -724
  109. data/site/docs/code_of_conduct/index.html +0 -730
  110. data/site/docs/collections/index.html +0 -1097
  111. data/site/docs/conduct/index.html +0 -744
  112. data/site/docs/configuration/index.html +0 -1403
  113. data/site/docs/continuous-integration/buddyworks/index.html +0 -726
  114. data/site/docs/continuous-integration/circleci/index.html +0 -757
  115. data/site/docs/continuous-integration/index.html +0 -681
  116. data/site/docs/continuous-integration/travis-ci/index.html +0 -891
  117. data/site/docs/contributing/index.html +0 -863
  118. data/site/docs/datafiles/index.html +0 -780
  119. data/site/docs/deployment-methods/index.html +0 -875
  120. data/site/docs/drafts/index.html +0 -636
  121. data/site/docs/extras/index.html +0 -689
  122. data/site/docs/frontmatter/index.html +0 -807
  123. data/site/docs/github-pages/index.html +0 -819
  124. data/site/docs/history/index.html +0 -3955
  125. data/site/docs/home/index.html +0 -644
  126. data/site/docs/includes/index.html +0 -800
  127. data/site/docs/index.html +0 -10
  128. data/site/docs/installation/index.html +0 -732
  129. data/site/docs/maintaining/affinity-team-captain/index.html +0 -706
  130. data/site/docs/maintaining/avoiding-burnout/index.html +0 -709
  131. data/site/docs/maintaining/becoming-a-maintainer/index.html +0 -717
  132. data/site/docs/maintaining/index.html +0 -713
  133. data/site/docs/maintaining/merging-a-pull-request/index.html +0 -747
  134. data/site/docs/maintaining/reviewing-a-pull-request/index.html +0 -725
  135. data/site/docs/maintaining/special-labels/index.html +0 -705
  136. data/site/docs/maintaining/triaging-an-issue/index.html +0 -735
  137. data/site/docs/migrations/index.html +0 -647
  138. data/site/docs/pages/index.html +0 -695
  139. data/site/docs/pagination/index.html +0 -870
  140. data/site/docs/permalinks/index.html +0 -1027
  141. data/site/docs/plugins/index.html +0 -1800
  142. data/site/docs/posts/index.html +0 -858
  143. data/site/docs/quickstart/index.html +0 -650
  144. data/site/docs/resources/index.html +0 -769
  145. data/site/docs/sites/index.html +0 -702
  146. data/site/docs/static-files/index.html +0 -720
  147. data/site/docs/structure/index.html +0 -822
  148. data/site/docs/templates/index.html +0 -1208
  149. data/site/docs/themes/index.html +0 -935
  150. data/site/docs/troubleshooting/index.html +0 -893
  151. data/site/docs/upgrading/0-to-2/index.html +0 -826
  152. data/site/docs/upgrading/2-to-3/index.html +0 -824
  153. data/site/docs/upgrading/index.html +0 -693
  154. data/site/docs/usage/index.html +0 -705
  155. data/site/docs/variables/index.html +0 -1048
  156. data/site/docs/windows/index.html +0 -799
  157. data/site/favicon.ico +0 -0
  158. data/site/feed.xml +0 -372
  159. data/site/fonts/FontAwesome.eot +0 -0
  160. data/site/fonts/FontAwesome.svg +0 -12
  161. data/site/fonts/FontAwesome.ttf +0 -0
  162. data/site/fonts/FontAwesome.woff +0 -0
  163. data/site/github.html +0 -10
  164. data/site/help/index.html +0 -244
  165. data/site/icomoon-selection.json +0 -96
  166. data/site/img/article-footer.png +0 -0
  167. data/site/img/footer-arrow.png +0 -0
  168. data/site/img/footer-logo.png +0 -0
  169. data/site/img/jekyll-sticker.jpg +0 -0
  170. data/site/img/jekylllayoutconcept.png +0 -0
  171. data/site/img/logo-2x.png +0 -0
  172. data/site/img/logo-rss.png +0 -0
  173. data/site/img/octojekyll.png +0 -0
  174. data/site/index.html +0 -267
  175. data/site/issues.html +0 -10
  176. data/site/js/html5shiv.min.js +0 -4
  177. data/site/js/respond.min.js +0 -5
  178. data/site/latest_version.txt +0 -1
  179. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +0 -570
  180. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +0 -570
  181. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +0 -571
  182. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +0 -568
  183. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +0 -570
  184. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +0 -569
  185. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +0 -565
  186. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +0 -565
  187. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +0 -572
  188. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +0 -566
  189. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +0 -564
  190. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +0 -599
  191. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +0 -568
  192. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +0 -583
  193. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +0 -565
  194. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +0 -564
  195. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +0 -573
  196. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +0 -564
  197. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +0 -569
  198. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +0 -585
  199. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +0 -565
  200. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +0 -567
  201. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +0 -582
  202. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +0 -579
  203. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +0 -568
  204. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +0 -588
  205. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +0 -574
  206. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +0 -597
  207. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +0 -575
  208. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +0 -565
  209. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +0 -572
  210. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +0 -567
  211. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +0 -568
  212. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +0 -588
  213. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +0 -563
  214. data/site/news/2015/10/26/jekyll-3-0-released/index.html +0 -592
  215. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +0 -576
  216. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +0 -566
  217. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +0 -599
  218. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +0 -583
  219. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +0 -578
  220. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +0 -569
  221. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +0 -565
  222. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +0 -571
  223. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +0 -566
  224. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +0 -572
  225. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +0 -576
  226. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +0 -564
  227. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +0 -566
  228. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +0 -567
  229. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +0 -676
  230. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +0 -571
  231. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +0 -566
  232. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +0 -645
  233. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +0 -569
  234. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +0 -592
  235. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +0 -649
  236. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +0 -598
  237. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +0 -594
  238. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +0 -589
  239. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +0 -569
  240. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +0 -573
  241. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +0 -565
  242. data/site/news/index.html +0 -3609
  243. data/site/news/releases/index.html +0 -3344
  244. data/site/philosophy.html +0 -46
  245. data/site/readme.md +0 -23
  246. data/site/robots.txt +0 -1
  247. data/site/sitemap.xml +0 -485
  248. data/site/tutorials/convert-site-to-jekyll/index.html +0 -793
  249. data/site/tutorials/custom-404-page/index.html +0 -358
  250. data/site/tutorials/home/index.html +0 -323
  251. data/site/tutorials/index.html +0 -10
  252. data/site/tutorials/navigation/index.html +0 -872
  253. data/site/tutorials/orderofinterpretation/index.html +0 -441
@@ -1,807 +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.0">
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>Front Matter | Jekyll • Simple, blog-aware, static sites</title>
15
- <meta property="og:title" content="Front Matter">
16
- <meta property="og:locale" content="en_US">
17
- <meta name="description" content="The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:">
18
- <meta property="og:description" content="The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:">
19
- <link rel="canonical" href="https://jekyllrb.com/docs/frontmatter/">
20
- <meta property="og:url" content="https://jekyllrb.com/docs/frontmatter/">
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-24T08:07:43-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":"The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:","url":"https://jekyllrb.com/docs/frontmatter/","headline":"Front Matter","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/frontmatter/"},"@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/frontmatter.md"><i class="fa fa-pencil"></i>  Improve this page</a>
288
- </div>
289
- <h1>Front Matter</h1>
290
- <p>The front matter is where Jekyll starts to get really cool. Any file that
291
- contains a <a href="http://yaml.org/">YAML</a> front matter block will be processed by
292
- Jekyll as a special file. The front matter must be the first thing in the file
293
- and must take the form of valid YAML set between triple-dashed lines. Here is a
294
- basic example:</p>
295
-
296
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
297
- <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
298
- <span class="na">title</span><span class="pi">:</span> <span class="s">Blogging Like a Hacker</span>
299
- <span class="nn">---</span>
300
- </code></pre></div></div>
301
-
302
- <p>Between these triple-dashed lines, you can set predefined variables (see below
303
- for a reference) or even create custom ones of your own. These variables will
304
- then be available to you to access using Liquid tags both further down in the
305
- file and also in any layouts or includes that the page or post in question
306
- relies on.</p>
307
-
308
- <div class="note warning">
309
- <h5>UTF-8 Character Encoding Warning</h5>
310
- <p>
311
- If you use UTF-8 encoding, make sure that no <code>BOM</code> header
312
- characters exist in your files or very, very bad things will happen to
313
- Jekyll. This is especially relevant if you’re running
314
- <a href="../windows/">Jekyll on Windows</a>.
315
- </p>
316
- </div>
317
-
318
- <div class="note">
319
- <h5>ProTip™: Front Matter Variables Are Optional</h5>
320
- <p>
321
- If you want to use <a href="../variables/">Liquid tags and variables</a>
322
- but don’t need anything in your front matter, just leave it empty! The set
323
- of triple-dashed lines with nothing in between will still get Jekyll to
324
- process your file. (This is useful for things like CSS and RSS feeds!)
325
- </p>
326
- </div>
327
-
328
- <h2 id="predefined-global-variables">Predefined Global Variables</h2>
329
-
330
- <p>There are a number of predefined global variables that you can set in the
331
- front matter of a page or post.</p>
332
-
333
- <div class="mobile-side-scroller">
334
- <table>
335
- <thead>
336
- <tr>
337
- <th>Variable</th>
338
- <th>Description</th>
339
- </tr>
340
- </thead>
341
- <tbody>
342
- <tr>
343
- <td>
344
- <p><code>layout</code></p>
345
- </td>
346
- <td>
347
- <p>
348
-
349
- If set, this specifies the layout file to use. Use the layout file
350
- name without the file extension. Layout files must be placed in the
351
- <code>_layouts</code> directory.
352
-
353
- </p>
354
- </td>
355
- </tr>
356
- <tr>
357
- <td>
358
- <p><code>permalink</code></p>
359
- </td>
360
- <td>
361
- <p>
362
-
363
- If you need your processed blog post URLs to be something other than
364
- the site-wide style (default <code>/year/month/day/title.html</code>), then you can set
365
- this variable and it will be used as the final URL.
366
-
367
- </p>
368
- </td>
369
- </tr>
370
- <tr>
371
- <td>
372
- <p><code>published</code></p>
373
- </td>
374
- <td>
375
- <p>
376
- Set to false if you don’t want a specific post to show up when the
377
- site is generated.
378
- </p>
379
- </td>
380
- </tr>
381
- </tbody>
382
- </table>
383
- </div>
384
-
385
- <div class="note">
386
- <h5>ProTip™: Render Posts Marked As Unpublished</h5>
387
- <p>
388
- To preview unpublished pages, simply run `jekyll serve` or `jekyll build`
389
- with the `--unpublished` switch. Jekyll also has a handy <a href="../drafts/">drafts</a>
390
- feature tailored specifically for blog posts.
391
- </p>
392
- </div>
393
-
394
- <h2 id="custom-variables">Custom Variables</h2>
395
-
396
- <p>Any variables in the front matter that are not predefined are mixed into the
397
- data that is sent to the Liquid templating engine during the conversion. For
398
- instance, if you set a title, you can use that in your layout to set the page
399
- title:</p>
400
-
401
- <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;!DOCTYPE HTML&gt;</span>
402
- <span class="nt">&lt;html&gt;</span>
403
- <span class="nt">&lt;head&gt;</span>
404
- <span class="nt">&lt;title&gt;</span>{{ page.title }}<span class="nt">&lt;/title&gt;</span>
405
- <span class="nt">&lt;/head&gt;</span>
406
- <span class="nt">&lt;body&gt;</span>
407
- ...
408
- </code></pre></div></div>
409
-
410
- <h2 id="predefined-variables-for-posts">Predefined Variables for Posts</h2>
411
-
412
- <p>These are available out-of-the-box to be used in the front matter for a post.</p>
413
-
414
- <div class="mobile-side-scroller">
415
- <table>
416
- <thead>
417
- <tr>
418
- <th>Variable</th>
419
- <th>Description</th>
420
- </tr>
421
- </thead>
422
- <tbody>
423
- <tr>
424
- <td>
425
- <p><code>date</code></p>
426
- </td>
427
- <td>
428
- <p>
429
- A date here overrides the date from the name of the post. This can be
430
- used to ensure correct sorting of posts. A date is specified in the
431
- format <code>YYYY-MM-DD HH:MM:SS +/-TTTT</code>; hours, minutes, seconds, and timezone offset
432
- are optional.
433
- </p>
434
- </td>
435
- </tr>
436
- <tr>
437
- <td>
438
- <p style="margin-bottom: 5px;"><code>category</code></p>
439
- <p><code>categories</code></p>
440
- </td>
441
- <td>
442
- <p>
443
-
444
- Instead of placing posts inside of folders, you can specify one or
445
- more categories that the post belongs to. When the site is generated
446
- the post will act as though it had been set with these categories
447
- normally. Categories (plural key) can be specified as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
448
- space-separated string.
449
-
450
- </p>
451
- </td>
452
- </tr>
453
- <tr>
454
- <td>
455
- <p><code>tags</code></p>
456
- </td>
457
- <td>
458
- <p>
459
-
460
- Similar to categories, one or multiple tags can be added to a post.
461
- Also like categories, tags can be specified as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
462
- space-separated string.
463
-
464
- </p>
465
- </td>
466
- </tr>
467
- </tbody>
468
- </table>
469
- </div>
470
-
471
- <div class="note">
472
- <h5>ProTip™: Don't repeat yourself</h5>
473
- <p>
474
- If you don't want to repeat your frequently used front matter variables
475
- over and over, just define <a href="../configuration/#front-matter-defaults" title="Front Matter defaults">defaults</a>
476
- for them and only override them where necessary (or not at all). This works
477
- both for predefined and custom variables.
478
- </p>
479
- </div>
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
- <div class="section-nav">
511
- <div class="left align-right">
512
-
513
-
514
-
515
- <a href="/docs/configuration/" class="prev">Back</a>
516
-
517
- </div>
518
- <div class="right align-left">
519
-
520
-
521
-
522
- <a href="/docs/posts/" class="next">Next</a>
523
-
524
- </div>
525
- </div>
526
- <div class="clear"></div>
527
-
528
- </article>
529
- </div>
530
-
531
- <div class="unit one-fifth hide-on-mobiles">
532
- <aside>
533
-
534
- <h4>Getting Started</h4>
535
- <ul>
536
-
537
-
538
-
539
- <li class=""><a href="/docs/home/">Welcome</a></li>
540
-
541
-
542
-
543
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
544
-
545
-
546
-
547
- <li class=""><a href="/docs/installation/">Installation</a></li>
548
-
549
-
550
-
551
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
552
-
553
-
554
-
555
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
556
-
557
-
558
-
559
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
560
-
561
-
562
-
563
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
564
-
565
- </ul>
566
-
567
-
568
- <h4>Your Content</h4>
569
- <ul>
570
-
571
-
572
-
573
- <li class="current"><a href="/docs/frontmatter/">Front Matter</a></li>
574
-
575
-
576
-
577
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
578
-
579
-
580
-
581
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
582
-
583
-
584
-
585
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
586
-
587
-
588
-
589
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
590
-
591
-
592
-
593
- <li class=""><a href="/docs/variables/">Variables</a></li>
594
-
595
-
596
-
597
- <li class=""><a href="/docs/collections/">Collections</a></li>
598
-
599
-
600
-
601
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
602
-
603
-
604
-
605
- <li class=""><a href="/docs/assets/">Assets</a></li>
606
-
607
-
608
-
609
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
610
-
611
- </ul>
612
-
613
-
614
- <h4>Customization</h4>
615
- <ul>
616
-
617
-
618
-
619
- <li class=""><a href="/docs/templates/">Templates</a></li>
620
-
621
-
622
-
623
- <li class=""><a href="/docs/includes/">Includes</a></li>
624
-
625
-
626
-
627
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
628
-
629
-
630
-
631
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
632
-
633
-
634
-
635
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
636
-
637
-
638
-
639
- <li class=""><a href="/docs/themes/">Themes</a></li>
640
-
641
-
642
-
643
- <li class=""><a href="/docs/extras/">Extras</a></li>
644
-
645
- </ul>
646
-
647
-
648
- <h4>Deployment</h4>
649
- <ul>
650
-
651
-
652
-
653
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
654
-
655
-
656
-
657
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
658
-
659
-
660
-
661
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
662
-
663
- </ul>
664
-
665
-
666
- <h4>Miscellaneous</h4>
667
- <ul>
668
-
669
-
670
-
671
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
672
-
673
-
674
-
675
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
676
-
677
-
678
-
679
- <li class=""><a href="/docs/resources/">Resources</a></li>
680
-
681
-
682
-
683
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
684
-
685
-
686
-
687
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
688
-
689
- </ul>
690
-
691
-
692
- <h4>Meta</h4>
693
- <ul>
694
-
695
-
696
-
697
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
698
-
699
-
700
-
701
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
702
-
703
-
704
-
705
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
706
-
707
-
708
-
709
- <li class=""><a href="/docs/history/">History</a></li>
710
-
711
- </ul>
712
-
713
-
714
- </aside>
715
- </div>
716
-
717
-
718
- <div class="clear"></div>
719
-
720
- </div>
721
- </section>
722
-
723
-
724
- <footer>
725
- <div class="grid">
726
- <div class="unit one-third center-on-mobiles">
727
- <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>
728
- </div>
729
- <div class="unit two-thirds align-right center-on-mobiles">
730
- <p>
731
- Proudly hosted by
732
- <a href="https://github.com">
733
- <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
734
- </a>
735
- </p>
736
- </div>
737
- </div>
738
- </footer>
739
-
740
- <script>
741
- var anchorForId = function (id) {
742
- var anchor = document.createElement("a");
743
- anchor.className = "header-link";
744
- anchor.href = "#" + id;
745
- anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
746
- anchor.title = "Permalink";
747
- return anchor;
748
- };
749
-
750
- var linkifyAnchors = function (level, containingElement) {
751
- var headers = containingElement.getElementsByTagName("h" + level);
752
- for (var h = 0; h < headers.length; h++) {
753
- var header = headers[h];
754
-
755
- if (typeof header.id !== "undefined" && header.id !== "") {
756
- header.appendChild(anchorForId(header.id));
757
- }
758
- }
759
- };
760
-
761
- document.onreadystatechange = function () {
762
- if (this.readyState === "complete") {
763
- var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
764
- if (!contentBlock) {
765
- return;
766
- }
767
- for (var level = 1; level <= 6; level++) {
768
- linkifyAnchors(level, contentBlock);
769
- }
770
- }
771
- };
772
- </script>
773
-
774
-
775
- <!-- Gauges (http://get.gaug.es/) -->
776
- <script>
777
- var _gauges = _gauges || [];
778
- (function() {
779
- var t = document.createElement('script');
780
- t.type = 'text/javascript';
781
- t.async = true;
782
- t.id = 'gauges-tracker';
783
- t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
784
- t.src = '//secure.gaug.es/track.js';
785
- var s = document.getElementsByTagName('script')[0];
786
- s.parentNode.insertBefore(t, s);
787
- })();
788
- </script>
789
-
790
-
791
-
792
- <!-- Google Analytics (https://www.google.com/analytics) -->
793
- <script>
794
- !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
795
- (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
796
- L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
797
- L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
798
-
799
- ga('create', 'UA-50755011-1', 'jekyllrb.com');
800
- ga('send', 'pageview');
801
-
802
- </script>
803
-
804
-
805
-
806
- </body>
807
- </html>