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
16
  <title>Permalinks | Jekyll • Simple, blog-aware, static sites</title>
16
- <meta name="generator" content="Jekyll v3.9.0" />
17
+ <meta name="generator" content="Jekyll v4.0.0" />
17
18
  <meta property="og:title" content="Permalinks" />
18
19
  <meta property="og:locale" content="en_US" />
19
- <meta name="description" content="Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern." />
20
- <meta property="og:description" content="Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern." />
20
+ <meta name="description" content="Permalinks are the output path for your pages, posts, or collections. They allow you to structure the directories of your source code different from the directories in your output." />
21
+ <meta property="og:description" content="Permalinks are the output path for your pages, posts, or collections. They allow you to structure the directories of your source code different from the directories in your output." />
21
22
  <link rel="canonical" href="https://jekyllrb.com/docs/permalinks/" />
22
23
  <meta property="og:url" content="https://jekyllrb.com/docs/permalinks/" />
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="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" />
27
30
  <meta property="twitter:title" content="Permalinks" />
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/permalinks/","headline":"Permalinks","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":"Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections. Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as date) that automatically use a template-variable pattern.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/permalinks/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
34
+ {"description":"Permalinks are the output path for your pages, posts, or collections. They allow you to structure the directories of your source code different from the directories in your output.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/permalinks/"},"headline":"Permalinks","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/permalinks/","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>
68
+ </li>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
62
72
  </li>
63
- <li class="">
64
- <a href="/help/">Help</a>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
65
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,53 +286,48 @@
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/permalinks.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/permalinks.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
296
290
  </div>
297
291
  <h1>Permalinks</h1>
298
- <p>Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
299
- Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as <code class="language-plaintext highlighter-rouge">date</code>) that automatically use a template-variable pattern.</p>
300
-
301
- <p>You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is <code class="language-plaintext highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code>. Each of the colon-prefixed keywords is a template variable.</p>
292
+ <p>Permalinks are the output path for your pages, posts, or collections. They
293
+ allow you to structure the directories of your source code different from the
294
+ directories in your output.</p>
302
295
 
303
- <h2 id="where-to-configure-permalinks">Where to configure permalinks</h2>
296
+ <h2 id="front-matter">Front Matter</h2>
304
297
 
305
- <p>You can configure your site’s permalinks through the <a href="/docs/configuration/">Configuration</a> file or in the <a href="/docs/frontmatter/">Front Matter</a> for each post, page, or collection.</p>
298
+ <p>The simplest way to set a permalink is using front matter. You set the
299
+ <code class="highlighter-rouge">permalink</code> variable in front matter to the output path you’d like.</p>
306
300
 
307
- <p>Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your <code class="language-plaintext highlighter-rouge">_config.yml</code> file like this:</p>
301
+ <p>For example, you might have a page on your site located at
302
+ <code class="highlighter-rouge">/my_pages/about-me.html</code> and you want the output url to be <code class="highlighter-rouge">/about/</code>. In
303
+ front matter of the page you would set:</p>
308
304
 
309
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">permalink</span><span class="pi">:</span> <span class="s">/:categories/:year/:month/:day/:title:output_ext</span>
305
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>---
306
+ permalink: /about/
307
+ ---
310
308
  </code></pre></div></div>
311
309
 
312
- <p>If you don’t specify any permalink setting, Jekyll uses the above pattern as the default.</p>
313
-
314
- <p>The permalink can also be set using a built-in permalink style:</p>
315
-
316
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">permalink</span><span class="pi">:</span> <span class="s">date</span>
317
- </code></pre></div></div>
310
+ <h2 id="global">Global</h2>
318
311
 
319
- <p><code class="language-plaintext highlighter-rouge">date</code> is the same as <code class="language-plaintext highlighter-rouge">:categories/:year/:month/:day/:title:output_ext</code>, the default. See <a href="#builtinpermalinkstyles">Built-in Permalink Styles</a> below for more options.</p>
312
+ <p>Setting a permalink in front matter for every page on your site is no fun.
313
+ Luckily, Jekyll lets you set the permalink structure globally in your <code class="highlighter-rouge">_config.yml</code>.</p>
320
314
 
321
- <p>Setting the permalink in your post, page, or collection’s front matter overrides any global settings. Here’s an example:</p>
315
+ <p>To set a global permalink, you use the <code class="highlighter-rouge">permalink</code> variable in <code class="highlighter-rouge">_config.yml</code>.
316
+ You can use placeholders to your desired output. For example:</p>
322
317
 
