jekyll-docs 3.9.0 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (225) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll-docs.rb +3 -3
  3. data/site/404.html +10 -7
  4. data/site/css/screen.css +3 -1
  5. data/site/css/screen.css.map +28 -0
  6. data/site/docs/assets/index.html +412 -453
  7. data/site/docs/code_of_conduct/index.html +447 -501
  8. data/site/docs/collections/index.html +487 -674
  9. data/site/docs/community/bug/index.html +603 -0
  10. data/site/docs/community/index.html +635 -0
  11. data/site/docs/conduct/index.html +447 -515
  12. data/site/docs/configuration/default/index.html +682 -0
  13. data/site/docs/configuration/environments/index.html +641 -0
  14. data/site/docs/configuration/front-matter-defaults/index.html +738 -0
  15. data/site/docs/configuration/incremental-regeneration/index.html +631 -0
  16. data/site/docs/configuration/index.html +405 -1230
  17. data/site/docs/configuration/liquid/index.html +616 -0
  18. data/site/docs/configuration/markdown/index.html +766 -0
  19. data/site/docs/configuration/options/index.html +1011 -0
  20. data/site/docs/configuration/webrick/index.html +615 -0
  21. data/site/docs/continuous-integration/buddyworks/index.html +393 -479
  22. data/site/docs/continuous-integration/circleci/index.html +465 -481
  23. data/site/docs/continuous-integration/travis-ci/index.html +450 -507
  24. data/site/docs/contributing/index.html +425 -514
  25. data/site/docs/datafiles/index.html +411 -453
  26. data/site/docs/deployment-methods/index.html +9 -871
  27. data/site/docs/deployment/automated/index.html +663 -0
  28. data/site/docs/deployment/index.html +607 -0
  29. data/site/docs/deployment/manual/index.html +631 -0
  30. data/site/docs/deployment/third-party/index.html +639 -0
  31. data/site/docs/drafts/index.html +9 -634
  32. data/site/docs/extras/index.html +9 -687
  33. data/site/docs/front-matter/index.html +799 -0
  34. data/site/docs/frontmatter/index.html +9 -819
  35. data/site/docs/github-pages/index.html +407 -475
  36. data/site/docs/history/index.html +1370 -1154
  37. data/site/docs/home/index.html +9 -627
  38. data/site/docs/includes/index.html +425 -501
  39. data/site/docs/index.html +630 -9
  40. data/site/docs/installation/index.html +403 -540
  41. data/site/docs/installation/macos/index.html +716 -0
  42. data/site/docs/installation/other-linux/index.html +613 -0
  43. data/site/docs/installation/ubuntu/index.html +623 -0
  44. data/site/docs/installation/windows/index.html +733 -0
  45. data/site/docs/layouts/index.html +726 -0
  46. data/site/docs/liquid/filters/index.html +1169 -0
  47. data/site/docs/liquid/index.html +615 -0
  48. data/site/docs/liquid/tags/index.html +728 -0
  49. data/site/docs/maintaining/affinity-team-captain/index.html +395 -479
  50. data/site/docs/maintaining/avoiding-burnout/index.html +391 -475
  51. data/site/docs/maintaining/becoming-a-maintainer/index.html +391 -475
  52. data/site/docs/maintaining/index.html +391 -486
  53. data/site/docs/maintaining/merging-a-pull-request/index.html +406 -490
  54. data/site/docs/maintaining/releasing-a-new-version/index.html +409 -485
  55. data/site/docs/maintaining/reviewing-a-pull-request/index.html +392 -476
  56. data/site/docs/maintaining/special-labels/index.html +397 -481
  57. data/site/docs/maintaining/triaging-an-issue/index.html +394 -478
  58. data/site/docs/markdown-101/index.html +601 -0
  59. data/site/docs/migrations/index.html +396 -440
  60. data/site/docs/pages/index.html +408 -482
  61. data/site/docs/pagination/index.html +450 -509
  62. data/site/docs/permalinks/index.html +552 -587
  63. data/site/docs/plugins/commands/index.html +656 -0
  64. data/site/docs/plugins/converters/index.html +685 -0
  65. data/site/docs/plugins/filters/index.html +624 -0
  66. data/site/docs/plugins/generators/index.html +697 -0
  67. data/site/docs/plugins/hooks/index.html +838 -0
  68. data/site/docs/plugins/index.html +415 -1565
  69. data/site/docs/plugins/installation/index.html +681 -0
  70. data/site/docs/plugins/tags/index.html +699 -0
  71. data/site/docs/plugins/your-first-plugin/index.html +741 -0
  72. data/site/docs/posts/index.html +491 -627
  73. data/site/docs/quickstart/index.html +9 -645
  74. data/site/docs/resources/index.html +9 -761
  75. data/site/docs/ruby-101/index.html +640 -0
  76. data/site/docs/sites/index.html +9 -696
  77. data/site/docs/static-files/index.html +401 -433
  78. data/site/docs/step-by-step/01-setup/index.html +771 -0
  79. data/site/docs/step-by-step/02-liquid/index.html +756 -0
  80. data/site/docs/step-by-step/03-front-matter/index.html +730 -0
  81. data/site/docs/step-by-step/04-layouts/index.html +770 -0
  82. data/site/docs/step-by-step/05-includes/index.html +768 -0
  83. data/site/docs/step-by-step/06-data-files/index.html +738 -0
  84. data/site/docs/step-by-step/07-assets/index.html +773 -0
  85. data/site/docs/step-by-step/08-blogging/index.html +835 -0
  86. data/site/docs/step-by-step/09-collections/index.html +932 -0
  87. data/site/docs/step-by-step/10-deployment/index.html +842 -0
  88. data/site/docs/structure/index.html +411 -430
  89. data/site/docs/support/index.html +392 -476
  90. data/site/docs/templates/index.html +9 -1232
  91. data/site/docs/themes/index.html +487 -521
  92. data/site/docs/troubleshooting/index.html +443 -520
  93. data/site/docs/upgrading/0-to-2/index.html +437 -523
  94. data/site/docs/upgrading/2-to-3/index.html +422 -507
  95. data/site/docs/upgrading/3-to-4/index.html +765 -0
  96. data/site/docs/upgrading/index.html +395 -478
  97. data/site/docs/usage/index.html +409 -506
  98. data/site/docs/variables/index.html +504 -652
  99. data/site/docs/windows/index.html +9 -784
  100. data/site/feed.xml +269 -188
  101. data/site/feed/release.xml +324 -0
  102. data/site/fonts/lato-v14-latin-300.woff +0 -0
  103. data/site/fonts/lato-v14-latin-300.woff2 +0 -0
  104. data/site/fonts/lato-v14-latin-300italic.woff +0 -0
  105. data/site/fonts/lato-v14-latin-300italic.woff2 +0 -0
  106. data/site/fonts/lato-v14-latin-700.woff +0 -0
  107. data/site/fonts/lato-v14-latin-700.woff2 +0 -0
  108. data/site/fonts/lato-v14-latin-700italic.woff +0 -0
  109. data/site/fonts/lato-v14-latin-700italic.woff2 +0 -0
  110. data/site/fonts/lato-v14-latin-900.woff +0 -0
  111. data/site/fonts/lato-v14-latin-900.woff2 +0 -0
  112. data/site/fonts/lato-v14-latin-900italic.woff +0 -0
  113. data/site/fonts/lato-v14-latin-900italic.woff2 +0 -0
  114. data/site/fonts/lato-v14-latin-italic.woff +0 -0
  115. data/site/fonts/lato-v14-latin-italic.woff2 +0 -0
  116. data/site/fonts/lato-v14-latin-regular.woff +0 -0
  117. data/site/fonts/lato-v14-latin-regular.woff2 +0 -0
  118. data/site/help/index.html +9 -247
  119. data/site/img/forestry-logo.svg +19 -0
  120. data/site/img/jekyll-og.png +0 -0
  121. data/site/img/spacer.gif +0 -0
  122. data/site/index.html +56 -29
  123. data/site/jekyllconf/index.html +62 -35
  124. data/site/latest_version.txt +1 -1
  125. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +180 -115
  126. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +182 -117
  127. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +183 -118
  128. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +184 -119
  129. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +183 -118
  130. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +180 -115
  131. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +182 -117
  132. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +182 -117
  133. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +185 -120
  134. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +183 -118
  135. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +180 -115
  136. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +189 -124
  137. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +181 -116
  138. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +181 -116
  139. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +180 -115
  140. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +182 -117
  141. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +181 -116
  142. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +181 -116
  143. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +181 -116
  144. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +184 -119
  145. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +180 -115
  146. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +181 -116
  147. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +185 -120
  148. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +182 -117
  149. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +181 -116
  150. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +189 -124
  151. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +187 -122
  152. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +188 -123
  153. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +180 -115
  154. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +182 -117
  155. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +179 -114
  156. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +180 -115
  157. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +179 -114
  158. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +180 -115
  159. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +180 -115
  160. data/site/news/2015/10/26/jekyll-3-0-released/index.html +185 -120
  161. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +184 -119
  162. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +182 -117
  163. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +186 -121
  164. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +183 -118
  165. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +181 -116
  166. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +182 -117
  167. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +179 -114
  168. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +181 -116
  169. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +181 -116
  170. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +180 -115
  171. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +186 -121
  172. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +181 -116
  173. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +181 -116
  174. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +179 -114
  175. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +184 -119
  176. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +180 -115
  177. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +179 -114
  178. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +207 -142
  179. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +181 -116
  180. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +183 -118
  181. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +181 -116
  182. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +189 -124
  183. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +190 -125
  184. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +187 -122
  185. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +182 -117
  186. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +185 -120
  187. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +181 -116
  188. data/site/news/2017/10/19/diversity-open-source/index.html +181 -116
  189. data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +183 -118
  190. data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +184 -119
  191. data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +189 -124
  192. data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +180 -115
  193. data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +185 -120
  194. data/site/news/2018/04/19/development-update/index.html +699 -0
  195. data/site/news/2018/04/19/jekyll-3-8-0-released/index.html +715 -0
  196. data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +182 -117
  197. data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +181 -116
  198. data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +183 -118
  199. data/site/news/2018/08/01/jekyll-sponsoring/index.html +748 -0
  200. data/site/news/2018/09/19/security-fixes-for-3-6-3-7-3-8/index.html +692 -0
  201. data/site/news/2018/11/04/jekyll-3-8-5-released/index.html +682 -0
  202. data/site/news/2019/03/18/jekyll-4-0-0-pre-alpha1-released/index.html +710 -0
  203. data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +180 -115
  204. data/site/news/2019/07/20/jekyll-4-0-0-pre-beta1-released/index.html +11 -0
  205. data/site/news/2019/08/04/jekyll-4-0-0-pre-beta1-released/index.html +708 -0
  206. data/site/news/2019/08/20/jekyll-4-0-0-released/index.html +809 -0
  207. data/site/news/index.html +976 -326
  208. data/site/news/releases/index.html +820 -321
  209. data/site/{philosophy.html → philosophy/index.html} +1 -1
  210. data/site/redirects.json +1 -1
  211. data/site/resources/index.html +332 -0
  212. data/site/showcase/index.html +844 -0
  213. data/site/sitemap.xml +256 -81
  214. data/site/team/index.html +63 -77
  215. data/site/tutorials/cache-api/index.html +418 -0
  216. data/site/tutorials/convert-site-to-jekyll/index.html +155 -124
  217. data/site/tutorials/custom-404-page/index.html +76 -43
  218. data/site/tutorials/home/index.html +64 -37
  219. data/site/tutorials/navigation/index.html +186 -103
  220. data/site/tutorials/orderofinterpretation/index.html +80 -53
  221. data/site/tutorials/using-jekyll-with-bundler/index.html +80 -51
  222. data/site/tutorials/video-walkthroughs/index.html +62 -35
  223. metadata +102 -13
  224. data/site/community/index.html +0 -11
  225. data/site/docs/continuous-integration/index.html +0 -681
