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,17 +3,18 @@
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>The Jekyll Team | 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="The Jekyll Team" />
18
19
  <meta property="og:locale" content="en_US" />
19
20
  <meta name="description" content="Transform your plain text into static websites and blogs" />
@@ -21,12 +22,14 @@
21
22
  <link rel="canonical" href="https://jekyllrb.com/team/" />
22
23
  <meta property="og:url" content="https://jekyllrb.com/team/" />
23
24
  <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
24
- <meta name="twitter:card" content="summary" />
25
+ <meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
26
+ <meta name="twitter:card" content="summary_large_image" />
27
+ <meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
25
28
  <meta property="twitter:title" content="The Jekyll Team" />
26
29
  <meta name="twitter:site" content="@jekyllrb" />
27
30
  <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
28
31
  <script type="application/ld+json">
29
- {"url":"https://jekyllrb.com/team/","headline":"The Jekyll Team","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"description":"Transform your plain text into static websites and blogs","@type":"WebPage","@context":"https://schema.org"}</script>
32
+ {"description":"Transform your plain text into static websites and blogs","@type":"WebPage","headline":"The Jekyll Team","url":"https://jekyllrb.com/team/","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>
30
33
  <!-- End Jekyll SEO tag -->
31
34
 
32
35
  <!--[if lt IE 9]>
@@ -49,18 +52,27 @@
49
52
  </div>
50
53
  <nav class="main-nav hide-on-mobiles">
51
54
  <ul>
52
- <li class="">
55
+
56
+ <li>
53
57
  <a href="/">Home</a>
54
58
  </li>
55
- <li class="">
56
- <a href="/docs/home/">Docs</a>
59
+
60
+ <li>
61
+ <a href="/docs/">Docs</a>
57
62
  </li>
58
- <li class="">
59
- <a href="/news/">News</a>
63
+
64
+ <li>
65
+ <a href="/resources/">Resources</a>
60
66
  </li>
61
- <li class="">
62
- <a href="/help/">Help</a>
67
+
68
+ <li>
69
+ <a href="/showcase/">Showcase</a>
70
+ </li>
71
+
72
+ <li>
73
+ <a href="/news/">News</a>
63
74
  </li>
75
+
64
76
  </ul>
65
77
 
66
78
  </nav>
@@ -71,7 +83,7 @@
71
83
  <div class="meta hide-on-mobiles">
72
84
  <ul>
73
85
  <li>
74
- <a href="https://github.com/jekyll/jekyll/releases/tag/v3.9.0">v3.9.0</a>
86
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
75
87
  </li>
76
88
  <li>
77
89
  <a href="https://github.com/jekyll/jekyll">GitHub</a>
@@ -81,18 +93,24 @@
81
93
  </div>
82
94
  <nav class="mobile-nav show-on-mobiles">
83
95
  <ul>
84
- <li class="">
85
- <a href="/">Home</a>
86
- </li>
87
- <li class="">
88
- <a href="/docs/home/">Docs</a>
89
- </li>
90
- <li class="">
91
- <a href="/news/">News</a>
92
- </li>
93
- <li class="">
94
- <a href="/help/">Help</a>
95
- </li>
96
+
97
+ <li>
98
+ <a href="/">Home</a>
99
+ </li>
100
+
101
+ <li>
102
+ <a href="/docs/">Docs</a>
103
+ </li>
104
+
105
+ <li>
106
+ <a href="/resources/">Resources</a>
107
+ </li>
108
+
109
+
110
+ <li>
111
+ <a href="/news/">News</a>
112
+ </li>
113
+
96
114
  <li>
97
115
  <a href="https://github.com/jekyll/jekyll">GitHub</a>
98
116
  </li>
@@ -113,63 +131,22 @@
113
131
  <p><em>The Jekyll Core Team’s responsibility is to ensure the development and
114
132
  community around the Jekyll ecosystem thrive.</em></p>
115
133
 
116
- <ol>
117
- <li>Olivia (<a href="https://github.com/oe" class="user-mention">@oe</a>, Lead Developer)</li>
118
- <li>Frank (<a href="https://github.com/DirtyF" class="user-mention">@DirtyF</a>, Documentation)</li>
119
- <li>Pat (<a href="https://github.com/pathawks" class="user-mention">@pathawks</a>)</li>
120
- <li>Matt (<a href="https://github.com/mattr-" class="user-mention">@mattr-</a>)</li>
121
- </ol>
122
-
123
- <h2 id="plugin-core">Plugin Core</h2>
124
-
125
- <p><em>The Jekyll Plugin Core Team’s responsibility is to ensure the development and
126
- community around the core plugins thrive. They also provide guidance in
127
- conversations about extensibility of Core Jekyll.</em></p>
128
-
129
- <ol>
134
+ <ul>
130
135
  <li>Ashwin (<a href="https://github.com/ashmaroli" class="user-mention">@ashmaroli</a>)</li>
131
- <li>Florian (<a href="https://github.com/Crunch09" class="user-mention">@Crunch09</a>)</li>
132
- <li>Mert (<a href="https://github.com/mertkahyaoglu" class="user-mention">@mertkahyaoglu</a>, jekyll-admin)</li>
133
- <li>Alfred Xing (<a href="https://github.com/alfredxing" class="user-mention">@alfredxing</a>)</li>
134
- </ol>
135
-
136
- <h2 id="affinity-team-captains">Affinity Team Captains</h2>
137
-
138
- <p><em>The Affinity Team Captains lead <a href="https://teams.jekyllrb.com/">Jekyll’s Affinity
139
- Teams</a>. Each team is tasked with maintaining
140
- and addressing issues for a specific aspect of Jekyll.</em></p>
141
-
142
- <ol>
143
- <li>
144
- <a href="https://github.com/orgs/jekyll/teams/build">Build</a>: <a href="https://github.com/mattr-" class="user-mention">@mattr-</a>
145
- </li>
146
- <li>
147
- <a href="https://github.com/orgs/jekyll/teams/documentation">Documentation</a>: <a href="https://github.com/DirtyF" class="user-mention">@DirtyF</a>, <a href="https://github.com/mattr-" class="user-mention">@mattr-</a>
148
- </li>
149
- <li>
150
- <a href="https://github.com/orgs/jekyll/teams/ecosystem">Ecosystem</a>: <a href="https://github.com/pathawks" class="user-mention">@pathawks</a>
151
- </li>
152
- <li>
153
- <a href="https://github.com/orgs/jekyll/teams/performance">Performance</a>: <a href="https://github.com/mattr-" class="user-mention">@mattr-</a>, <a href="https://github.com/parkr" class="user-mention">@parkr</a>
154
- </li>
155
- <li>
156
- <a href="https://github.com/orgs/jekyll/teams/stability">Stability</a>: <a href="https://github.com/oe" class="user-mention">@oe</a>, <a href="https://github.com/parkr" class="user-mention">@parkr</a>
157
- </li>
158
- <li>
159
- <a href="https://github.com/orgs/jekyll/teams/windows">Windows</a>: <a href="https://github.com/XhmikosR" class="user-mention">@XhmikosR</a>
160
- </li>
161
- </ol>
136
+ <li>Frank (<a href="https://github.com/DirtyF" class="user-mention">@DirtyF</a>)</li>
137
+ <li>Matt (<a href="https://github.com/mattr-" class="user-mention">@mattr-</a>)</li>
138
+ </ul>
162
139
 
163
140
  <h2 id="emeritus-core-team-members">Emeritus Core Team Members</h2>
164
141
 
165
142
  <p><em>Emeritus Core Team Members were once members of Jekyll’s Core Team.</em></p>
166
143
 
167
- <ol>
144
+ <ul>
145
+ <li>Alfred (<a href="https://github.com/alfredxing" class="user-mention">@alfredxing</a>)</li>
146
+ <li>Nick (<a href="https://github.com/qrush" class="user-mention">@qrush</a>)</li>
168
147
  <li>Parker (<a href="https://github.com/parkr" class="user-mention">@parkr</a>)</li>
169
148
  <li>Tom (<a href="https://github.com/mojombo" class="user-mention">@mojombo</a>)</li>
170
- <li>Nick (<a href="https://github.com/qrush" class="user-mention">@qrush</a>)</li>
171
- <li>Alfred (<a href="https://github.com/alfredxing" class="user-mention">@alfredxing</a>)</li>
172
- </ol>
149
+ </ul>
173
150
 
174
151
  </article>
175
152
  </div>
@@ -183,7 +160,8 @@ and addressing issues for a specific aspect of Jekyll.</em></p>
183
160
  <footer>
184
161
  <div class="grid">
185
162
  <div class="unit one-third center-on-mobiles">
186
- <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>
163
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
164
+ <p>The contents of this website are <br>© 2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
187
165
  </div>
188
166
  <div class="unit two-thirds align-right center-on-mobiles">
189
167
  <p>
@@ -193,6 +171,14 @@ and addressing issues for a specific aspect of Jekyll.</em></p>
193
171
  </a>
194
172
  </p>
195
173
  </div>
174
+ <div class="unit two-thirds align-right center-on-mobiles">
175
+ <p>
176
+ Jekyll is funded thanks to its
177
+ <a href="https://github.com/jekyll/jekyll#sponsors">
178
+ sponsors!
179
+ </a>
180
+ </p>
181
+ </div>
196
182
  </div>
197
183
  </footer>
198
184
 
@@ -0,0 +1,418 @@
1
+ <!DOCTYPE HTML>
2
+ <html lang="en-US">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <meta name="generator" content="Jekyll v4.0.0">
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" />
9
+ <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
+ <link rel="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">
13
+ <link rel="stylesheet" href="/css/screen.css">
14
+ <link rel="icon" type="image/x-icon" href="/favicon.ico">
15
+ <!-- Begin Jekyll SEO tag v2.6.1 -->
16
+ <title>Cache API | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Cache API" />
19
+ <meta property="og:locale" content="en_US" />
20
+ <meta name="description" content="Jekyll includes a caching API, which is used both internally as well as exposed for plugins, which can be used to cache the output of deterministic functions to speed up site generation. This cache will be persistent across builds, but cleared when Jekyll detects any changes to _config.yml." />
21
+ <meta property="og:description" content="Jekyll includes a caching API, which is used both internally as well as exposed for plugins, which can be used to cache the output of deterministic functions to speed up site generation. This cache will be persistent across builds, but cleared when Jekyll detects any changes to _config.yml." />
22
+ <link rel="canonical" href="https://jekyllrb.com/tutorials/cache-api/" />
23
+ <meta property="og:url" content="https://jekyllrb.com/tutorials/cache-api/" />
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" />
26
+ <meta property="og:type" content="article" />
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="Cache API" />
31
+ <meta name="twitter:site" content="@jekyllrb" />
32
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
33
+ <script type="application/ld+json">
34
+ {"description":"Jekyll includes a caching API, which is used both internally as well as exposed for plugins, which can be used to cache the output of deterministic functions to speed up site generation. This cache will be persistent across builds, but cleared when Jekyll detects any changes to _config.yml.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/tutorials/cache-api/"},"headline":"Cache API","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/tutorials/cache-api/","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>
35
+ <!-- End Jekyll SEO tag -->
36
+
37
+ <!--[if lt IE 9]>
38
+ <script src="/js/html5shiv.min.js"></script>
39
+ <script src="/js/respond.min.js"></script>
40
+ <![endif]-->
41
+ </head>
42
+
43
+
44
+ <body class="wrap">
45
+ <header>
46
+ <div class="flexbox">
47
+ <div class="center-on-mobiles">
48
+ <h1>
49
+ <a href="/" class="logo">
50
+ <span class="sr-only">Jekyll</span>
51
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
52
+ </a>
53
+ </h1>
54
+ </div>
55
+ <nav class="main-nav hide-on-mobiles">
56
+ <ul>
57
+
58
+ <li>
59
+ <a href="/">Home</a>
60
+ </li>
61
+
62
+ <li>
63
+ <a href="/docs/">Docs</a>
64
+ </li>
65
+
66
+ <li>
67
+ <a href="/resources/">Resources</a>
68
+ </li>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
72
+ </li>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
76
+ </li>
77
+
78
+ </ul>
79
+
80
+ </nav>
81
+ <div class="search hide-on-mobiles">
82
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
83
+
84
+ </div>
85
+ <div class="meta hide-on-mobiles">
86
+ <ul>
87
+ <li>
88
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
89
+ </li>
90
+ <li>
91
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
92
+ </li>
93
+ </ul>
94
+ </div>
95
+ </div>
96
+ <nav class="mobile-nav show-on-mobiles">
97
+ <ul>
98
+
99
+ <li>
100
+ <a href="/">Home</a>
101
+ </li>
102
+
103
+ <li>
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
+
116
+ <li>
117
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
118
+ </li>
119
+ </ul>
120
+
121
+ </nav>
122
+ </header>
123
+
124
+
125
+ <section class="docs">
126
+ <div class="grid">
127
+
128
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
129
+ <select onchange="if (this.value) window.location.href=this.value">
130
+ <option value="">Navigate the tutorials…</option>
131
+
132
+ <optgroup label="Tutorials">
133
+
134
+
135
+
136
+ <option value="/tutorials/home/">Tutorials</option>
137
+
138
+
139
+
140
+ <option value="/tutorials/video-walkthroughs/">Video Walkthroughs</option>
141
+
142
+
143
+
144
+ <option value="/tutorials/navigation/">Navigation</option>
145
+
146
+
147
+
148
+ <option value="/tutorials/orderofinterpretation/">Order of interpretation</option>
149
+
150
+
151
+
152
+ <option value="/tutorials/custom-404-page/">Custom 404 Page</option>
153
+
154
+
155
+
156
+ <option value="/tutorials/convert-site-to-jekyll/">Convert an HTML site to Jekyll</option>
157
+
158
+
159
+
160
+ <option value="/tutorials/using-jekyll-with-bundler/">Using Jekyll with Bundler</option>
161
+
162
+
163
+ </optgroup>
164
+
165
+ </select>
166
+ </div>
167
+
168
+
169
+ <div class="unit four-fifths">
170
+ <article>
171
+ <div class="improve right hide-on-mobiles">
172
+ <a href="https://github.com/jekyll/jekyll/edit/master/docs/_tutorials/cache_api.md"><i class="fa fa-pencil"></i>  Improve this page</a>
173
+ </div>
174
+ <h1>Cache API</h1>
175
+ <p>Jekyll includes a caching API, which is used both internally as well as exposed
176
+ for plugins, which can be used to cache the output of deterministic functions to
177
+ speed up site generation. This cache will be persistent across builds, but
178
+ cleared when Jekyll detects any changes to <code class="highlighter-rouge">_config.yml</code>.</p>
179
+
180
+ <h2 id="jekyllcachenewname--new_cache">Jekyll::Cache.new(name) → new_cache</h2>
181
+
182
+ <p>If there has already been a cache created with <code class="highlighter-rouge">name</code>, this will return a
183
+ reference to that existing Cache. Otherwise, create a new Cache called <code class="highlighter-rouge">name</code>.</p>
184
+
185
+ <p>If this Cache will be used by a Gem-packaged plugin, <code class="highlighter-rouge">name</code> should either be the
186
+ name of the Gem, or prefixed with the name of the Gem followed by <code class="highlighter-rouge">::</code> (if a
187
+ plugin expects to use multiple Caches). If this Cache will be used internally by
188
+ Jekyll, <code class="highlighter-rouge">name</code> should be the name of the class that is using the Cache (ie:
189
+ <code class="highlighter-rouge">"Jekyll::Converters::Markdown"</code>).</p>
190
+
191
+ <p>Cached objects are shared between all Caches created with the same <code class="highlighter-rouge">name</code>, but
192
+ are <em>not</em> shared between Caches with different names. There can be an object
193
+ stored with key <code class="highlighter-rouge">1</code> in <code class="highlighter-rouge">Jekyll::Cache.new("a")</code> and an object stored with key
194
+ <code class="highlighter-rouge">1</code> in <code class="highlighter-rouge">Jekyll::Cache.new("b")</code> and these will not point to the same cached
195
+ object. This way, you do not need to ensure that keys are globally unique.</p>
196
+
197
+ <h2 id="getsetkey-block">getset(key) {block}</h2>
198
+
199
+ <p>This is the most common way to utilize the Cache.</p>
200
+
201
+ <p><code class="highlighter-rouge">block</code> is a bit of code that takes a lot of time to compute, but always
202
+ generates the same output given a particular input (like converting Markdown to
203
+ HTML). <code class="highlighter-rouge">key</code> is a <code class="highlighter-rouge">String</code> (or an object with <code class="highlighter-rouge">to_s</code>) that uniquely identifies
204
+ the input to the function.</p>
205
+
206
+ <p>If <code class="highlighter-rouge">key</code> already exists in the Cache, it will be returned and <code class="highlighter-rouge">block</code> will never
207
+ be executed. If <code class="highlighter-rouge">key</code> does not exist in the Cache, <code class="highlighter-rouge">block</code> will be executed and
208
+ the result will be added to the Cache and returned.</p>
209
+
210
+ <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">def</span> <span class="nf">cache</span>
211
+ <span class="vc">@@cache</span> <span class="o">||=</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Cache</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"ConvertMarkdown"</span><span class="p">)</span>
212
+ <span class="k">end</span>
213
+
214
+ <span class="k">def</span> <span class="nf">convert_markdown_to_html</span><span class="p">(</span><span class="n">markdown</span><span class="p">)</span>
215
+ <span class="n">cache</span><span class="p">.</span><span class="nf">getset</span><span class="p">(</span><span class="n">markdown</span><span class="p">)</span> <span class="k">do</span>
216
+ <span class="n">expensive_conversion_method</span><span class="p">(</span><span class="n">markdown</span><span class="p">)</span>
217
+ <span class="k">end</span>
218
+ <span class="k">end</span>
219
+ </code></pre></div></div>
220
+
221
+ <p>In the above example, <code class="highlighter-rouge">expensive_conversion_method</code> will only be called once for
222
+ any given <code class="highlighter-rouge">markdown</code> input. If <code class="highlighter-rouge">convert_markdown_to_html</code> is called a second
223
+ time with the same input, the cached output will be returned.</p>
224
+
225
+ <p>Because posts will frequently remain unchanged from one build to the next, this
226
+ is an effective way to avoid performing the same computations each time the site
227
+ is built.</p>
228
+
229
+ <h2 id="clear">clear</h2>
230
+
231
+ <p>This will clear all cached objects from a particular Cache. The Cache will be
232
+ empty, both in memory and on disk.</p>
233
+
234
+ <h3 id="the-following-methods-will-probably-only-be-used-in-special-circumstances">The following methods will probably only be used in special circumstances</h3>
235
+
236
+ <h2 id="cachekey--value">cache[key] → value</h2>
237
+
238
+ <p>Fetches <code class="highlighter-rouge">key</code> from Cache and returns its <code class="highlighter-rouge">value</code>. Raises if <code class="highlighter-rouge">key</code> does not exist
239
+ in Cache.</p>
240
+
241
+ <h2 id="cachekey--value-1">cache[key] = value</h2>
242
+
243
+ <p>Adds <code class="highlighter-rouge">value</code> to Cache under <code class="highlighter-rouge">key</code>.
244
+ Returns nothing.</p>
245
+
246
+ <h2 id="keykey--true-or-false">key?(key) → true or false</h2>
247
+
248
+ <p>Returns <code class="highlighter-rouge">true</code> if <code class="highlighter-rouge">key</code> already exists in Cache. False otherwise.</p>
249
+
250
+ <h2 id="deletekey">delete(key)</h2>
251
+
252
+ <p>Removes <code class="highlighter-rouge">key</code> from Cache.
253
+ Returns nothing.</p>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+ </article>
283
+ </div>
284
+
285
+ <div class="unit one-fifth hide-on-mobiles">
286
+ <aside>
287
+
288
+ <h4>Tutorials</h4>
289
+
290
+ <ul>
291
+
292
+
293
+
294
+ <li><a href="/tutorials/home/">Tutorials</a></li>
295
+
296
+
297
+
298
+ <li><a href="/tutorials/video-walkthroughs/">Video Walkthroughs</a></li>
299
+
300
+
301
+
302
+ <li><a href="/tutorials/navigation/">Navigation</a></li>
303
+
304
+
305
+
306
+ <li><a href="/tutorials/orderofinterpretation/">Order of interpretation</a></li>
307
+
308
+
309
+
310
+ <li><a href="/tutorials/custom-404-page/">Custom 404 Page</a></li>
311
+
312
+
313
+
314
+ <li><a href="/tutorials/convert-site-to-jekyll/">Convert an HTML site to Jekyll</a></li>
315
+
316
+
317
+
318
+ <li><a href="/tutorials/using-jekyll-with-bundler/">Using Jekyll with Bundler</a></li>
319
+
320
+ </ul>
321
+
322
+
323
+
324
+ </aside>
325
+ </div>
326
+
327
+
328
+ <div class="clear"></div>
329
+
330
+ </div>
331
+ </section>
332
+
333
+
334
+ <footer>
335
+ <div class="grid">
336
+ <div class="unit one-third center-on-mobiles">
337
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
338
+ <p>The contents of this website are <br>© 2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
339
+ </div>
340
+ <div class="unit two-thirds align-right center-on-mobiles">
341
+ <p>
342
+ Proudly hosted by
343
+ <a href="https://github.com">
344
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
345
+ </a>
346
+ </p>
347
+ </div>
348
+ <div class="unit two-thirds align-right center-on-mobiles">
349
+ <p>
350
+ Jekyll is funded thanks to its
351
+ <a href="https://github.com/jekyll/jekyll#sponsors">
352
+ sponsors!
353
+ </a>
354
+ </p>
355
+ </div>
356
+ </div>
357
+ </footer>
358
+
359
+ <script>
360
+ var anchorForId = function (id) {
361
+ var anchor = document.createElement("a");
362
+ anchor.className = "header-link";
363
+ anchor.href = "#" + id;
364
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
365
+ anchor.title = "Permalink";
366
+ return anchor;
367
+ };
368
+
369
+ var linkifyAnchors = function (level, containingElement) {
370
+ var headers = containingElement.getElementsByTagName("h" + level);
371
+ for (var h = 0; h < headers.length; h++) {
372
+ var header = headers[h];
373
+
374
+ if (typeof header.id !== "undefined" && header.id !== "") {
375
+ header.appendChild(anchorForId(header.id));
376
+ }
377
+ }
378
+ };
379
+
380
+ document.onreadystatechange = function () {
381
+ if (this.readyState === "complete") {
382
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
383
+ if (!contentBlock) {
384
+ return;
385
+ }
386
+ for (var level = 1; level <= 6; level++) {
387
+ linkifyAnchors(level, contentBlock);
388
+ }
389
+ }
390
+ };
391
+ </script>
392
+
393
+
394
+ <!-- Google Analytics (https://www.google.com/analytics) -->
395
+ <script>
396
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
397
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
398
+ L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
399
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
400
+
401
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
402
+ ga('send', 'pageview');
403
+
404
+ </script>
405
+
406
+
407
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
408
+ <script type="text/javascript"> docsearch({
409
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
410
+ indexName: 'jekyllrb',
411
+ inputSelector: '#docsearch-input',
412
+ enhancedSearchInput: true,
413
+ debug: false // Set debug to true if you want to inspect the dropdown
414
+ });
415
+ </script>
416
+
417
+ </body>
418
+ </html>