323
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
324
- <span class="na">title</span><span class="pi">:</span> <span class="s">My page title</span>
325
- <span class="na">permalink</span><span class="pi">:</span> <span class="s">/mypageurl/</span>
326
- <span class="nn">---</span>
318
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">permalink</span><span class="pi">:</span> <span class="s">/:categories/:year/:month/:day/:title:output_ext</span>
327
319
  </code></pre></div></div>
328
320
 
329
- <p>Even if your configuration file specifies the <code class="language-plaintext highlighter-rouge">date</code> style, the URL for this page would be <code class="language-plaintext highlighter-rouge">http://somedomain.com/mypageurl/</code>.</p>
330
-
331
- <p>When you use permalinks that omit the <code class="language-plaintext highlighter-rouge">.html</code> file extension (called “pretty URLs”) Jekyll builds the file as index.html placed inside a folder with the page’s name. For example:</p>
332
-
333
- <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>├── mypageurl
334
- │   └── index.html
335
- </code></pre></div></div>
321
+ <p>Note that pages and collections don’t have time or categories, these aspects of
322
+ the permalink style are ignored for the output.</p>
336
323
 
337
- <p>With a URL such as <code class="language-plaintext highlighter-rouge">/mypageurl/</code>, servers automatically load the index.html file inside the folder, so users can simply navigate to <code class="language-plaintext highlighter-rouge">http://somedomain.com/mypageurl/</code> to get to <code class="language-plaintext highlighter-rouge">mypageurl/index.html</code>.</p>
324
+ <p>For example, a permalink style of
325
+ <code class="highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code> for posts becomes
326
+ <code class="highlighter-rouge">/:title.html</code> for pages and collections.</p>
338
327
 
339
- <h2 id="template-variables">Template variables for permalinks</h2>
328
+ <h3 id="placeholders">Placeholders</h3>
340
329
 
341
- <p>The following table lists the template variables available for permalinks. You can use these variables in the <code class="language-plaintext highlighter-rouge">permalink</code> property in your config file.</p>
330
+ <p>Here’s the full list of placeholders available:</p>
342
331
 
343
332
  <div class="mobile-side-scroller">
344
333
  <table>
@@ -355,8 +344,19 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
355
344
  </td>
356
345
  <td>
357
346
  <p>
358
- Year from the post's filename. May be overridden via the document’s
359
- <code>date</code> YAML front matter
347
+ Year from the posts filename with four digits.
348
+ May be overridden via the document’s <code>date</code> front matter.
349
+ </p>
350
+ </td>
351
+ </tr>
352
+ <tr>
353
+ <td>
354
+ <p><code>short_year</code></p>
355
+ </td>
356
+ <td>
357
+ <p>
358
+ Year from the post’s filename without the century. (00..99)
359
+ May be overridden via the document’s <code>date</code> front matter.
360
360
  </p>
361
361
  </td>
362
362
  </tr>
@@ -366,8 +366,8 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
366
366
  </td>
367
367
  <td>
368
368
  <p>
369
- Month from the post's filename. May be overridden via the document’s
370
- <code>date</code> YAML front matter
369
+ Month from the posts filename. (01..12)
370
+ May be overridden via the document’s <code>date</code> front matter.
371
371
  </p>
372
372
  </td>
373
373
  </tr>
@@ -377,19 +377,37 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
377
377
  </td>
378
378
  <td>
379
379
  <p>
380
- Month without leading zeros from the post's filename. May be
381
- overridden via the document’s <code>date</code> YAML front matter
380
+ Month without leading zeros from the posts filename. May be
381
+ overridden via the document’s <code>date</code> front matter.
382
382
  </p>
383
383
  </td>
384
384
  </tr>
385
+ <tr>
386
+ <td>
387
+ <p><code>short_month</code></p>
388
+ </td>
389
+ <td>
390
+ <p>Three-letter month abbreviation, e.g. “Jan”.</p>
391
+ </td>
392
+ </tr>
393
+ <tr>
394
+ <td>
395
+ <p><code>long_month</code></p>
396
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
397
+ </small>
398
+ </td>
399
+ <td>
400
+ <p>Full month name, e.g. “January”.</p>
401
+ </td>
402
+ </tr>
385
403
  <tr>