@@ -3,32 +3,35 @@
3
3
  <head>
4
4
  <meta charset="UTF-8">
5
5
  <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <meta name="generator" content="Jekyll v3.9.0">
6
+ <meta name="generator" content="Jekyll v4.0.0">
7
7
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
8
+ <link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
8
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">
9
- <link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
10
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
11
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
10
+ <link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
11
+ <link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
12
+ <link rel="preload" href="/css/screen.css" as="style">
12
13
  <link rel="stylesheet" href="/css/screen.css">
13
14
  <link rel="icon" type="image/x-icon" href="/favicon.ico">
14
15
  <!-- Begin Jekyll SEO tag v2.6.1 -->
15
- <title>Writing posts | Jekyll • Simple, blog-aware, static sites</title>
16
- <meta name="generator" content="Jekyll v3.9.0" />
17
- <meta property="og:title" content="Writing posts" />
16
+ <title>Posts | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Posts" />
18
19
  <meta property="og:locale" content="en_US" />
19
- <meta name="description" content="One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, exactly? Well, simply put, it means that blogging is baked into Jekyll’s functionality. If you write articles and publish them online, you can publish and maintain a blog simply by managing a folder of text-files on your computer. Compared to the hassle of configuring and maintaining databases and web-based CMS systems, this will be a welcome change!" />
20
- <meta property="og:description" content="One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, exactly? Well, simply put, it means that blogging is baked into Jekyll’s functionality. If you write articles and publish them online, you can publish and maintain a blog simply by managing a folder of text-files on your computer. Compared to the hassle of configuring and maintaining databases and web-based CMS systems, this will be a welcome change!" />
20
+ <meta name="description" content="Blogging is baked into Jekyll. You write blog posts as text files and Jekyll provides everything you need to turn it into a blog." />
21
+ <meta property="og:description" content="Blogging is baked into Jekyll. You write blog posts as text files and Jekyll provides everything you need to turn it into a blog." />
21
22
  <link rel="canonical" href="https://jekyllrb.com/docs/posts/" />
22
23
  <meta property="og:url" content="https://jekyllrb.com/docs/posts/" />
23
24
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
25
+ <meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
24
26
  <meta property="og:type" content="article" />
25
- <meta property="article:published_time" content="2020-08-05T11:55:36-07:00" />
26
- <meta name="twitter:card" content="summary" />
27
- <meta property="twitter:title" content="Writing posts" />
27
+ <meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
28
+ <meta name="twitter:card" content="summary_large_image" />
29
+ <meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
30
+ <meta property="twitter:title" content="Posts" />
28
31
  <meta name="twitter:site" content="@jekyllrb" />
29
32
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
30
33
  <script type="application/ld+json">