386
404
  <td>
387
405
  <p><code>day</code></p>
388
406
  </td>
389
407
  <td>
390
408
  <p>
391
- Day from the post's filename. May be overridden via the document’s
392
- <code>date</code> YAML front matter
409
+ Day of the month from the posts filename. (01..31)
410
+ May be overridden via the document’s <code>date</code> front matter.
393
411
  </p>
394
412
  </td>
395
413
  </tr>
@@ -399,28 +417,67 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
399
417
  </td>
400
418
  <td>
401
419
  <p>
402
- Day without leading zeros from the post's filename. May be overridden
403
- via the document’s <code>date</code> YAML front matter
420
+ Day of the month without leading zeros from the posts filename.
421
+ May be overridden via the document’s <code>date</code> front matter.
404
422
  </p>
405
423
  </td>
406
424
  </tr>
407
425
  <tr>
408
426
  <td>
409
427
  <p><code>y_day</code></p>
410
- </td>_
428
+ </td>
411
429
  <td>
412
- <p>Day of the year from the post's filename, with leading zeros.</p>
430
+ <p>Ordinal day of the year from the posts filename, with leading zeros. (001..366)</p>
413
431
  </td>
414
432
  </tr>
415
433
  <tr>
416
434
  <td>
417
- <p><code>short_year</code></p>
435
+ <p><code>w_year</code></p>
436
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
437
+ </small>
418
438
  </td>
419
439
  <td>
420
- <p>
421
- Year without the century from the post's filename. May be overridden
422
- via the document’s <code>date</code> YAML front matter
423
- </p>
440
+ <p>Week year which may differ from the month year for up to three days at the start of January and end of December</p>
441
+ </td>
442
+ </tr>
443
+ <tr>
444
+ <td>
445
+ <p><code>week</code></p>
446
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
447
+ </small>
448
+ </td>
449
+ <td>
450
+ <p>Week number of the current year, starting with the first week having a majority of its days in January. (01..53)</p>
451
+ </td>
452
+ </tr>
453
+ <tr>
454
+ <td>
455
+ <p><code>w_day</code></p>
456
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
457
+ </small>
458
+ </td>
459
+ <td>
460
+ <p>Day of the week, starting with Monday. (1..7)</p>
461
+ </td>
462
+ </tr>
463
+ <tr>
464
+ <td>
465
+ <p><code>short_day</code></p>
466
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
467
+ </small>
468
+ </td>
469
+ <td>
470
+ <p>Three-letter weekday abbreviation, e.g. “Sun”.</p>
471
+ </td>
472
+ </tr>
473
+ <tr>
474
+ <td>
475
+ <p><code>long_day</code></p>
476
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
477
+ </small>
478
+ </td>
479
+ <td>
480
+ <p>Weekday name, e.g. “Sunday”.</p>
424
481
  </td>
425
482
  </tr>
426
483
  <tr>
@@ -429,7 +486,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
429
486
  </td>
430
487
  <td>
431
488
  <p>
432
- Hour of the day, 24-hour clock, zero-padded from the post's
489
+ Hour of the day, 24-hour clock, zero-padded from the posts
433
490
  <code>date</code> front matter. (00..23)
434
491
  </p>
435
492
  </td>
@@ -440,7 +497,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
440
497
  </td>
441
498
  <td>
442
499
  <p>
443
- Minute of the hour from the post's <code>date</code> front matter. (00..59)
500
+ Minute of the hour from the posts <code>date</code> front matter. (00..59)
444
501
  </p>
445
502
  </td>
446
503
  </tr>
@@ -450,7 +507,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
450
507
  </td>
451
508
  <td>
452
509
  <p>
453
- Second of the minute from the post's <code>date</code> front matter. (00..59)
510
+ Second of the minute from the posts <code>date</code> front matter. (00..59)
454
511
  </p>
455
512
  </td>
456
513
  </tr>
@@ -461,7 +518,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
461
518
  <td>
462
519
  <p>
463
520
  Title from the document’s filename. May be overridden via
464
- the document’s <code>slug</code> YAML front matter.
521
+ the document’s <code>slug</code> front matter.
465
522
  </p>
466
523
  </td>
467
524
  </tr>
@@ -473,7 +530,7 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
473
530
  <p>