31
- {"url":"https://jekyllrb.com/docs/posts/","headline":"Writing posts","dateModified":"2020-08-05T11:55:36-07:00","datePublished":"2020-08-05T11:55:36-07:00","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, exactly? Well, simply put, it means that blogging is baked into Jekyll’s functionality. If you write articles and publish them online, you can publish and maintain a blog simply by managing a folder of text-files on your computer. Compared to the hassle of configuring and maintaining databases and web-based CMS systems, this will be a welcome change!","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/posts/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
34
+ {"description":"Blogging is baked into Jekyll. You write blog posts as text files and Jekyll provides everything you need to turn it into a blog.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/posts/"},"headline":"Posts","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/posts/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
32
35
  <!-- End Jekyll SEO tag -->
33
36
 
34
37
  <!--[if lt IE 9]>
@@ -51,18 +54,27 @@
51
54
  </div>
52
55
  <nav class="main-nav hide-on-mobiles">
53
56
  <ul>
54
- <li class="">
57
+
58
+ <li>
55
59
  <a href="/">Home</a>
56
60
  </li>
61
+
57
62
  <li class="current">
58
- <a href="/docs/home/">Docs</a>
63
+ <a href="/docs/">Docs</a>
59
64
  </li>
60
- <li class="">
61
- <a href="/news/">News</a>
65
+
66
+ <li>
67
+ <a href="/resources/">Resources</a>
62
68
  </li>
63
- <li class="">
64
- <a href="/help/">Help</a>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
65
72
  </li>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
76
+ </li>
77
+
66
78
  </ul>
67
79
 
68
80
  </nav>
@@ -73,7 +85,7 @@
73
85
  <div class="meta hide-on-mobiles">
74
86
  <ul>
75
87
  <li>
76
- <a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
88
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
77
89
  </li>
78
90
  <li>
79
91
  <a href="https://github.com/jekyll/jekyll">GitHub</a>
@@ -83,18 +95,24 @@
83
95
  </div>
84
96
  <nav class="mobile-nav show-on-mobiles">
85
97
  <ul>
86
- <li class="">
87
- <a href="/">Home</a>
88
- </li>
89
- <li class="current">
90
- <a href="/docs/home/">Docs</a>
91
- </li>
92
- <li class="">
93
- <a href="/news/">News</a>
94
- </li>
95
- <li class="">
96
- <a href="/help/">Help</a>
97
- </li>
98
+
99
+ <li>
100
+ <a href="/">Home</a>
101
+ </li>
102
+
103
+ <li class="current">
104
+ <a href="/docs/">Docs</a>
105
+ </li>
106
+
107
+ <li>
108
+ <a href="/resources/">Resources</a>
109
+ </li>
110
+
111
+
112
+ <li>
113
+ <a href="/news/">News</a>
114
+ </li>
115
+
98
116
  <li>
99
117
  <a href="https://github.com/jekyll/jekyll">GitHub</a>
100
118
  </li>
@@ -113,176 +131,152 @@
113
131
 
114
132
  <optgroup label="Getting Started">
115
133
 
116
-
117
-
118
- <option value="/docs/home/">Welcome</option>
119
-
120
-
121
-
122
- <option value="/docs/quickstart/">Quick-start guide</option>
123
-
124
-
125
-
126
- <option value="/docs/installation/">Installation</option>
127
-
128
-
129
-
130
- <option value="/docs/windows/">Jekyll on Windows</option>
131
-
132
-
133
-
134
- <option value="/docs/usage/">Basic Usage</option>
135
-
136
-
137
-
138
- <option value="/docs/structure/">Directory structure</option>
139
-
140
-
141
-
142
- <option value="/docs/configuration/">Configuration</option>
143
-
144
-
145
- </optgroup>
146
-
147
- <optgroup label="Your Content">
134
+
135
+ <option value="/docs/">
136
+ Quickstart
137
+ </option>
138
+
139
+
140
+ <option value="/docs/ruby-101/">
141
+ Ruby 101
142
+ </option>
143
+
144
+
145
+ <option value="/docs/installation/">
146
+ Installation
147
+ </option>
148
+
149
+
150
+ <option value="/docs/community/">
151
+ Community
152
+ </option>
153
+
154
+
155
+ <option value="/docs/step-by-step/01-setup/">
156
+ Step by Step Tutorial
157
+ </option>
148
158
 
149
-
150
-
151
- <option value="/docs/frontmatter/">Front Matter</option>
152
-
153
-
154
-
155
- <option value="/docs/posts/">Writing posts</option>
156
-
157
-
158
-
159
- <option value="/docs/drafts/">Working with drafts</option>
160
-
161
-
162
-
163
- <option value="/docs/pages/">Creating pages</option>
164
-
165
-
166
-
167
- <option value="/docs/static-files/">Static Files</option>
168
-
169
-
170
-
171
- <option value="/docs/variables/">Variables</option>
172
-
173
-
174
-
175
- <option value="/docs/collections/">Collections</option>
176
-
177
-
178
-
179
- <option value="/docs/datafiles/">Data Files</option>
180
-
181
-
182
-
183
- <option value="/docs/assets/">Assets</option>
184
-
185
-
186
-
187
- <option value="/docs/migrations/">Blog migrations</option>
188
-
189
-
190
159
  </optgroup>
191
160
 
192
- <optgroup label="Customization">
161
+ <optgroup label="Build">
162
+
163
+
164
+ <option value="/docs/usage/">
165
+ Command Line Usage
166
+ </option>
167
+
168
+
169
+ <option value="/docs/configuration/">
170
+ Configuration
171
+ </option>
193
172
 
194
-
195
-
196
- <option value="/docs/templates/">Templates</option>
197
-
198
-
199
-
200
- <option value="/docs/includes/">Includes</option>
201
-
202
-
203
-
204
- <option value="/docs/permalinks/">Permalinks</option>
205
-
206
-
207
-
208
- <option value="/docs/pagination/">Pagination</option>
209
-
210
-
211
-
212
- <option value="/docs/plugins/">Plugins</option>
213
-
214
-
215
-
216
- <option value="/docs/themes/">Themes</option>
217
-
218
-
219
-
220
- <option value="/docs/extras/">Extras</option>
221
-
222
-
223
173
  </optgroup>
224
174
 
225
- <optgroup label="Deployment">
175
+ <optgroup label="Content">
176
+
177
+
178
+ <option value="/docs/pages/">
179
+ Pages
180
+ </option>
181
+
182
+
183
+ <option value="/docs/posts/">
184
+ Posts
185
+ </option>
186
+
187
+
188
+ <option value="/docs/front-matter/">
189
+ Front Matter
190
+ </option>
191
+
192
+
193
+ <option value="/docs/collections/">
194
+ Collections
195
+ </option>
196
+
197
+
198
+ <option value="/docs/datafiles/">
199
+ Data Files
200
+ </option>
201
+
202
+
203
+ <option value="/docs/assets/">
204
+ Assets
205
+ </option>
206
+
207
+
208
+ <option value="/docs/static-files/">
209
+ Static Files
210
+ </option>
226
211
 
227
-
228
-
229
- <option value="/docs/github-pages/">GitHub Pages</option>
230
-
231
-
232
-
233
- <option value="/docs/deployment-methods/">Deployment methods</option>
234
-
235
-
236
-
237
- <option value="/docs/continuous-integration/">Continuous Integration</option>
238
-
239
-
240
212
  </optgroup>
241
213
 
242
- <optgroup label="Miscellaneous">
214
+ <optgroup label="Site Structure">
215
+
216
+
217
+ <option value="/docs/structure/">
218
+ Directory Structure
219
+ </option>
220
+
221
+
222
+ <option value="/docs/liquid/">
223
+ Liquid
224
+ </option>
225
+
226
+
227
+ <option value="/docs/variables/">
228
+ Variables
229
+ </option>
230
+
231
+
232
+ <option value="/docs/includes/">
233
+ Includes
234
+ </option>
235
+
236
+
237
+ <option value="/docs/layouts/">
238
+ Layouts
239
+ </option>
240
+
241
+
242
+ <option value="/docs/permalinks/">
243
+ Permalinks
244
+ </option>
245
+
246
+
247
+ <option value="/docs/themes/">
248
+ Themes
249
+ </option>
250
+
251
+
252
+ <option value="/docs/pagination/">
253
+ Pagination
254
+ </option>
243
255
 
244
-
245
-
246
- <option value="/docs/troubleshooting/">Troubleshooting</option>
247
-
248
-
249
-
250
- <option value="/docs/sites/">Sites using Jekyll</option>
251
-
252
-
253
-
254
- <option value="/docs/resources/">Resources</option>
255
-
256
-
257
-
258
- <option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
259
-
260
-
261
-
262
- <option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
263
-
264
-
265
256
  </optgroup>
266
257
 
267
- <optgroup label="Meta">
258
+ <optgroup label="Guides">
259
+
260
+
261
+ <option value="/docs/plugins/">
262
+ Plugins
263
+ </option>
264
+
265
+
266
+ <option value="/docs/migrations/">
267
+ Blog Migrations
268
+ </option>
269
+
270
+
271
+ <option value="/docs/upgrading/">
272
+ Upgrading
273
+ </option>
274
+
275
+
276
+ <option value="/docs/deployment/">
277
+ Deployment
278
+ </option>
268
279
 
269
-
270
-
271
- <option value="/docs/contributing/">Contributing</option>
272
-
273
-
274
-
275
- <option value="/docs/maintaining/">Maintaining Jekyll</option>
276
-
277
-
278
-
279
- <option value="/docs/conduct/">Code of Conduct</option>
280
-
281
-
282
-
283
- <option value="/docs/history/">History</option>
284
-
285
-
286
280
  </optgroup>
287
281
 
288
282
  </select>
@@ -292,63 +286,59 @@
292
286
  <div class="unit four-fifths">
293
287
  <article>
294
288
  <div class="improve right hide-on-mobiles">
295
- <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/posts.md"><i class="fa fa-pencil"></i>  Improve this page</a>
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/posts.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
296
290
  </div>
297
- <h1>Writing posts</h1>
298
- <p>One of Jekyll’s best aspects is that it is “blog aware”. What does this mean,
299
- exactly? Well, simply put, it means that blogging is baked into Jekyll’s
300
- functionality. If you write articles and publish them online, you can publish
301
- and maintain a blog simply by managing a folder of text-files on your computer.
302
- Compared to the hassle of configuring and maintaining databases and web-based
303
- CMS systems, this will be a welcome change!</p>
291
+ <h1>Posts</h1>
292
+ <p>Blogging is baked into Jekyll. You write blog posts as text files and Jekyll
293
+ provides everything you need to turn it into a blog.</p>
304
294
 
305
295
  <h2 id="the-posts-folder">The Posts Folder</h2>
306
296
 
307
- <p>As explained on the <a href="../structure/">directory structure</a> page, the <code class="language-plaintext highlighter-rouge">_posts</code>
308
- folder is where your blog posts will live. These files are generally
309
- <a href="https://daringfireball.net/projects/markdown/">Markdown</a> or HTML, but can
310
- be other formats with the proper converter installed.
311
- All posts must have <a href="../frontmatter/">YAML Front Matter</a>, and they will be
312
- converted from their source format into an HTML page that is part of your
313
- static site.</p>
297
+ <p>The <code class="highlighter-rouge">_posts</code> folder is where your blog posts live. You typically write posts
298
+ in <a href="https://daringfireball.net/projects/markdown/">Markdown</a>, HTML is
299
+ also supported.</p>
314
300
 
315
- <h3 id="creating-post-files">Creating Post Files</h3>
301
+ <h2 id="creating-posts">Creating Posts</h2>
316
302
 
317
- <p>To create a new post, all you need to do is create a file in the <code class="language-plaintext highlighter-rouge">_posts</code>
318
- directory. How you name files in this folder is important. Jekyll requires blog
319
- post files to be named according to the following format:</p>
303
+ <p>To create a post, add a file to your <code class="highlighter-rouge">_posts</code> directory with the following
304
+ format:</p>
320
305
 
321
- <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>YEAR-MONTH-DAY-title.MARKUP
306
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>YEAR-MONTH-DAY-title.MARKUP
322
307
  </code></pre></div></div>
323
308
 
324
- <p>Where <code class="language-plaintext highlighter-rouge">YEAR</code> is a four-digit number, <code class="language-plaintext highlighter-rouge">MONTH</code> and <code class="language-plaintext highlighter-rouge">DAY</code> are both two-digit
325
- numbers, and <code class="language-plaintext highlighter-rouge">MARKUP</code> is the file extension representing the format used in the
309
+ <p>Where <code class="highlighter-rouge">YEAR</code> is a four-digit number, <code class="highlighter-rouge">MONTH</code> and <code class="highlighter-rouge">DAY</code> are both two-digit
310
+ numbers, and <code class="highlighter-rouge">MARKUP</code> is the file extension representing the format used in the
326
311
  file. For example, the following are examples of valid post filenames:</p>
327
312
 
328
- <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>2011-12-31-new-years-eve-is-awesome.md
313
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>2011-12-31-new-years-eve-is-awesome.md
329
314
  2012-09-12-how-to-write-a-blog.md
330
315
  </code></pre></div></div>
331
316
 
317
+ <p>All blog post files must begin with <a href="/docs/front-matter/">front matter</a> which is
318
+ typically used to set a <a href="/docs/layouts/">layout</a> or other meta data. For a simple
319
+ example this can just be empty:</p>
320
+
321
+ <div class="language-markdown highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
322
+ <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
323
+ <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Welcome</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">Jekyll!"</span>
324
+ <span class="nn">---</span>
325
+
326
+ <span class="gh"># Welcome</span>
327
+
328
+ <span class="gs">**Hello world**</span>, this is my first Jekyll blog post.
329
+
330
+ I hope you like it!
331
+ </code></pre></div></div>
332
+
332
333
  <div class="note">
333
334
  <h5>ProTip™: Link to other posts</h5>
334
335
  <p>
335
- Use the <a href="../templates/#linking-to-posts"><code>post_url</code></a>
336
+ Use the <a href="/docs/liquid/tags/#linking-to-posts"><code>post_url</code></a>
336
337
  tag to link to other posts without having to worry about the URLs
337
338
  breaking when the site permalink style changes.
338
339
  </p>
339
340
  </div>
340
341
 
341
- <h3 id="content-formats">Content Formats</h3>
342
-
343
- <p>All blog post files must begin with <a href="../frontmatter/">YAML Front Matter</a>. After
344
- that, it’s simply a matter of deciding which format you prefer. Jekyll supports
345
- <a href="https://daringfireball.net/projects/markdown/">Markdown</a> out of the box,
346
- and has <a href="/docs/plugins/#converters-1">myriad extensions for other formats as well</a>,
347
- including the popular <a href="http://redcloth.org/textile">Textile</a> format. These
348
- formats each have their own way of marking up different types of content
349
- within a post, so you should familiarize yourself with these formats and
350
- decide which one best suits your needs.</p>
351
-
352
342
  <div class="note info">
353
343
  <h5>Be aware of character sets</h5>
354
344
  <p>
@@ -356,67 +346,37 @@ decide which one best suits your needs.</p>
356
346
  For example, the <code>smart</code> extension in Redcarpet converts standard,
357
347
  ASCII quotation characters to curly, Unicode ones. In order for the browser
358
348
  to display those characters properly, define the charset meta value by
359
- including <code>&lt;meta charset="utf-8"&gt;</code> in the
349
+ including <code>&lt;meta charset=&quot;utf-8&quot;&gt;</code> in the
360
350
  <code>&lt;head&gt;</code> of your layout.
361
351
  </p>
362
352
  </div>
363
353
 
364
354
  <h2 id="including-images-and-resources">Including images and resources</h2>
365
355
 
366
- <p>Chances are, at some point, you’ll want to include images, downloads, or other
367
- digital assets along with your text content. While the syntax for linking to
368
- these resources differs between Markdown and Textile, the problem of working
369
- out where to store these files in your site is something everyone will face.</p>
370
-
371
- <p>There are a number of ways to include digital assets in Jekyll.
372
- One common solution is to create a folder in the root of the project directory
373
- called something like <code class="language-plaintext highlighter-rouge">assets</code>, into which any images, files
374
- or other resources are placed. Then, from within any post, they can be linked
375
- to using the site’s root as the path for the asset to include. Again, this will
376
- depend on the way your site’s (sub)domain and path are configured, but here are
377
- some examples in Markdown of how you could do this using the <code class="language-plaintext highlighter-rouge">absolute_url</code>
378
- filter in a post.</p>
356
+ <p>At some point, you’ll want to include images, downloads, or other
357
+ digital assets along with your text content. One common solution is to create
358
+ a folder in the root of the project directory called something like <code class="highlighter-rouge">assets</code>,
359
+ into which any images, files or other resources are placed. Then, from within
360
+ any post, they can be linked to using the site’s root as the path for the asset
361
+ to include. The best way to do this depends on the way your site’s (sub)domain
362
+ and path are configured, but here are some simple examples in Markdown:</p>
379
363
 
380
364
  <p>Including an image asset in a post:</p>
381
365
 
382
366
  <div class="language-markdown highlighter-rouge"><div class="highlight"><pre class="highlight"><code>... which is shown in the screenshot below:
383
- <span class="p">![</span><span class="nv">My helpful screenshot</span><span class="p">](</span><span class="sx">{{</span> <span class="nn">"/assets/screenshot.jpg"</span> | absolute_url }})
367
+ <span class="p">![</span><span class="nv">My helpful screenshot</span><span class="p">](</span><span class="sx">/assets/screenshot.jpg</span><span class="p">)</span>
384
368
  </code></pre></div></div>
385
369
 
386
370
  <p>Linking to a PDF for readers to download:</p>
387
371
 
388
- <div class="language-markdown highlighter-rouge"><div class="highlight"><pre class="highlight"><code>... you can <span class="p">[</span><span class="nv">get the PDF</span><span class="p">](</span><span class="sx">{{</span> <span class="nn">"/assets/mydoc.pdf"</span> | absolute_url }}) directly.
389
- </code></pre></div></div>
390
-
391
- <div class="info">
392
-
393
- </div>
394
-
395
- <h2 id="a-typical-post">A typical post</h2>
396
-
397
- <p>Jekyll can handle many different iterations of the idea you might associate with a “post,” however a standard blog style post, including a Title, Layout, Publishing Date, and Categories might look like this:</p>
398
-
399
- <div class="language-markdown highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
400
- <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
401
- <span class="na">title</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Welcome</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">Jekyll!"</span>
402
- <span class="na">date</span><span class="pi">:</span> <span class="s">2015-11-17 16:16:01 -0600</span>
403
- <span class="na">categories</span><span class="pi">:</span> <span class="s">jekyll update</span>
404
- <span class="nn">---</span>
405
-
406
- You’ll find this post in your <span class="sb">`_posts`</span> directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run <span class="sb">`bundle exec jekyll serve`</span>, which launches a web server and auto-regenerates your site when a file is updated.
407
-
408
- To add new posts, simply add a file in the <span class="sb">`_posts`</span> directory that follows the convention <span class="sb">`YYYY-MM-DD-name-of-post.ext`</span> and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
372
+ <div class="language-markdown highlighter-rouge"><div class="highlight"><pre class="highlight"><code>... you can <span class="p">[</span><span class="nv">get the PDF</span><span class="p">](</span><span class="sx">/assets/mydoc.pdf</span><span class="p">)</span> directly.
409
373
  </code></pre></div></div>
410
374
 
411
- <p>Everything in between the first and second <code class="language-plaintext highlighter-rouge">---</code> are part of the YAML Front Matter, and everything after the second <code class="language-plaintext highlighter-rouge">---</code> will be rendered with Markdown and show up as “Content”.</p>
412
-
413
375
  <h2 id="displaying-an-index-of-posts">Displaying an index of posts</h2>
414
376
 
415
- <p>It’s all well and good to have posts in a folder, but a blog is no use unless
416
- you have a list of posts somewhere. Creating an index of posts on another page
417
- (or in a <a href="../templates/">template</a>) is easy, thanks to the <a href="https://docs.shopify.com/themes/liquid/basics">Liquid template
418
- language</a> and its tags. Here’s a
419
- basic example of how to create a list of links to your blog posts:</p>
377
+ <p>Creating an index of posts on another page should be easy thanks to
378
+ <a href="https://docs.shopify.com/themes/liquid/basics">Liquid</a> and its tags. Here’s a
379
+ simple example of how to create a list of links to your blog posts:</p>
420
380
 
421
381
  <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;ul&gt;</span>
422
382
  {% for post in site.posts %}
@@ -427,92 +387,70 @@ basic example of how to create a list of links to your blog posts:</p>
427
387
  <span class="nt">&lt;/ul&gt;</span>
428
388
  </code></pre></div></div>
429
389
 
430
- <p>Of course, you have full control over how (and where) you display your posts,
431
- and how you structure your site. You should read more about <a href="../templates/">how templates
390
+ <p>You have full control over how (and where) you display your posts,
391
+ and how you structure your site. You should read more about <a href="/docs/templates/">how templates
432
392
  work</a> with Jekyll if you want to know more.</p>
433
393
 
434
- <p>Note that the <code class="language-plaintext highlighter-rouge">post</code> variable only exists inside the <code class="language-plaintext highlighter-rouge">for</code> loop above. If
394
+ <p>Note that the <code class="highlighter-rouge">post</code> variable only exists inside the <code class="highlighter-rouge">for</code> loop above. If
435
395
  you wish to access the currently-rendering page/posts’s variables (the
436
- variables of the post/page that has the <code class="language-plaintext highlighter-rouge">for</code> loop in it), use the <code class="language-plaintext highlighter-rouge">page</code>
396
+ variables of the post/page that has the <code class="highlighter-rouge">for</code> loop in it), use the <code class="highlighter-rouge">page</code>
437
397
  variable instead.</p>