474
531
  Slugified title from the document’s filename (any character
475
532
  except numbers and letters is replaced as hyphen). May be
476
- overridden via the document’s <code>slug</code> YAML front matter.
533
+ overridden via the document’s <code>slug</code> front matter.
477
534
  </p>
478
535
  </td>
479
536
  </tr>
@@ -494,11 +551,9 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
494
551
  </table>
495
552
  </div>
496
553
 
497
- <p>Note that all template variables relating to time or categories are available to posts only.</p>
498
-
499
- <h2 id="builtinpermalinkstyles">Built-in permalink styles</h2>
554
+ <h3 id="built-in-formats">Built-in formats</h3>
500
555
 
501
- <p>Although you can specify a custom permalink pattern using <a href="#template-variables">template variables</a>, Jekyll also provides the following built-in styles for convenience.</p>
556
+ <p>For posts, Jekyll also provides the following built-in styles for convenience:</p>
502
557
 
503
558
  <div class="mobile-side-scroller">
504
559
  <table>
@@ -533,6 +588,16 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
533
588
  <p><code>/:categories/:year/:y_day/:title:output_ext</code></p>
534
589
  </td>
535
590
  </tr>
591
+ <tr>
592
+ <td>
593
+ <p><code>weekdate</code></p>
594
+ <small><span class="version-badge" title="This feature is available starting version 4.0">4.0</span>
595
+ </small>
596
+ </td>
597
+ <td>
598
+ <p><code>/:categories/:year/W:week/:short_day/:title:output_ext</code></p>
599
+ </td>
600
+ </tr>
536
601
  <tr>
537
602
  <td>
538
603
  <p><code>none</code></p>
@@ -545,407 +610,298 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
545
610
  </table>
546
611
  </div>
547
612
 
548
- <p>Rather than typing <code class="language-plaintext highlighter-rouge">permalink: /:categories/:year/:month/:day/:title/</code>, you can just type <code class="language-plaintext highlighter-rouge">permalink: pretty</code>.</p>
613
+ <p>Rather than typing <code class="highlighter-rouge">permalink: /:categories/:year/:month/:day/:title/</code>, you can just type <code class="highlighter-rouge">permalink: pretty</code>.</p>
549
614
 
550
615
  <div class="note info">
551
- <h5>Specifying permalinks through the YAML Front Matter</h5>
552
- <p>Built-in permalink styles are not recognized in YAML Front Matter. As a result, <code>permalink: pretty</code> will not work.</p>
616
+ <h5>Specifying permalinks through the front matter</h5>
617
+ <p>Built-in permalink styles are not recognized in front matter. As a result, <code>permalink: pretty</code> will not work.</p>
553
618
  </div>
554
619
 
555
- <h2 id="permalink-style-examples">Permalink style examples with posts</h2>
620
+ <h3 id="collections">Collections</h3>
621
+
622
+ <p>For collections, you have the option to override the global permalink in the
623
+ collection configuration in <code class="highlighter-rouge">_config.yml</code>:</p>
556
624
 
557
- <p>Here are a few examples to clarify how permalink styles get applied with posts.</p>
625
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">collections</span><span class="pi">:</span>
626
+ <span class="na">my_collection</span><span class="pi">:</span>
627
+ <span class="na">output</span><span class="pi">:</span> <span class="no">true</span>
628
+ <span class="na">permalink</span><span class="pi">:</span> <span class="s">/:collection/:name</span>
629
+ </code></pre></div></div>
558
630
 
559
- <p>Given a post named: <code class="language-plaintext highlighter-rouge">/2009-04-29-slap-chop.md</code></p>
631
+ <p>Collections have the following placeholders available:</p>
560
632
 
561
633
  <div class="mobile-side-scroller">
562
634
  <table>
563
635
  <thead>
564
636
  <tr>
565
- <th>URL Template</th>
566
- <th>Resulting Permalink URL</th>
637
+ <th>Variable</th>
638
+ <th>Description</th>
567
639
  </tr>
568
640
  </thead>
569
641
  <tbody>
570
642
  <tr>
571
643
  <td>
572
- <p>None specified, or <code>permalink: date</code></p>
644
+ <p><code>:collection</code></p>
573
645
  </td>
574
646
  <td>
575
- <p><code>/2009/04/29/slap-chop.html</code></p>
647
+ <p>Label of the containing collection.</p>
576
648
  </td>