438
398
 
439
- <h2 id="displaying-post-categories-or-tags">Displaying post categories or tags</h2>
399
+ <h2 id="categories-and-tags">Categories and Tags</h2>
440
400
 
441
- <p>Hey, that’s pretty neat, but what about showing just some of your posts that are
442
- related to each other? For that you can use any of the <a href="https://jekyllrb.com/docs/frontmatter/">variables definable in
443
- Front Matter</a>. In the “typical post”
444
- section you can see how to define categories. Simply add the categories to your
445
- Front Matter as a <a href="https://en.wikipedia.org/wiki/YAML#Basic_components">yaml
446
- list</a>.</p>
401
+ <p>Jekyll has first class support for categories and tags in blog posts. The difference
402
+ between categories and tags is a category can be part of the URL for a post
403
+ whereas a tag cannot.</p>
447
404
 
448
- <p>Now that your posts have a category or multiple categories, you can make a page
449
- or a template displaying just the posts in those categories you specify. Here’s
450
- a basic example of how to create a list of posts from a specific category.</p>
405
+ <p>To use these, first set your categories and tags in front matter:</p>
451
406
 
452
- <p>First, in the <code class="language-plaintext highlighter-rouge">_layouts</code> directory create a new file called <code class="language-plaintext highlighter-rouge">category.html</code> - in
453
- that file put (at least) the following:</p>
454
-
455
- <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>---
456
- layout: page
457
- ---
407
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
408
+ <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
409
+ <span class="na">title</span><span class="pi">:</span> <span class="s">A Trip</span>
410
+ <span class="na">categories</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">blog</span><span class="pi">,</span> <span class="nv">travel</span><span class="pi">]</span>
411
+ <span class="na">tags</span><span class="pi">:</span> <span class="pi">[</span><span class="nv">hot</span><span class="pi">,</span> <span class="nv">summer</span><span class="pi">]</span>
412
+ <span class="nn">---</span>
413
+ </code></pre></div></div>
458
414
 
459
- <span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span><span class="nv">post</span><span class="w"> </span><span class="nt">in</span><span class="w"> </span><span class="nv">site.categories[page.category]</span><span class="w"> </span><span class="p">%}</span>
460
- &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">url</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">absolute_url</span><span class="w"> </span><span class="p">}}</span>"&gt;
461
- <span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span>
462
- &lt;/a&gt;
415
+ <p>Jekyll makes the categories available to us at <code class="highlighter-rouge">site.categories</code>. Iterating over
416
+ <code class="highlighter-rouge">site.categories</code> on a page gives us another array with two items, the first
417
+ item is the name of the category and the second item is an array of posts in that
418
+ category.</p>
419
+
420
+ <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span><span class="nv">category</span><span class="w"> </span><span class="kr">in</span><span class="w"> </span><span class="nv">site.categories</span><span class="w"> </span><span class="p">%}</span>
421
+ &lt;h3&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">category</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="w"> </span><span class="p">}}</span>&lt;/h3&gt;
422
+ &lt;ul&gt;
423
+ <span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span><span class="nv">post</span><span class="w"> </span><span class="kr">in</span><span class="w"> </span><span class="nv">category[1]</span><span class="w"> </span><span class="p">%}</span>
424
+ &lt;li&gt;&lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">url</span><span class="w"> </span><span class="p">}}</span>"&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span>&lt;/a&gt;&lt;/li&gt;
425
+ <span class="p">{%</span><span class="w"> </span><span class="nt">endfor</span><span class="w"> </span><span class="p">%}</span>
426
+ &lt;/ul&gt;
463
427
  <span class="p">{%</span><span class="w"> </span><span class="nt">endfor</span><span class="w"> </span><span class="p">%}</span>