577
649
  </tr>
578
650
  <tr>
579
651
  <td>
580
- <p><code>pretty</code></p>
652
+ <p><code>:path</code></p>
581
653
  </td>
582
654
  <td>
583
- <p><code>/2009/04/29/slap-chop/</code></p>
655
+ <p>Path to the document relative to the collection's directory.</p>
584
656
  </td>
585
657
  </tr>
586
658
  <tr>
587
659
  <td>
588
- <p><code>/:month-:day-:year/:title:output_ext</code></p>
660
+ <p><code>:name</code></p>
589
661
  </td>
590
662
  <td>
591
- <p><code>/04-29-2009/slap-chop.html</code></p>
663
+ <p>The document's base filename, with every sequence of spaces
664
+ and non-alphanumeric characters replaced by a hyphen.</p>
592
665
  </td>
593
666
  </tr>
594
667
  <tr>
595
668
  <td>
596
- <p><code>/blog/:year/:month/:day/:title/</code></p>
669
+ <p><code>:title</code></p>
597
670
  </td>
598
671
  <td>
599
- <p><code>/blog/2009/04/29/slap-chop/</code></p>
672
+ <p>
673
+ The <code>:title</code> template variable will take the
674
+ <code>slug</code> <a href="/docs/front-matter/">front matter</a>
675
+ variable value if any is present in the document; if none is
676
+ defined then <code>:title</code> will be equivalent to
677
+ <code>:name</code>, aka the slug generated from the filename.
678
+ </p>
600
679
  </td>
601
680
  </tr>
602
681
  <tr>
603
682
  <td>
604
- <p><code>/:year/:month/:title</code></p>
605
- <p>See <a href="#extensionless-permalinks">Extensionless permalinks with no trailing slashes</a> for details.</p>
683
+ <p><code>:output_ext</code></p>
606
684
  </td>
607
685
  <td>
608
- <p><code>/2009/04/slap-chop</code></p>
686
+ <p>Extension of the output file. (Included by default and usually unnecessary.)</p>
609
687
  </td>
610
688
  </tr>
611
689
  </tbody>
612
690
  </table>
613
691
  </div>
614
692
 