464
428
  </code></pre></div></div>
465
429
 
466
- <p>Next, in the root directory of your Jekyll install, create a new directory
467
- called <code class="language-plaintext highlighter-rouge">category</code> and then create a file for each category you want to list. For
468
- example, if you have a category <code class="language-plaintext highlighter-rouge">blog</code> then create a file in the new directory
469
- called <code class="language-plaintext highlighter-rouge">blog.html</code> with at least</p>
430
+ <p>For tags it’s exactly the same except the variable is <code class="highlighter-rouge">site.tags</code>.</p>
470
431
 
471
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
472
- <span class="na">layout</span><span class="pi">:</span> <span class="s">category</span>
473
- <span class="na">title</span><span class="pi">:</span> <span class="s">Blog</span>
474
- <span class="na">category</span><span class="pi">:</span> <span class="s">blog</span>
475
- <span class="nn">---</span>
476
- </code></pre></div></div>
432
+ <h2 id="post-excerpts">Post excerpts</h2>
477
433
 
478
- <p>In this case, the listing pages will be accessible at <code class="language-plaintext highlighter-rouge">{baseurl}/category/blog.html</code></p>
434
+ <p>You can access a snippet of a posts’s content by using <code class="highlighter-rouge">excerpt</code> variable on a
435
+ post. By default this is the first paragraph of content in the post, however it
436
+ can be customized by setting a <code class="highlighter-rouge">excerpt_separator</code> variable in front matter or
437
+ <code class="highlighter-rouge">_config.yml</code>.</p>
479
438
 
480
- <p>Although categories and tags are very similar, they are used to group posts,
481
- there are a few differences between them. Categories and sub-categories create
482
- hierarchies that, by default, are reflected in the directory structure of your
483
- site. A post with the following header</p>
484
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
485
- <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
486
- <span class="na">title</span><span class="pi">:</span> <span class="s">A Trip</span>
487
- <span class="na">category</span><span class="pi">:</span> <span class="pi">[</span> <span class="nv">blog</span><span class="pi">,</span> <span class="nv">travel</span> <span class="pi">]</span>
488
- <span class="nn">---</span>
489
- </code></pre></div></div>
490
- <p>will be accessible at <code class="language-plaintext highlighter-rouge">{baseurl}/blog/travel/year/month/day/A-Trip.html</code>. On
491
- the other hand, a tagged post</p>
492
439
  <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
493
- <span class="na">layout</span><span class="pi">:</span> <span class="s">post</span>
494
- <span class="na">title</span><span class="pi">:</span> <span class="s">A Trip</span>
495
- <span class="na">tags</span><span class="pi">:</span> <span class="pi">[</span> <span class="nv">blog</span><span class="pi">,</span> <span class="nv">travel</span> <span class="pi">]</span>
440
+ <span class="na">excerpt_separator</span><span class="pi">:</span> <span class="s">&lt;!--more--&gt;</span>
496
441
  <span class="nn">---</span>
497
- </code></pre></div></div>
498
- <p>will be saved as <code class="language-plaintext highlighter-rouge">{baseurl}/year/month/day/A-Trip.html</code>. It is up to you to
499
- create <code class="language-plaintext highlighter-rouge">{baseurl}/tag/blog.html</code> and <code class="language-plaintext highlighter-rouge">{baseurl}/tag/travel.html</code> the same way as
500
- described above for categories.</p>
501
442
 
502
- <p>While this example is done with tags and categories, you can easily extend your
503
- lists to filter by any other variable created with extensions.</p>
443
+ <span class="s">Excerpt with multiple paragraphs</span>
504
444
 
505
- <h2 id="post-excerpts">Post excerpts</h2>
445
+ <span class="s">Here's another paragraph in the excerpt.</span>
446
+ <span class="s">&lt;!--more--&gt;</span>
447
+ <span class="s">Out-of-excerpt</span>
448
+ </code></pre></div></div>
506
449
 
507
- <p>Each post automatically takes the first block of text, from the beginning of
508
- the content to the first occurrence of <code class="language-plaintext highlighter-rouge">excerpt_separator</code>, and sets it in the
509
- post’s data hash.
510
- Take the above example of an index of posts. Perhaps you want to include
511
- a little hint about the post’s content by adding the first paragraph of each of
512
- your posts:</p>
450
+ <p>Here’s an example of outputting a list of blog posts with an excerpt:</p>
513
451
 