615
- <h2 id="pages-and-collections">Permalink settings for pages and collections</h2>
616
-
617
- <p>The permalink setting in your configuration file specifies the permalink style used for posts, pages, and collections. However, because pages and collections don’t have time or categories, these aspects of the permalink style are ignored with pages and collections.</p>
618
-
619
- <p>For example:</p>
620
-
621
- <ul>
622
- <li>A permalink style of <code class="language-plaintext highlighter-rouge">/:categories/:year/:month/:day/:title:output_ext</code> for posts becomes <code class="language-plaintext highlighter-rouge">/:title.html</code> for pages and collections.</li>
623
- <li>A permalink style of <code class="language-plaintext highlighter-rouge">pretty</code> (or <code class="language-plaintext highlighter-rouge">/:categories/:year/:month/:day/:title/</code>), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: <code class="language-plaintext highlighter-rouge">/:title/</code>.</li>
624
- <li>A permalink style of <code class="language-plaintext highlighter-rouge">date</code>, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: <code class="language-plaintext highlighter-rouge">/:title.html</code>. But no time or category information will be included.</li>
625
- </ul>
626
-
627
- <h2 id="permalinks-and-default-paths">Permalinks and default paths</h2>
628
-
629
- <p>The path to the post or page in the built site differs for posts, pages, and collections:</p>
630
-
631
- <h3 id="posts">Posts</h3>
632
-
633
- <p>The subfolders into which you may have organized your posts inside the <code class="language-plaintext highlighter-rouge">_posts</code> directory will not be part of the permalink.</p>
634
-
635
- <p>If you use a permalink style that omits the <code class="language-plaintext highlighter-rouge">.html</code> file extension, each post is rendered as an <code class="language-plaintext highlighter-rouge">index.html</code> file inside a folder with the post’s name (for example, <code class="language-plaintext highlighter-rouge">categoryname/2016/12/01/mypostname/index.html</code>).</p>
636
-
637
- <h3 id="pages">Pages</h3>
638
-
639
- <p>Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a <code class="language-plaintext highlighter-rouge">permalink</code> declared its front matter — in that case, the structure honors the permalink setting instead of the source folder structure.)</p>
640
-
641
- <p>As with posts, if you use a permalink style that omits the <code class="language-plaintext highlighter-rouge">.html</code> file extension, each page is rendered as an <code class="language-plaintext highlighter-rouge">index.html</code> file inserted inside a folder with the page’s name (for example, <code class="language-plaintext highlighter-rouge">mypage/index.html</code>).</p>
642
-
643
- <h3 id="collections">Collections</h3>
644
-
645
- <p>By default, collections follow a similar structure in the <code class="language-plaintext highlighter-rouge">_site</code> folder as pages, except that the path is prefaced by the collection name. For example: <code class="language-plaintext highlighter-rouge">collectionname/mypage.html</code>. For permalink settings that omit the file extension, the path would be <code class="language-plaintext highlighter-rouge">collection_name/mypage/index.html</code>.</p>
646
-
647
- <p>Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as <code class="language-plaintext highlighter-rouge">path</code> and <code class="language-plaintext highlighter-rouge">output_ext</code>). See the <a href="../collections/#permalinks">Configuring permalinks for collections</a> in Collections for more information.</p>
648
-
649
- <h2 id="flattening-pages-in-_site-on-build">Flattening pages in _site on build</h2>
650
-
651
- <p>If you want to flatten your pages (pull them out of subfolders) in the <code class="language-plaintext highlighter-rouge">_site</code> directory when your site builds (similar to posts), add the <code class="language-plaintext highlighter-rouge">permalink</code> property to the front matter of each page, with no path specified:</p>
652
-
653
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nn">---</span>
654
- <span class="na">title</span><span class="pi">:</span> <span class="s">My page</span>
655
- <span class="na">permalink</span><span class="pi">:</span> <span class="s">mypageurl.html</span>
656
- <span class="nn">---</span>
657
- </code></pre></div></div>
658
-
659
- <h2 id="extensionless-permalinks">Extensionless permalinks with no trailing slashes</h2>
660
-
661
- <p>Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically <code class="language-plaintext highlighter-rouge">.html</code>), so the web server must be able to map requests without file extensions to these files.</p>
662
-
663
- <p>Both <a href="../github-pages/">GitHub Pages</a> and the Jekyll’s built-in WEBrick server handle these requests properly without any additional work.</p>
664
-
665
- <h3 id="apache">Apache</h3>
666
-
667
- <p>The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the <a href="https://httpd.apache.org/docs/current/content-negotiation.html#multiviews">multiviews</a> option in your <code class="language-plaintext highlighter-rouge">httpd.conf</code> or <code class="language-plaintext highlighter-rouge">.htaccess</code> file:</p>
668
-
669
- <figure class="highlight"><pre><code class="language-apache" data-lang="apache"><span class="nc">Options</span> +MultiViews</code></pre></figure>
670
-
671
- <h3 id="nginx">Nginx</h3>
672
-
673
- <p>The <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files">try_files</a> directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an <code class="language-plaintext highlighter-rouge">.html</code> extension if an exact match for the requested URI is not found.</p>
674
-
675
- <figure class="highlight"><pre><code class="language-nginx" data-lang="nginx"><span class="k">try_files</span> <span class="nv">$uri</span> <span class="nv">$uri</span><span class="s">.html</span> <span class="nv">$uri</span><span class="n">/</span> <span class="p">=</span><span class="mi">404</span><span class="p">;</span></code></pre></figure>
676
-
677
- <h2 id="linking-without-regard-to-permalink-styles">Linking without regard to permalink styles</h2>
678
-
679
- <p>You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the <code class="language-plaintext highlighter-rouge">link</code> tag, if you change your permalinks, your links won’t break. See <a href="../templates#link">Linking to pages</a> in Templates for more details.</p>
693
+ </article>
694
+ </div>
680
695
 
696
+ <div class="unit one-fifth hide-on-mobiles">
697
+ <aside>
698
+
699
+ <h4>Getting Started</h4>
700
+ <ul>
701
+
681
702
 
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
-
714
-
715
-
716
-
717
-
718
-
719
-
720
-
721
-
722
-
723
-
724
-
725
-
726
-
727
-
728
-
729
-
730
-
731
-
732
-
733
-
734
-
735
-
736
-
737
-
738
-
739
-
740
-
741
-
742
-
743
-
744
-
745
-
746
- <div class="section-nav">
747
- <div class="left align-right">
703
+ <li>
704
+ <a href="/docs/">
705
+ Quickstart
706
+ </a>
707
+ </li>
708
+
748
709
 