514
452
  <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>&lt;ul&gt;
515
- <span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span><span class="nv">post</span><span class="w"> </span><span class="nt">in</span><span class="w"> </span><span class="nv">site.posts</span><span class="w"> </span><span class="p">%}</span>
453
+ <span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span><span class="nv">post</span><span class="w"> </span><span class="kr">in</span><span class="w"> </span><span class="nv">site.posts</span><span class="w"> </span><span class="p">%}</span>
516
454
  &lt;li&gt;
517
455
  &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">url</span><span class="w"> </span><span class="p">}}</span>"&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span>&lt;/a&gt;
518
456
  <span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">excerpt</span><span class="w"> </span><span class="p">}}</span>
@@ -521,316 +459,233 @@ your posts:</p>
521
459
  &lt;/ul&gt;
522
460
  </code></pre></div></div>
523
461
 
524
- <p>Because Jekyll grabs the first paragraph you will not need to wrap the excerpt
525
- in <code class="language-plaintext highlighter-rouge">p</code> tags, which is already done for you. These tags can be removed with the
526
- following if you’d prefer:</p>
527
-
528
- <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">excerpt</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">remove</span><span class="p">:</span><span class="w"> </span><span class="s1">'&lt;p&gt;'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">remove</span><span class="p">:</span><span class="w"> </span><span class="s1">'&lt;/p&gt;'</span><span class="w"> </span><span class="p">}}</span>
529
- </code></pre></div></div>
530
-
531
- <p>If you don’t like the automatically-generated post excerpt, it can be
532
- explicitly overridden by adding an <code class="language-plaintext highlighter-rouge">excerpt</code> value to your post’s YAML
533
- Front Matter. Alternatively, you can choose to define a custom
534
- <code class="language-plaintext highlighter-rouge">excerpt_separator</code> in the post’s YAML front matter:</p>
535
-
536
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
537
- <span class="na">excerpt_separator</span><span class="pi">:</span> <span class="s">&lt;!--more--&gt;</span>
538
- <span class="nn">---</span>
539
-
540
- <span class="s">Excerpt</span>
541
- <span class="s">&lt;!--more--&gt;</span>
542
- <span class="s">Out-of-excerpt</span>
543
- </code></pre></div></div>
544
-
545
- <p>You can also set the <code class="language-plaintext highlighter-rouge">excerpt_separator</code> globally in your <code class="language-plaintext highlighter-rouge">_config.yml</code>
546
- configuration file.</p>
547
-
548
- <p>Completely disable excerpts by setting your <code class="language-plaintext highlighter-rouge">excerpt_separator</code> to <code class="language-plaintext highlighter-rouge">""</code>.</p>
549
-
550
- <p>Also, as with any output generated by Liquid tags, you can pass the
551
- <code class="language-plaintext highlighter-rouge">| strip_html</code> filter to remove any html tags in the output. This is
552
- particularly helpful if you wish to output a post excerpt as a
553
- <code class="language-plaintext highlighter-rouge">meta="description"</code> tag within the post <code class="language-plaintext highlighter-rouge">head</code>, or anywhere else having
554
- html tags along with the content is not desirable.</p>
555
-
556
- <h2 id="highlighting-code-snippets">Highlighting code snippets</h2>
557
-
558
- <p>Jekyll also has built-in support for syntax highlighting of code snippets using
559
- either Pygments or Rouge, and including a code snippet in any post is easy.
560
- Just use the dedicated Liquid tag as follows:</p>
561
-
562
- <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="nt">highlight</span><span class="w"> </span>ruby<span class="w"> </span><span class="p">%}</span>
563
- def show
564
- @widget = Widget(params[:id])
565
- respond_to do |format|
566
- format.html # show.html.erb
567
- format.json { render json: @widget }
568
- end
569
- end
570
- <span class="p">{%</span><span class="w"> </span><span class="nt">endhighlight</span><span class="w"> </span><span class="p">%}</span>
571
- </code></pre></div></div>
462
+ <h2 id="drafts">Drafts</h2>
572
463
 
573
- <p>And the output will look like this:</p>
464
+ <p>Drafts are posts without a date in the filename. They’re posts you’re still
465
+ working on and don’t want to publish yet. To get up and running with drafts,
466
+ create a <code class="highlighter-rouge">_drafts</code> folder in your site’s root and create your first draft:</p>
574
467
 
575
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">show</span>
576
- <span class="vi">@widget</span> <span class="o">=</span> <span class="no">Widget</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="ss">:id</span><span class="p">])</span>
577
- <span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
578
- <span class="nb">format</span><span class="p">.</span><span class="nf">html</span> <span class="c1"># show.html.erb</span>
579
- <span class="nb">format</span><span class="p">.</span><span class="nf">json</span> <span class="p">{</span> <span class="n">render</span> <span class="ss">json: </span><span class="vi">@widget</span> <span class="p">}</span>
580
- <span class="k">end</span>
581
- <span class="k">end</span>
468
+ <div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>|-- _drafts/
469
+ | |-- a-draft-post.md
582
470
  </code></pre></div></div>
583
471
 
584
- <div class="note">
585
- <h5>ProTip™: Show line numbers</h5>
586
- <p>
587
- You can make code snippets include line-numbers by adding the word
588
- <code>linenos</code> to the end of the opening highlight tag like this:
589
- <code>{% highlight ruby linenos %}</code>.
590
- </p>
591
- </div>
592
-
593
- <p>These basics should be enough to get you started writing your first posts. When
594
- you’re ready to dig into what else is possible, you might be interested in
595
- doing things like <a href="../permalinks/">customizing post permalinks</a> or
596
- using <a href="../variables/">custom variables</a> in your posts and elsewhere on your
597
- site.</p>
598
-
599
-
472
+ <p>To preview your site with drafts, run <code class="highlighter-rouge">jekyll serve</code> or <code class="highlighter-rouge">jekyll build</code>
473
+ with the <code class="highlighter-rouge">--drafts</code> switch. Each will be assigned the value modification time
474
+ of the draft file for its date, and thus you will see currently edited drafts
475
+ as the latest posts.</p>
600
476
 
601
-
602
-
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
- <div class="section-nav">
632
- <div class="left align-right">
633
-
634
-
635
-
636
- <a href="/docs/frontmatter/" class="prev">Back</a>
637
-
638
- </div>
639
- <div class="right align-left">
640
-
641
-
642
-
643
- <a href="/docs/drafts/" class="next">Next</a>
644
-
645
- </div>
646
- </div>
647
- <div class="clear"></div>
648
-
649
477
  </article>
650
478
  </div>
651
479
 
652
480
  <div class="unit one-fifth hide-on-mobiles">
653
481
  <aside>
654
482
 