749
-
750
-
751
- <a href="/docs/includes/" class="prev">Back</a>
710
+ <li>
711
+ <a href="/docs/ruby-101/">
712
+ Ruby 101
713
+ </a>
714
+ </li>
715
+
752
716
 
753
- </div>
754
- <div class="right align-left">
717
+ <li>
718
+ <a href="/docs/installation/">
719
+ Installation
720
+ </a>
721
+ </li>
722
+
755
723
 
756
-
757
-
758
- <a href="/docs/pagination/" class="next">Next</a>
724
+ <li>
725
+ <a href="/docs/community/">
726
+ Community
727
+ </a>
728
+ </li>
729
+
759
730
 
760
- </div>
761
- </div>
762
- <div class="clear"></div>
763
-
764
- </article>
765
- </div>
766
-
767
- <div class="unit one-fifth hide-on-mobiles">
768
- <aside>
769
-
770
- <h4>Getting Started</h4>
771
- <ul>
772
-
773
-
774
-
775
- <li class=""><a href="/docs/home/">Welcome</a></li>
776
-
777
-
778
-
779
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
780
-
781
-
782
-
783
- <li class=""><a href="/docs/installation/">Installation</a></li>
784
-
785
-
786
-
787
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
788
-
789
-
790
-
791
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
792
-
793
-
794
-
795
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
796
-
797
-
798
-
799
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
800
-
801
- </ul>
802
-
803
-
804
- <h4>Your Content</h4>
805
- <ul>
806
-
807
-
808
-
809
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
810
-
811
-
812
-
813
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
814
-
815
-
816
-
817
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
818
-
819
-
820
-
821
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
822
-
823
-
824
-
825
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
826
-
827
-
828
-
829
- <li class=""><a href="/docs/variables/">Variables</a></li>
830
-
831
-
832
-
833
- <li class=""><a href="/docs/collections/">Collections</a></li>
834
-
835
-
836
-
837
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
838
-
839
-
840
-
841
- <li class=""><a href="/docs/assets/">Assets</a></li>
842
-
843
-
844
-
845
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
846
-
847
- </ul>
848
-
731
+ <li>
732
+ <a href="/docs/step-by-step/01-setup/">
733
+ Step by Step Tutorial
734
+ </a>
735
+ </li>
736
+
737
+ </ul>
849
738
 
850
- <h4>Customization</h4>
851
- <ul>
852
-
853
-
854
-
855
- <li class=""><a href="/docs/templates/">Templates</a></li>
856
-
857
-
858
-
859
- <li class=""><a href="/docs/includes/">Includes</a></li>
860
-
861
-
862
-
863
- <li class="current"><a href="/docs/permalinks/">Permalinks</a></li>
864
-
865
-
866
-
867
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
868
-
869
-
870
-
871
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
872
-
873
-
874
-
875
- <li class=""><a href="/docs/themes/">Themes</a></li>
876
-
877
-
878
-
879
- <li class=""><a href="/docs/extras/">Extras</a></li>
880
-
881
- </ul>
882
-
739
+ <h4>Build</h4>
740
+ <ul>
741
+
742
+
743
+ <li>
744
+ <a href="/docs/usage/">
745
+ Command Line Usage
746
+ </a>
747
+ </li>
748
+
749
+
750
+ <li>
751
+ <a href="/docs/configuration/">
752
+ Configuration
753
+ </a>
754
+ </li>
755
+
756
+ </ul>
883
757
 
884
- <h4>Deployment</h4>
885
- <ul>
886
-
887
-
888
-
889
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
890
-
891
-
892
-
893
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
894
-
895
-
896
-
897
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
898
-
899
- </ul>
900
-
758
+ <h4>Content</h4>
759
+ <ul>
760
+
761
+
762
+ <li>
763
+ <a href="/docs/pages/">
764
+ Pages
765
+ </a>
766
+ </li>
767
+
768
+
769
+ <li>
770
+ <a href="/docs/posts/">
771
+ Posts
772
+ </a>
773
+ </li>
774
+
775
+
776
+ <li>
777
+ <a href="/docs/front-matter/">
778
+ Front Matter
779
+ </a>
780
+ </li>
781
+
782
+
783
+ <li>
784
+ <a href="/docs/collections/">
785
+ Collections
786
+ </a>
787
+ </li>
788
+
789
+
790
+ <li>
791
+ <a href="/docs/datafiles/">
792
+ Data Files
793
+ </a>
794
+ </li>
795
+
796
+
797
+ <li>
798
+ <a href="/docs/assets/">
799
+ Assets
800
+ </a>
801
+ </li>
802
+
803
+
804
+ <li>
805
+ <a href="/docs/static-files/">
806
+ Static Files
807
+ </a>
808
+ </li>
809
+
810
+ </ul>
901
811
 