655
- <h4>Getting Started</h4>
656
- <ul>
657
-
658
-
659
-
660
- <li class=""><a href="/docs/home/">Welcome</a></li>
661
-
662
-
663
-
664
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
665
-
666
-
667
-
668
- <li class=""><a href="/docs/installation/">Installation</a></li>
669
-
670
-
671
-
672
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
673
-
674
-
675
-
676
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
677
-
678
-
679
-
680
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
681
-
682
-
683
-
684
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
685
-
686
- </ul>
687
-
688
-
689
- <h4>Your Content</h4>
690
- <ul>
691
-
692
-
693
-
694
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
695
-
696
-
697
-
698
- <li class="current"><a href="/docs/posts/">Writing posts</a></li>
699
-
700
-
701
-
702
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
703
-
704
-
705
-
706
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
707
-
708
-
709
-
710
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
711
-
712
-
713
-
714
- <li class=""><a href="/docs/variables/">Variables</a></li>
715
-
716
-
717
-
718
- <li class=""><a href="/docs/collections/">Collections</a></li>
719
-
720
-
721
-
722
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
723
-
724
-
725
-
726
- <li class=""><a href="/docs/assets/">Assets</a></li>
727
-
728
-
729
-
730
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
731
-
732
- </ul>
733
-
483
+ <h4>Getting Started</h4>
484
+ <ul>
485
+
486
+
487
+ <li>
488
+ <a href="/docs/">
489
+ Quickstart
490
+ </a>
491
+ </li>
492
+
493
+
494
+ <li>
495
+ <a href="/docs/ruby-101/">
496
+ Ruby 101
497
+ </a>
498
+ </li>
499
+
500
+
501
+ <li>
502
+ <a href="/docs/installation/">
503
+ Installation
504
+ </a>
505
+ </li>
506
+
507
+
508
+ <li>
509
+ <a href="/docs/community/">
510
+ Community
511
+ </a>
512
+ </li>
513
+
514
+
515
+ <li>
516
+ <a href="/docs/step-by-step/01-setup/">
517
+ Step by Step Tutorial
518
+ </a>
519
+ </li>
520
+
521
+ </ul>
734
522
 
735
- <h4>Customization</h4>
736
- <ul>
737
-
738
-
739
-
740
- <li class=""><a href="/docs/templates/">Templates</a></li>
741
-
742
-
743
-
744
- <li class=""><a href="/docs/includes/">Includes</a></li>
745
-
746
-
747
-
748
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
749
-
750
-
751
-
752
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
753
-
754
-
755
-
756
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
757
-
758
-
759
-
760
- <li class=""><a href="/docs/themes/">Themes</a></li>
761
-
762
-
763
-
764
- <li class=""><a href="/docs/extras/">Extras</a></li>
765
-
766
- </ul>
767
-
523
+ <h4>Build</h4>
524
+ <ul>
525
+
526
+
527
+ <li>
528
+ <a href="/docs/usage/">
529
+ Command Line Usage
530
+ </a>
531
+ </li>
532
+
533
+
534
+ <li>
535
+ <a href="/docs/configuration/">
536
+ Configuration
537
+ </a>
538
+ </li>
539
+
540
+ </ul>
768
541
 
769
- <h4>Deployment</h4>
770
- <ul>
771
-
772
-
773
-
774
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
775
-
776
-
777
-
778
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
779
-
780
-
781
-
782
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
783
-
784
- </ul>
785
-
542
+ <h4>Content</h4>
543
+ <ul>
544
+
545
+
546
+ <li>
547
+ <a href="/docs/pages/">
548
+ Pages
549
+ </a>
550
+ </li>
551
+
552
+
553
+ <li class="current">
554
+ <a href="/docs/posts/">
555
+ Posts
556
+ </a>
557
+ </li>
558
+
559
+
560
+ <li>
561
+ <a href="/docs/front-matter/">
562
+ Front Matter
563
+ </a>
564
+ </li>
565
+
566
+
567
+ <li>
568
+ <a href="/docs/collections/">
569
+ Collections
570
+ </a>
571
+ </li>
572
+
573
+
574
+ <li>
575
+ <a href="/docs/datafiles/">
576
+ Data Files
577
+ </a>
578
+ </li>
579
+
580
+
581
+ <li>
582
+ <a href="/docs/assets/">
583
+ Assets
584
+ </a>
585
+ </li>
586
+
587
+
588
+ <li>
589
+ <a href="/docs/static-files/">
590
+ Static Files
591
+ </a>
592
+ </li>
593
+
594
+ </ul>
786
595
 
787
- <h4>Miscellaneous</h4>
788
- <ul>
789
-
790
-
791
-
792
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
793
-
794
-
795
-
796
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
797
-
798
-
799
-
800
- <li class=""><a href="/docs/resources/">Resources</a></li>
801
-
802
-
803
-
804
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
805
-
806
-
807
-
808
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
809
-
810
- </ul>
811
-
596
+ <h4>Site Structure</h4>
597
+ <ul>
598
+
599
+
600
+ <li>
601
+ <a href="/docs/structure/">
602
+ Directory Structure
603
+ </a>
604
+ </li>
605
+
606
+
607
+ <li>
608
+ <a href="/docs/liquid/">
609
+ Liquid
610
+ </a>
611
+ </li>
612
+
613
+
614
+ <li>
615
+ <a href="/docs/variables/">
616
+ Variables
617
+ </a>
618
+ </li>
619
+
620
+
621
+ <li>
622
+ <a href="/docs/includes/">
623
+ Includes
624
+ </a>
625
+ </li>
626
+
627
+
628
+ <li>
629
+ <a href="/docs/layouts/">
630
+ Layouts
631
+ </a>
632
+ </li>
633
+
634
+
635
+ <li>
636
+ <a href="/docs/permalinks/">
637
+ Permalinks
638
+ </a>
639
+ </li>
640
+
641
+
642
+ <li>
643
+ <a href="/docs/themes/">
644
+ Themes
645
+ </a>
646
+ </li>
647
+
648
+
649
+ <li>
650
+ <a href="/docs/pagination/">
651
+ Pagination
652
+ </a>
653
+ </li>
654
+
655
+ </ul>
812
656
 
813
- <h4>Meta</h4>
814
- <ul>
815
-
816
-
817
-
818
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
819
-
820
-
821
-
822
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
823
-
824
-
825
-
826
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
827
-
828
-
829
-
830
- <li class=""><a href="/docs/history/">History</a></li>
831
-
832
- </ul>
833
-
657
+ <h4>Guides</h4>
658
+ <ul>
659
+
660
+
661
+ <li>
662
+ <a href="/docs/plugins/">
663
+ Plugins
664
+ </a>
665
+ </li>
666
+
667
+
668
+ <li>
669
+ <a href="/docs/migrations/">
670
+ Blog Migrations
671
+ </a>
672
+ </li>
673
+
674
+
675
+ <li>
676
+ <a href="/docs/upgrading/">
677
+ Upgrading
678
+ </a>
679
+ </li>
680
+
681
+
682
+ <li>
683
+ <a href="/docs/deployment/">
684
+ Deployment
685
+ </a>
686
+ </li>
687
+
688
+ </ul>
834
689
 
835
690
  </aside>
836
691
  </div>
@@ -845,7 +700,8 @@ site.</p>
845
700
  <footer>
846
701
  <div class="grid">
847
702
  <div class="unit one-third center-on-mobiles">
848
- <p>The contents of this website are <br>© 2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
703
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
704
+ <p>The contents of this website are <br />&copy;&nbsp;2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
849
705
  </div>
850
706
  <div class="unit two-thirds align-right center-on-mobiles">
851
707
  <p>
@@ -855,6 +711,14 @@ site.</p>
855
711
  </a>
856
712
  </p>
857
713
  </div>
714
+ <div class="unit two-thirds align-right center-on-mobiles">
715
+ <p>
716
+ Jekyll is funded thanks to its
717
+ <a href="https://github.com/jekyll/jekyll#sponsors">
718
+ sponsors!
719
+ </a>
720
+ </p>
721
+ </div>
858
722
  </div>
859
723
  </footer>
860
724