902
- <h4>Miscellaneous</h4>
903
- <ul>
904
-
905
-
906
-
907
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
908
-
909
-
910
-
911
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
912
-
913
-
914
-
915
- <li class=""><a href="/docs/resources/">Resources</a></li>
916
-
917
-
918
-
919
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
920
-
921
-
922
-
923
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
924
-
925
- </ul>
926
-
812
+ <h4>Site Structure</h4>
813
+ <ul>
814
+
815
+
816
+ <li>
817
+ <a href="/docs/structure/">
818
+ Directory Structure
819
+ </a>
820
+ </li>
821
+
822
+
823
+ <li>
824
+ <a href="/docs/liquid/">
825
+ Liquid
826
+ </a>
827
+ </li>
828
+
829
+
830
+ <li>
831
+ <a href="/docs/variables/">
832
+ Variables
833
+ </a>
834
+ </li>
835
+
836
+
837
+ <li>
838
+ <a href="/docs/includes/">
839
+ Includes
840
+ </a>
841
+ </li>
842
+
843
+
844
+ <li>
845
+ <a href="/docs/layouts/">
846
+ Layouts
847
+ </a>
848
+ </li>
849
+
850
+
851
+ <li class="current">
852
+ <a href="/docs/permalinks/">
853
+ Permalinks
854
+ </a>
855
+ </li>
856
+
857
+
858
+ <li>
859
+ <a href="/docs/themes/">
860
+ Themes
861
+ </a>
862
+ </li>
863
+
864
+
865
+ <li>
866
+ <a href="/docs/pagination/">
867
+ Pagination
868
+ </a>
869
+ </li>
870
+
871
+ </ul>
927
872
 
928
- <h4>Meta</h4>
929
- <ul>
930
-
931
-
932
-
933
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
934
-
935
-
936
-
937
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
938
-
939
-
940
-
941
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
942
-
943
-
944
-
945
- <li class=""><a href="/docs/history/">History</a></li>
946
-
947
- </ul>
948
-
873
+ <h4>Guides</h4>
874
+ <ul>
875
+
876
+
877
+ <li>
878
+ <a href="/docs/plugins/">
879
+ Plugins
880
+ </a>
881
+ </li>
882
+
883
+
884
+ <li>
885
+ <a href="/docs/migrations/">
886
+ Blog Migrations
887
+ </a>
888
+ </li>
889
+
890
+
891
+ <li>
892
+ <a href="/docs/upgrading/">
893
+ Upgrading
894
+ </a>
895
+ </li>
896
+
897
+
898
+ <li>
899
+ <a href="/docs/deployment/">
900
+ Deployment
901
+ </a>
902
+ </li>
903
+
904
+ </ul>
949
905
 
950
906
  </aside>
951
907
  </div>
@@ -960,7 +916,8 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
960
916
  <footer>
961
917
  <div class="grid">
962
918
  <div class="unit one-third center-on-mobiles">
963
- <p>The contents of this website are <br />&copy;&nbsp;2020 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
919
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
920
+ <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>
964
921
  </div>
965
922
  <div class="unit two-thirds align-right center-on-mobiles">
966
923
  <p>
@@ -970,6 +927,14 @@ Jekyll supports a flexible way to build permalinks, allowing you to leverage var
970
927
  </a>
971
928
  </p>
972
929
  </div>
930
+ <div class="unit two-thirds align-right center-on-mobiles">
931
+ <p>
932
+ Jekyll is funded thanks to its
933
+ <a href="https://github.com/jekyll/jekyll#sponsors">
934
+ sponsors!
935
+ </a>
936
+ </p>
937
+ </div>
973
938
  </div>
974
939
  </footer>
975
940