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>Plugins | 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="Plugins" />
18
19
  <meta property="og:locale" content="en_US" />
19
20
  <meta name="description" content="Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself." />
@@ -21,14 +22,16 @@
21
22
  <link rel="canonical" href="https://jekyllrb.com/docs/plugins/" />
22
23
  <meta property="og:url" content="https://jekyllrb.com/docs/plugins/" />
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="Plugins" />
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/plugins/","headline":"Plugins","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":"Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/"},"@type":"BlogPosting","@context":"https://schema.org"}</script>
34
+ {"description":"Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/"},"headline":"Plugins","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/plugins/","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,1404 +286,252 @@
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/plugins.md"><i class="fa fa-pencil"></i>  Improve this page</a>
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/plugins.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
296
290
  </div>
297
291
  <h1>Plugins</h1>
298
292
  <p>Jekyll has a plugin system with hooks that allow you to create custom generated
299
293
  content specific to your site. You can run custom code for your site without
300
294
  having to modify the Jekyll source itself.</p>
301
295
 
302
- <div class="note info">
303
- <h5>Plugins on GitHub Pages</h5>
304
- <p>
305
- <a href="https://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
306
- However, all Pages sites are generated using the <code>--safe</code> option
307
- to disable custom plugins for security reasons. Unfortunately, this means
308
- your plugins won’t work if you’re deploying to GitHub Pages.<br><br>
309
- You can still use GitHub Pages to publish your site, but you’ll need to
310
- convert the site locally and push the generated static files to your GitHub
311
- repository instead of the Jekyll source files.
312
- </p>
313
- </div>
314
-
315
- <h2 id="installing-a-plugin">Installing a plugin</h2>
316
-
317
- <p>You have 3 options for installing plugins:</p>
318
-
319
- <ol>
320
- <li>
321
- <p>In your site source root, make a <code class="language-plaintext highlighter-rouge">_plugins</code> directory. Place your plugins
322
- here. Any file ending in <code class="language-plaintext highlighter-rouge">*.rb</code> inside this directory will be loaded before
323
- Jekyll generates your site.</p>
324
- </li>
325
- <li>
326
- <p>In your <code class="language-plaintext highlighter-rouge">_config.yml</code> file, add a new array with the key <code class="language-plaintext highlighter-rouge">plugins</code> (or <code class="language-plaintext highlighter-rouge">gems</code> for Jekyll &lt; <code class="language-plaintext highlighter-rouge">3.5.0</code>) and the
327
- values of the gem names of the plugins you’d like to use. An example:</p>
328
-
329
- <div class="language-yaml highlighter-rouge">
330
- <div class="highlight"><pre class="highlight"><code><span class="c1"># This will require each of these plugins automatically.</span>
331
- <span class="na">plugins</span><span class="pi">:</span>
332
- <span class="pi">-</span> <span class="s">jekyll-gist</span>
333
- <span class="pi">-</span> <span class="s">jekyll-coffeescript</span>
334
- <span class="pi">-</span> <span class="s">jekyll-assets</span>
335
- <span class="pi">-</span> <span class="s">another-jekyll-plugin</span>
336
- </code></pre></div> </div>
337
-
338
- <p>Then install your plugins using <code class="language-plaintext highlighter-rouge">gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin</code></p>
339
- </li>
340
- <li>
341
- <p>Add the relevant plugins to a Bundler group in your <code class="language-plaintext highlighter-rouge">Gemfile</code>. An
342
- example:</p>
343
-
344
- <div class="language-ruby highlighter-rouge">
345
- <div class="highlight"><pre class="highlight"><code> <span class="n">group</span> <span class="ss">:jekyll_plugins</span> <span class="k">do</span>
346
- <span class="n">gem</span> <span class="s2">"jekyll-gist"</span>
347
- <span class="n">gem</span> <span class="s2">"jekyll-coffeescript"</span>
348
- <span class="n">gem</span> <span class="s2">"jekyll-assets"</span>
349
- <span class="n">gem</span> <span class="s2">"another-jekyll-plugin"</span>
350
- <span class="k">end</span>
351
- </code></pre></div> </div>
352
-
353
- <p>Now you need to install all plugins from your Bundler group by running single command <code class="language-plaintext highlighter-rouge">bundle install</code>.</p>
354
- </li>
355
- </ol>
356
-
357
- <div class="note info">
358
- <h5>
359
- <code>_plugins</code>, <code>_config.yml</code> and <code>Gemfile</code>
360
- can be used simultaneously
361
- </h5>
362
- <p>
363
- You may use any of the aforementioned plugin options simultaneously in the
364
- same site if you so choose. Use of one does not restrict the use of the
365
- others.
366
- </p>
367
- </div>
368
-
369
- <h3 id="the-jekyll_plugins-group">The jekyll_plugins group</h3>
370
-
371
- <p>Jekyll gives this particular group of gems in your <code class="language-plaintext highlighter-rouge">Gemfile</code> a different
372
- treatment. Any gem included in this group is loaded before Jekyll starts
373
- processing the rest of your source directory.</p>
296
+ <ul>
297
+ <li><a href="/docs/plugins/installation/">Installation</a> - How to install plugins</li>
298
+ <li><a href="/docs/plugins/your-first-plugin/">Your first plugin</a> - How to write plugins</li>
299
+ <li><a href="/docs/plugins/generators/">Generators</a> - Create additional content on your site</li>
300
+ <li><a href="/docs/plugins/converters/">Converters</a> - Change a markup language into another format</li>
301
+ <li><a href="/docs/plugins/commands/">Commands</a> - Extend the <code class="highlighter-rouge">jekyll</code> executable with subcommands</li>
302
+ <li><a href="/docs/plugins/tags">Tags</a> - Create custom Liquid tags</li>
303
+ <li><a href="/docs/plugins/filters/">Filters</a> - Create custom Liquid filters</li>
304
+ <li><a href="/docs/plugins/hooks/">Hooks</a> - Fine-grained control to extend the build process</li>
305
+ </ul>
374
306
 
375
- <p>A gem included here will be activated even if its not explicitly listed under
376
- the <code class="language-plaintext highlighter-rouge">plugins:</code> key in your site’s config file.</p>
307
+ </article>
308
+ </div>
377
309
 
378
- <div class="note warning">
379
- <p>
380
- Gems included in the <code>:jekyll-plugins</code> group are activated
381
- regardless of the <code>--safe</code> mode setting. Be aware of what
382
- gems are included under this group!
383
- </p>
310
+ <div class="unit one-fifth hide-on-mobiles">
311
+ <aside>
312
+
313
+ <h4>Getting Started</h4>
314
+ <ul>
315
+
316
+
317
+ <li>
318
+ <a href="/docs/">
319
+ Quickstart
320
+ </a>
321
+ </li>
322
+
323
+
324
+ <li>
325
+ <a href="/docs/ruby-101/">
326
+ Ruby 101
327
+ </a>
328
+ </li>
329
+
330
+
331
+ <li>
332
+ <a href="/docs/installation/">
333
+ Installation
334
+ </a>
335
+ </li>
336
+
337
+
338
+ <li>
339
+ <a href="/docs/community/">
340
+ Community
341
+ </a>
342
+ </li>
343
+
344
+
345
+ <li>
346
+ <a href="/docs/step-by-step/01-setup/">
347
+ Step by Step Tutorial
348
+ </a>
349
+ </li>
350
+
351
+ </ul>
352
+
353
+ <h4>Build</h4>
354
+ <ul>
355
+
356
+
357
+ <li>
358
+ <a href="/docs/usage/">
359
+ Command Line Usage
360
+ </a>
361
+ </li>
362
+
363
+
364
+ <li>
365
+ <a href="/docs/configuration/">
366
+ Configuration
367
+ </a>
368
+ </li>
369
+
370
+ </ul>
371
+
372
+ <h4>Content</h4>
373
+ <ul>
374
+
375
+
376
+ <li>
377
+ <a href="/docs/pages/">
378
+ Pages
379
+ </a>
380
+ </li>
381
+
382
+
383
+ <li>
384
+ <a href="/docs/posts/">
385
+ Posts
386
+ </a>
387
+ </li>
388
+
389
+
390
+ <li>
391
+ <a href="/docs/front-matter/">
392
+ Front Matter
393
+ </a>
394
+ </li>
395
+
396
+
397
+ <li>
398
+ <a href="/docs/collections/">
399
+ Collections
400
+ </a>
401
+ </li>
402
+
403
+
404
+ <li>
405
+ <a href="/docs/datafiles/">
406
+ Data Files
407
+ </a>
408
+ </li>
409
+
410
+
411
+ <li>
412
+ <a href="/docs/assets/">
413
+ Assets
414
+ </a>
415
+ </li>
416
+
417
+
418
+ <li>
419
+ <a href="/docs/static-files/">
420
+ Static Files
421
+ </a>
422
+ </li>
423
+
424
+ </ul>
425
+
426
+ <h4>Site Structure</h4>
427
+ <ul>
428
+
429
+
430
+ <li>
431
+ <a href="/docs/structure/">
432
+ Directory Structure
433
+ </a>
434
+ </li>
435
+
436
+
437
+ <li>
438
+ <a href="/docs/liquid/">
439
+ Liquid
440
+ </a>
441
+ </li>
442
+
443
+
444
+ <li>
445
+ <a href="/docs/variables/">
446
+ Variables
447
+ </a>
448
+ </li>
449
+
450
+
451
+ <li>
452
+ <a href="/docs/includes/">
453
+ Includes
454
+ </a>
455
+ </li>
456
+
457
+
458
+ <li>
459
+ <a href="/docs/layouts/">
460
+ Layouts
461
+ </a>
462
+ </li>
463
+
464
+
465
+ <li>
466
+ <a href="/docs/permalinks/">
467
+ Permalinks
468
+ </a>
469
+ </li>
470
+
471
+
472
+ <li>
473
+ <a href="/docs/themes/">
474
+ Themes
475
+ </a>
476
+ </li>
477
+
478
+
479
+ <li>
480
+ <a href="/docs/pagination/">
481
+ Pagination
482
+ </a>
483
+ </li>
484
+
485
+ </ul>
486
+
487
+ <h4>Guides</h4>
488
+ <ul>
489
+
490
+
491
+ <li class="current">
492
+ <a href="/docs/plugins/">
493
+ Plugins
494
+ </a>
495
+ </li>
496
+
497
+
498
+ <li>
499
+ <a href="/docs/migrations/">
500
+ Blog Migrations
501
+ </a>
502
+ </li>
503
+
504
+
505
+ <li>
506
+ <a href="/docs/upgrading/">
507
+ Upgrading
508
+ </a>
509
+ </li>
510
+
511
+
512
+ <li>
513
+ <a href="/docs/deployment/">
514
+ Deployment
515
+ </a>
516
+ </li>
517
+
518
+ </ul>
519
+
520
+ </aside>
384
521
  </div>
385
522
 
386
- <p>In general, plugins you make will fall broadly into one of five categories:</p>
387
-
388
- <ol>
389
- <li><a href="#generators">Generators</a></li>
390
- <li><a href="#converters">Converters</a></li>
391
- <li><a href="#commands">Commands</a></li>
392
- <li><a href="#tags">Tags</a></li>
393
- <li><a href="#hooks">Hooks</a></li>
394
- </ol>
395
-
396
- <p>See the bottom of the page for a <a href="#available-plugins">list of available plugins</a>.</p>
397
-
398
- <p>For further information on how to develop your own plugins, check out the <a href="https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers">Liquid documentation</a> as well.</p>
399
-
400
- <p>If you never developed a Jekyll plugin <a href="https://ayastreb.me/writing-a-jekyll-plugin/">check this useful wrap-up</a> by <a href="https://github.com/ayastreb" class="user-mention">@ayastreb</a> to get started.</p>
401
-
402
- <h2 id="generators">Generators</h2>
403
-
404
- <p>You can create a generator when you need Jekyll to create additional content
405
- based on your own rules.</p>
406
523
 
407
- <p>A generator is a subclass of <code class="language-plaintext highlighter-rouge">Jekyll::Generator</code> that defines a <code class="language-plaintext highlighter-rouge">generate</code>
408
- method, which receives an instance of
409
- <a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="language-plaintext highlighter-rouge">Jekyll::Site</code></a>. The
410
- return value of <code class="language-plaintext highlighter-rouge">generate</code> is ignored.</p>
411
-
412
- <p>Generators run after Jekyll has made an inventory of the existing content, and
413
- before the site is generated. Pages with YAML Front Matters are stored as
414
- instances of
415
- <a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/page.rb"><code class="language-plaintext highlighter-rouge">Jekyll::Page</code></a>
416
- and are available via <code class="language-plaintext highlighter-rouge">site.pages</code>. Static files become instances of
417
- <a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/static_file.rb"><code class="language-plaintext highlighter-rouge">Jekyll::StaticFile</code></a>
418
- and are available via <code class="language-plaintext highlighter-rouge">site.static_files</code>. See
419
- <a href="/docs/variables/">the Variables documentation page</a> and
420
- <a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="language-plaintext highlighter-rouge">Jekyll::Site</code></a>
421
- for more details.</p>
422
-
423
- <p>For instance, a generator can inject values computed at build time for template
424
- variables. In the following example the template <code class="language-plaintext highlighter-rouge">reading.html</code> has two
425
- variables <code class="language-plaintext highlighter-rouge">ongoing</code> and <code class="language-plaintext highlighter-rouge">done</code> that we fill in the generator:</p>
426
-
427
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Reading</span>
428
- <span class="k">class</span> <span class="nc">Generator</span> <span class="o">&lt;</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Generator</span>
429
- <span class="k">def</span> <span class="nf">generate</span><span class="p">(</span><span class="n">site</span><span class="p">)</span>
430
- <span class="n">ongoing</span><span class="p">,</span> <span class="n">done</span> <span class="o">=</span> <span class="no">Book</span><span class="p">.</span><span class="nf">all</span><span class="p">.</span><span class="nf">partition</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:ongoing?</span><span class="p">)</span>
431
-
432
- <span class="n">reading</span> <span class="o">=</span> <span class="n">site</span><span class="p">.</span><span class="nf">pages</span><span class="p">.</span><span class="nf">detect</span> <span class="p">{</span><span class="o">|</span><span class="n">page</span><span class="o">|</span> <span class="n">page</span><span class="p">.</span><span class="nf">name</span> <span class="o">==</span> <span class="s1">'reading.html'</span><span class="p">}</span>
433
- <span class="n">reading</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'ongoing'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ongoing</span>
434
- <span class="n">reading</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'done'</span><span class="p">]</span> <span class="o">=</span> <span class="n">done</span>
435
- <span class="k">end</span>
436
- <span class="k">end</span>
437
- <span class="k">end</span>
438
- </code></pre></div></div>
439
-
440
- <p>This is a more complex generator that generates new pages:</p>
441
-
442
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
443
- <span class="k">class</span> <span class="nc">CategoryPage</span> <span class="o">&lt;</span> <span class="no">Page</span>
444
- <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">site</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">dir</span><span class="p">,</span> <span class="n">category</span><span class="p">)</span>
445
- <span class="vi">@site</span> <span class="o">=</span> <span class="n">site</span>
446
- <span class="vi">@base</span> <span class="o">=</span> <span class="n">base</span>
447
- <span class="vi">@dir</span> <span class="o">=</span> <span class="n">dir</span>
448
- <span class="vi">@name</span> <span class="o">=</span> <span class="s1">'index.html'</span>
449
-
450
- <span class="nb">self</span><span class="p">.</span><span class="nf">process</span><span class="p">(</span><span class="vi">@name</span><span class="p">)</span>
451
- <span class="nb">self</span><span class="p">.</span><span class="nf">read_yaml</span><span class="p">(</span><span class="no">File</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s1">'_layouts'</span><span class="p">),</span> <span class="s1">'category_index.html'</span><span class="p">)</span>
452
- <span class="nb">self</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'category'</span><span class="p">]</span> <span class="o">=</span> <span class="n">category</span>
453
-
454
- <span class="n">category_title_prefix</span> <span class="o">=</span> <span class="n">site</span><span class="p">.</span><span class="nf">config</span><span class="p">[</span><span class="s1">'category_title_prefix'</span><span class="p">]</span> <span class="o">||</span> <span class="s1">'Category: '</span>
455
- <span class="nb">self</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"</span><span class="si">#{</span><span class="n">category_title_prefix</span><span class="si">}#{</span><span class="n">category</span><span class="si">}</span><span class="s2">"</span>
456
- <span class="k">end</span>
457
- <span class="k">end</span>
458
-
459
- <span class="k">class</span> <span class="nc">CategoryPageGenerator</span> <span class="o">&lt;</span> <span class="no">Generator</span>
460
- <span class="n">safe</span> <span class="kp">true</span>
461
-
462
- <span class="k">def</span> <span class="nf">generate</span><span class="p">(</span><span class="n">site</span><span class="p">)</span>
463
- <span class="k">if</span> <span class="n">site</span><span class="p">.</span><span class="nf">layouts</span><span class="p">.</span><span class="nf">key?</span> <span class="s1">'category_index'</span>
464
- <span class="n">dir</span> <span class="o">=</span> <span class="n">site</span><span class="p">.</span><span class="nf">config</span><span class="p">[</span><span class="s1">'category_dir'</span><span class="p">]</span> <span class="o">||</span> <span class="s1">'categories'</span>
465
- <span class="n">site</span><span class="p">.</span><span class="nf">categories</span><span class="p">.</span><span class="nf">each_key</span> <span class="k">do</span> <span class="o">|</span><span class="n">category</span><span class="o">|</span>
466
- <span class="n">site</span><span class="p">.</span><span class="nf">pages</span> <span class="o">&lt;&lt;</span> <span class="no">CategoryPage</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">site</span><span class="p">,</span> <span class="n">site</span><span class="p">.</span><span class="nf">source</span><span class="p">,</span> <span class="no">File</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="n">dir</span><span class="p">,</span> <span class="n">category</span><span class="p">),</span> <span class="n">category</span><span class="p">)</span>
467
- <span class="k">end</span>
468
- <span class="k">end</span>
469
- <span class="k">end</span>
470
- <span class="k">end</span>
471
- <span class="k">end</span>
472
- </code></pre></div></div>
473
-
474
- <p>In this example, our generator will create a series of files under the
475
- <code class="language-plaintext highlighter-rouge">categories</code> directory for each category, listing the posts in each category
476
- using the <code class="language-plaintext highlighter-rouge">category_index.html</code> layout.</p>
477
-
478
- <p>Generators are only required to implement one method:</p>
524
+ <div class="clear"></div>
479
525
 
480
- <div class="mobile-side-scroller">
481
- <table>
482
- <thead>
483
- <tr>
484
- <th>Method</th>
485
- <th>Description</th>
486
- </tr>
487
- </thead>
488
- <tbody>
489
- <tr>
490
- <td>
491
- <p><code>generate</code></p>
492
- </td>
493
- <td>
494
- <p>Generates content as a side-effect.</p>
495
- </td>
496
- </tr>
497
- </tbody>
498
- </table>
499
- </div>
500
-
501
- <h2 id="converters">Converters</h2>
502
-
503
- <p>If you have a new markup language you’d like to use with your site, you can
504
- include it by implementing your own converter. Both the Markdown and
505
- <a href="https://github.com/jekyll/jekyll-textile-converter">Textile</a> markup
506
- languages are implemented using this method.</p>
507
-
508
- <div class="note info">
509
- <h5>Remember your YAML Front Matter</h5>
510
- <p>
511
- Jekyll will only convert files that have a YAML header at the top, even for
512
- converters you add using a plugin.
513
- </p>
514
- </div>
515
-
516
- <p>Below is a converter that will take all posts ending in <code class="language-plaintext highlighter-rouge">.upcase</code> and process
517
- them using the <code class="language-plaintext highlighter-rouge">UpcaseConverter</code>:</p>
518
-
519
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
520
- <span class="k">class</span> <span class="nc">UpcaseConverter</span> <span class="o">&lt;</span> <span class="no">Converter</span>
521
- <span class="n">safe</span> <span class="kp">true</span>
522
- <span class="n">priority</span> <span class="ss">:low</span>
523
-
524
- <span class="k">def</span> <span class="nf">matches</span><span class="p">(</span><span class="n">ext</span><span class="p">)</span>
525
- <span class="n">ext</span> <span class="o">=~</span> <span class="sr">/^\.upcase$/i</span>
526
- <span class="k">end</span>
527
-
528
- <span class="k">def</span> <span class="nf">output_ext</span><span class="p">(</span><span class="n">ext</span><span class="p">)</span>
529
- <span class="s2">".html"</span>
530
- <span class="k">end</span>
531
-
532
- <span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
533
- <span class="n">content</span><span class="p">.</span><span class="nf">upcase</span>
534
- <span class="k">end</span>
535
- <span class="k">end</span>
536
- <span class="k">end</span>
537
- </code></pre></div></div>
538
-
539
- <p>Converters should implement at a minimum 3 methods:</p>
540
-
541
- <div class="mobile-side-scroller">
542
- <table>
543
- <thead>
544
- <tr>
545
- <th>Method</th>
546
- <th>Description</th>
547
- </tr>
548
- </thead>
549
- <tbody>
550
- <tr>
551
- <td>
552
- <p><code>matches</code></p>
553
- </td>
554
- <td><p>
555
- Does the given extension match this converter’s list of acceptable
556
- extensions? Takes one argument: the file’s extension (including the
557
- dot). Must return <code>true</code> if it matches, <code>false</code>
558
- otherwise.
559
- </p></td>
560
- </tr>
561
- <tr>
562
- <td>
563
- <p><code>output_ext</code></p>
564
- </td>
565
- <td><p>
566
- The extension to be given to the output file (including the dot).
567
- Usually this will be <code>".html"</code>.
568
- </p></td>
569
- </tr>
570
- <tr>
571
- <td>
572
- <p><code>convert</code></p>
573
- </td>
574
- <td><p>
575
- Logic to do the content conversion. Takes one argument: the raw content
576
- of the file (without YAML Front Matter). Must return a String.
577
- </p></td>
578
- </tr>
579
- </tbody>
580
- </table>
581
- </div>
582
-
583
- <p>In our example, <code class="language-plaintext highlighter-rouge">UpcaseConverter#matches</code> checks if our filename extension is
584
- <code class="language-plaintext highlighter-rouge">.upcase</code>, and will render using the converter if it is. It will call
585
- <code class="language-plaintext highlighter-rouge">UpcaseConverter#convert</code> to process the content. In our simple converter we’re
586
- simply uppercasing the entire content string. Finally, when it saves the page,
587
- it will do so with a <code class="language-plaintext highlighter-rouge">.html</code> extension.</p>
588
-
589
- <h2 id="commands">Commands</h2>
590
-
591
- <p>As of version 2.5.0, Jekyll can be extended with plugins which provide
592
- subcommands for the <code class="language-plaintext highlighter-rouge">jekyll</code> executable. This is possible by including the
593
- relevant plugins in a <code class="language-plaintext highlighter-rouge">Gemfile</code> group called <code class="language-plaintext highlighter-rouge">:jekyll_plugins</code>:</p>
594
-
595
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">group</span> <span class="ss">:jekyll_plugins</span> <span class="k">do</span>
596
- <span class="n">gem</span> <span class="s2">"my_fancy_jekyll_plugin"</span>
597
- <span class="k">end</span>
598
- </code></pre></div></div>
599
-
600
- <p>Each <code class="language-plaintext highlighter-rouge">Command</code> must be a subclass of the <code class="language-plaintext highlighter-rouge">Jekyll::Command</code> class and must
601
- contain one class method: <code class="language-plaintext highlighter-rouge">init_with_program</code>. An example:</p>
602
-
603
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">MyNewCommand</span> <span class="o">&lt;</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Command</span>
604
- <span class="k">class</span> <span class="o">&lt;&lt;</span> <span class="nb">self</span>
605
- <span class="k">def</span> <span class="nf">init_with_program</span><span class="p">(</span><span class="n">prog</span><span class="p">)</span>
606
- <span class="n">prog</span><span class="p">.</span><span class="nf">command</span><span class="p">(</span><span class="ss">:new</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
607
- <span class="n">c</span><span class="p">.</span><span class="nf">syntax</span> <span class="s2">"new [options]"</span>
608
- <span class="n">c</span><span class="p">.</span><span class="nf">description</span> <span class="s1">'Create a new Jekyll site.'</span>
609
-
610
- <span class="n">c</span><span class="p">.</span><span class="nf">option</span> <span class="s1">'dest'</span><span class="p">,</span> <span class="s1">'-d DEST'</span><span class="p">,</span> <span class="s1">'Where the site should go.'</span>
611
-
612
- <span class="n">c</span><span class="p">.</span><span class="nf">action</span> <span class="k">do</span> <span class="o">|</span><span class="n">args</span><span class="p">,</span> <span class="n">options</span><span class="o">|</span>
613
- <span class="no">Jekyll</span><span class="o">::</span><span class="no">Site</span><span class="p">.</span><span class="nf">new_site_at</span><span class="p">(</span><span class="n">options</span><span class="p">[</span><span class="s1">'dest'</span><span class="p">])</span>
614
- <span class="k">end</span>
615
- <span class="k">end</span>
616
- <span class="k">end</span>
617
- <span class="k">end</span>
618
- <span class="k">end</span>
619
- </code></pre></div></div>
620
-
621
- <p>Commands should implement this single class method:</p>
622
-
623
- <div class="mobile-side-scroller">
624
- <table>
625
- <thead>
626
- <tr>
627
- <th>Method</th>
628
- <th>Description</th>
629
- </tr>
630
- </thead>
631
- <tbody>
632
- <tr>
633
- <td>
634
- <p><code>init_with_program</code></p>
635
- </td>
636
- <td><p>
637
- This method accepts one parameter, the
638
- <code><a href="https://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
639
- instance, which is the Jekyll program itself. Upon the program,
640
- commands may be created using the above syntax. For more details,
641
- visit the Mercenary repository on GitHub.com.
642
- </p></td>
643
- </tr>
644
- </tbody>
645
- </table>
646
- </div>
647
-
648
- <h2 id="tags">Tags</h2>
649
-
650
- <p>If you’d like to include custom liquid tags in your site, you can do so by
651
- hooking into the tagging system. Built-in examples added by Jekyll include the
652
- <code class="language-plaintext highlighter-rouge">highlight</code> and <code class="language-plaintext highlighter-rouge">include</code> tags. Below is an example of a custom liquid tag that
653
- will output the time the page was rendered:</p>
654
-
655
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
656
- <span class="k">class</span> <span class="nc">RenderTimeTag</span> <span class="o">&lt;</span> <span class="no">Liquid</span><span class="o">::</span><span class="no">Tag</span>
657
-
658
- <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">tag_name</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">tokens</span><span class="p">)</span>
659
- <span class="k">super</span>
660
- <span class="vi">@text</span> <span class="o">=</span> <span class="n">text</span>
661
- <span class="k">end</span>
662
-
663
- <span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
664
- <span class="s2">"</span><span class="si">#{</span><span class="vi">@text</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="no">Time</span><span class="p">.</span><span class="nf">now</span><span class="si">}</span><span class="s2">"</span>
665
- <span class="k">end</span>
666
- <span class="k">end</span>
667
- <span class="k">end</span>
668
-
669
- <span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTag</span><span class="p">)</span>
670
- </code></pre></div></div>
671
-
672
- <p>At a minimum, liquid tags must implement:</p>
673
-
674
- <div class="mobile-side-scroller">
675
- <table>
676
- <thead>
677
- <tr>
678
- <th>Method</th>
679
- <th>Description</th>
680
- </tr>
681
- </thead>
682
- <tbody>
683
- <tr>
684
- <td>
685
- <p><code>render</code></p>
686
- </td>
687
- <td>
688
- <p>Outputs the content of the tag.</p>
689
- </td>
690
- </tr>
691
- </tbody>
692
- </table>
693
- </div>
694
-
695
- <p>You must also register the custom tag with the Liquid template engine as
696
- follows:</p>
697
-
698
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTag</span><span class="p">)</span>
699
- </code></pre></div></div>
700
-
701
- <p>In the example above, we can place the following tag anywhere in one of our
702
- pages:</p>
703
-
704
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="o">&lt;</span><span class="nb">p</span><span class="o">&gt;</span><span class="p">{</span><span class="sx">% render_time </span><span class="n">page</span> <span class="n">rendered</span> <span class="ss">at: </span><span class="sx">%}&lt;/p&gt;
705
- </span></code></pre></div></div>
706
-
707
- <p>And we would get something like this on the page:</p>
708
-
709
- <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;p&gt;</span>page rendered at: Tue June 22 23:38:47 –0500 2010<span class="nt">&lt;/p&gt;</span>
710
- </code></pre></div></div>
711
-
712
- <h3 id="liquid-filters">Liquid filters</h3>
713
-
714
- <p>You can add your own filters to the Liquid template system much like you can
715
- add tags above. Filters are simply modules that export their methods to liquid.
716
- All methods will have to take at least one parameter which represents the input
717
- of the filter. The return value will be the output of the filter.</p>
718
-
719
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
720
- <span class="k">module</span> <span class="nn">AssetFilter</span>
721
- <span class="k">def</span> <span class="nf">asset_url</span><span class="p">(</span><span class="n">input</span><span class="p">)</span>
722
- <span class="s2">"http://www.example.com/</span><span class="si">#{</span><span class="n">input</span><span class="si">}</span><span class="s2">?</span><span class="si">#{</span><span class="no">Time</span><span class="p">.</span><span class="nf">now</span><span class="p">.</span><span class="nf">to_i</span><span class="si">}</span><span class="s2">"</span>
723
- <span class="k">end</span>
724
- <span class="k">end</span>
725
- <span class="k">end</span>
726
-
727
- <span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_filter</span><span class="p">(</span><span class="no">Jekyll</span><span class="o">::</span><span class="no">AssetFilter</span><span class="p">)</span>
728
- </code></pre></div></div>
729
-
730
- <div class="note">
731
- <h5>ProTip™: Access the site object using Liquid</h5>
732
- <p>
733
- Jekyll lets you access the <code>site</code> object through the
734
- <code>context.registers</code> feature of Liquid at <code>context.registers[:site]</code>. For example, you can
735
- access the global configuration file <code>_config.yml</code> using
736
- <code>context.registers[:site].config</code>.
737
- </p>
738
- </div>
739
-
740
- <h3 id="flags">Flags</h3>
741
-
742
- <p>There are two flags to be aware of when writing a plugin:</p>
743
-
744
- <div class="mobile-side-scroller">
745
- <table>
746
- <thead>
747
- <tr>
748
- <th>Flag</th>
749
- <th>Description</th>
750
- </tr>
751
- </thead>
752
- <tbody>
753
- <tr>
754
- <td>
755
- <p><code>safe</code></p>
756
- </td>
757
- <td>
758
- <p>
759
- A boolean flag that informs Jekyll whether this plugin may be safely
760
- executed in an environment where arbitrary code execution is not
761
- allowed. This is used by GitHub Pages to determine which core plugins
762
- may be used, and which are unsafe to run. If your plugin does not
763
- allow for arbitrary code execution, set this to <code>true</code>.
764
- GitHub Pages still won’t load your plugin, but if you submit it for
765
- inclusion in core, it’s best for this to be correct!
766
- </p>
767
- </td>
768
- </tr>
769
- <tr>
770
- <td>
771
- <p><code>priority</code></p>
772
- </td>
773
- <td>
774
- <p>
775
- This flag determines what order the plugin is loaded in. Valid values
776
- are: <code>:lowest</code>, <code>:low</code>, <code>:normal</code>,
777
- <code>:high</code>, and <code>:highest</code>. Highest priority
778
- matches are applied first, lowest priority are applied last.
779
- </p>
780
- </td>
781
- </tr>
782
- </tbody>
783
- </table>
784
- </div>
785
-
786
- <p>To use one of the example plugins above as an illustration, here is how you’d
787
- specify these two flags:</p>
788
-
789
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
790
- <span class="k">class</span> <span class="nc">UpcaseConverter</span> <span class="o">&lt;</span> <span class="no">Converter</span>
791
- <span class="n">safe</span> <span class="kp">true</span>
792
- <span class="n">priority</span> <span class="ss">:low</span>
793
- <span class="o">...</span>
794
- <span class="k">end</span>
795
- <span class="k">end</span>
796
- </code></pre></div></div>
797
-
798
- <h2 id="hooks">Hooks</h2>
799
-
800
- <p>Using hooks, your plugin can exercise fine-grained control over various aspects
801
- of the build process. If your plugin defines any hooks, Jekyll will call them
802
- at pre-defined points.</p>
803
-
804
- <p>Hooks are registered to a container and an event name. To register one, you
805
- call Jekyll::Hooks.register, and pass the container, event name, and code to
806
- call whenever the hook is triggered. For example, if you want to execute some
807
- custom functionality every time Jekyll renders a post, you could register a
808
- hook like this:</p>
809
-
810
- <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="no">Jekyll</span><span class="o">::</span><span class="no">Hooks</span><span class="p">.</span><span class="nf">register</span> <span class="ss">:posts</span><span class="p">,</span> <span class="ss">:post_render</span> <span class="k">do</span> <span class="o">|</span><span class="n">post</span><span class="o">|</span>
811
- <span class="c1"># code to call after Jekyll renders a post</span>
812
- <span class="k">end</span>
813
- </code></pre></div></div>
814
-
815
- <p>Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
816
- <code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
817
- your hooks with the container object as the first callback parameter. However,
818
- all <code class="language-plaintext highlighter-rouge">:pre_render</code> hooks and the<code class="language-plaintext highlighter-rouge">:site, :post_render</code> hook will also provide a
819
- payload hash as a second parameter. In the case of <code class="language-plaintext highlighter-rouge">:pre_render</code>, the payload
820
- gives you full control over the variables that are available while rendering.
821
- In the case of <code class="language-plaintext highlighter-rouge">:site, :post_render</code>, the payload contains final values after
822
- rendering all the site (useful for sitemaps, feeds, etc).</p>
823
-
824
- <p>The complete list of available hooks is below:</p>
825
-
826
- <div class="mobile-side-scroller">
827
- <table>
828
- <thead>
829
- <tr>
830
- <th>Container</th>
831
- <th>Event</th>
832
- <th>Called</th>
833
- </tr>
834
- </thead>
835
- <tbody>
836
- <tr>
837
- <td>
838
- <p><code>:site</code></p>
839
- </td>
840
- <td>
841
- <p><code>:after_init</code></p>
842
- </td>
843
- <td>
844
- <p>Just after the site initializes, but before setup &amp; render. Good
845
- for modifying the configuration of the site.</p>
846
- </td>
847
- </tr>
848
- <tr>
849
- <td>
850
- <p><code>:site</code></p>
851
- </td>
852
- <td>
853
- <p><code>:after_reset</code></p>
854
- </td>
855
- <td>
856
- <p>Just after site reset</p>
857
- </td>
858
- </tr>
859
- <tr>
860
- <td>
861
- <p><code>:site</code></p>
862
- </td>
863
- <td>
864
- <p><code>:post_read</code></p>
865
- </td>
866
- <td>
867
- <p>After site data has been read and loaded from disk</p>
868
- </td>
869
- </tr>
870
- <tr>
871
- <td>
872
- <p><code>:site</code></p>
873
- </td>
874
- <td>
875
- <p><code>:pre_render</code></p>
876
- </td>
877
- <td>
878
- <p>Just before rendering the whole site</p>
879
- </td>
880
- </tr>
881
- <tr>
882
- <td>
883
- <p><code>:site</code></p>
884
- </td>
885
- <td>
886
- <p><code>:post_render</code></p>
887
- </td>
888
- <td>
889
- <p>After rendering the whole site, but before writing any files</p>
890
- </td>
891
- </tr>
892
- <tr>
893
- <td>
894
- <p><code>:site</code></p>
895
- </td>
896
- <td>
897
- <p><code>:post_write</code></p>
898
- </td>
899
- <td>
900
- <p>After writing the whole site to disk</p>
901
- </td>
902
- </tr>
903
- <tr>
904
- <td>
905
- <p><code>:pages</code></p>
906
- </td>
907
- <td>
908
- <p><code>:post_init</code></p>
909
- </td>
910
- <td>
911
- <p>Whenever a page is initialized</p>
912
- </td>
913
- </tr>
914
- <tr>
915
- <td>
916
- <p><code>:pages</code></p>
917
- </td>
918
- <td>
919
- <p><code>:pre_render</code></p>
920
- </td>
921
- <td>
922
- <p>Just before rendering a page</p>
923
- </td>
924
- </tr>
925
- <tr>
926
- <td>
927
- <p><code>:pages</code></p>
928
- </td>
929
- <td>
930
- <p><code>:post_render</code></p>
931
- </td>
932
- <td>
933
- <p>After rendering a page, but before writing it to disk</p>
934
- </td>
935
- </tr>
936
- <tr>
937
- <td>
938
- <p><code>:pages</code></p>
939
- </td>
940
- <td>
941
- <p><code>:post_write</code></p>
942
- </td>
943
- <td>
944
- <p>After writing a page to disk</p>
945
- </td>
946
- </tr>
947
- <tr>
948
- <td>
949
- <p><code>:posts</code></p>
950
- </td>
951
- <td>
952
- <p><code>:post_init</code></p>
953
- </td>
954
- <td>
955
- <p>Whenever a post is initialized</p>
956
- </td>
957
- </tr>
958
- <tr>
959
- <td>
960
- <p><code>:posts</code></p>
961
- </td>
962
- <td>
963
- <p><code>:pre_render</code></p>
964
- </td>
965
- <td>
966
- <p>Just before rendering a post</p>
967
- </td>
968
- </tr>
969
- <tr>
970
- <td>
971
- <p><code>:posts</code></p>
972
- </td>
973
- <td>
974
- <p><code>:post_render</code></p>
975
- </td>
976
- <td>
977
- <p>After rendering a post, but before writing it to disk</p>
978
- </td>
979
- </tr>
980
- <tr>
981
- <td>
982
- <p><code>:posts</code></p>
983
- </td>
984
- <td>
985
- <p><code>:post_write</code></p>
986
- </td>
987
- <td>
988
- <p>After writing a post to disk</p>
989
- </td>
990
- </tr>
991
- <tr>
992
- <td>
993
- <p><code>:documents</code></p>
994
- </td>
995
- <td>
996
- <p><code>:post_init</code></p>
997
- </td>
998
- <td>
999
- <p>Whenever a document is initialized</p>
1000
- </td>
1001
- </tr>
1002
- <tr>
1003
- <td>
1004
- <p><code>:documents</code></p>
1005
- </td>
1006
- <td>
1007
- <p><code>:pre_render</code></p>
1008
- </td>
1009
- <td>
1010
- <p>Just before rendering a document</p>
1011
- </td>
1012
- </tr>
1013
- <tr>
1014
- <td>
1015
- <p><code>:documents</code></p>
1016
- </td>
1017
- <td>
1018
- <p><code>:post_render</code></p>
1019
- </td>
1020
- <td>
1021
- <p>After rendering a document, but before writing it to disk</p>
1022
- </td>
1023
- </tr>
1024
- <tr>
1025
- <td>
1026
- <p><code>:documents</code></p>
1027
- </td>
1028
- <td>
1029
- <p><code>:post_write</code></p>
1030
- </td>
1031
- <td>
1032
- <p>After writing a document to disk</p>
1033
- </td>
1034
- </tr>
1035
- </tbody>
1036
- </table>
1037
- </div>
1038
-
1039
- <h2 id="available-plugins">Available Plugins</h2>
1040
-
1041
- <p>You can find a few useful plugins at the following locations:</p>
1042
-
1043
- <h4 id="generators-1">Generators</h4>
1044
-
1045
- <ul>
1046
- <li>
1047
- <a href="https://github.com/kinnetica/jekyll-plugins">Sitemap.xml Generator by Michael Levin</a>: Generates a sitemap.xml file by traversing all of the available posts and pages.</li>
1048
- <li>
1049
- <a href="https://github.com/PascalW/jekyll_indextank">Full-text search by Pascal Widdershoven</a>: Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.</li>
1050
- <li>
1051
- <a href="https://github.com/tsmango/jekyll_alias_generator">AliasGenerator by Thomas Mango</a>: Generates redirect pages for posts when an alias is specified in the YAML Front Matter.</li>
1052
- <li>
1053
- <a href="https://github.com/nquinlan/jekyll-pageless-redirects">Pageless Redirect Generator by Nick Quinlan</a>: Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.</li>
1054
- <li>
1055
- <a href="https://github.com/agelber/jekyll-rss">RssGenerator by Assaf Gelber</a>: Automatically creates an RSS 2.0 feed from your posts.</li>
1056
- <li>
1057
- <a href="https://github.com/shigeya/jekyll-monthly-archive-plugin">Monthly archive generator by Shigeya Suzuki</a>: Generator and template which renders monthly archive like MovableType style, based on the work by Ilkka Laukkanen and others above.</li>
1058
- <li>
1059
- <a href="https://github.com/shigeya/jekyll-category-archive-plugin">Category archive generator by Shigeya Suzuki</a>: Generator and template which renders category archive like MovableType style, based on Monthly archive generator.</li>
1060
- <li>
1061
- <a href="https://github.com/yihangho/emoji-for-jekyll">Emoji for Jekyll</a>: Seamlessly enable emoji for all posts and pages.</li>
1062
- <li>
1063
- <a href="https://github.com/mscharley/jekyll-compass">Compass integration for Jekyll</a>: Easily integrate Compass and Sass with your Jekyll website.</li>
1064
- <li>
1065
- <a href="https://github.com/bbakersmith/jekyll-pages-directory">Pages Directory by Ben Baker-Smith</a>: Defines a <code class="language-plaintext highlighter-rouge">_pages</code> directory for page files which routes its output relative to the project root.</li>
1066
- <li>
1067
- <a href="https://github.com/jeffkole/jekyll-page-collections">Page Collections by Jeff Kolesky</a>: Generates collections of pages with functionality that resembles posts.</li>
1068
- <li>
1069
- <a href="https://github.com/sheehamj13/jekyll-live-tiles">Windows 8.1 Live Tile Generation by Matt Sheehan</a>: Generates Internet Explorer 11 config.xml file and Tile Templates for pinning your site to Windows 8.1.</li>
1070
- <li>
1071
- <a href="https://github.com/sheehamj13/jekyll_ts">Typescript Generator by Matt Sheehan</a>: Generate Javascript on build from your Typescript.</li>
1072
- <li>
1073
- <a href="https://github.com/ivantsepp/jekyll-autolink_email">Jekyll::AutolinkEmail by Ivan Tse</a>: Autolink your emails.</li>
1074
- <li>
1075
- <a href="https://github.com/ivantsepp/jekyll-git_metadata">Jekyll::GitMetadata by Ivan Tse</a>: Expose Git metadata for your templates.</li>
1076
- <li>
1077
- <a href="https://github.com/merlos/jekyll-auto-image">Jekyll Auto Image by Merlos</a>: Gets the first image of a post. Useful to list your posts with images or to add <a href="https://dev.twitter.com/cards/overview">twitter cards</a> to your site.</li>
1078
- <li>
1079
- <a href="https://github.com/codeinpink/jekyll-portfolio-generator">Jekyll Portfolio Generator by Shannon Babincsak</a>: Generates project pages and computes related projects out of project data files.</li>
1080
- <li>
1081
- <a href="https://github.com/webchef/jekyll-umlauts">Jekyll-Umlauts by Arne Gockeln</a>: This generator replaces all german umlauts (äöüß) case sensitive with html.</li>
1082
- <li>
1083
- <a href="https://github.com/lawmurray/indii-jekyll-flickr">Jekyll Flickr Plugin</a> by <a href="http://www.indii.org">Lawrence Murray</a>: Generates posts for photos uploaded to a Flickr photostream.</li>
1084
- <li>
1085
- <a href="https://github.com/midnightSuyama/jekyll-paginate-category">Jekyll::Paginate::Category</a>: Pagination Generator for Jekyll Category.</li>
1086
- <li>
1087
- <a href="https://github.com/juusaw/amp-jekyll">AMP-Jekyll by Juuso Mikkonen</a>: Generate <a href="https://www.ampproject.org">Accelerated Mobile Pages</a> of Jekyll posts.</li>
1088
- <li>
1089
- <a href="https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin">Jekyll Art Gallery plugin</a>: An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.</li>
1090
- <li>
1091
- <a href="https://github.com/developmentseed/jekyll-ga">jekyll-ga</a>: A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists “most popular” content. <a href="https://developmentseed.org/blog/google-analytics-jekyll-plugin/">Read the introduction</a> post on the developmentSEED blog.</li>
1092
- <li>
1093
- <a href="https://github.com/fadhilnapis/jekyll-multi-paginate">jekyll-multi-paginate</a>: Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.</li>
1094
- <li>
1095
- <a href="https://github.com/field-theory/jekyll-category-pages">jekyll-category-pages</a>: Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.</li>
1096
- <li>
1097
- <a href="https://github.com/ibrado/jekyll-tweetsert">Tweetsert</a>: Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.</li>
1098
- <li>
1099
- <a href="https://github.com/ibrado/jekyll-stickyposts">Stickyposts</a>: Moves or copies (pins) posts marked <code class="language-plaintext highlighter-rouge">sticky: true</code> to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.</li>
1100
- <li>
1101
- <a href="https://github.com/ibrado/jekyll-paginate-content">Jekyll::Paginate::Content</a>: Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML &lt;h1&gt; etc. headers. Automatic splitting, single-page view, pager/trail, self-adjusting links, multipage TOC, SEO support.</li>
1102
- <li>
1103
- <a href="https://github.com/amedia/premonition">Premonition</a>: Adds block-styled side content to your page. For example summary, notes, hints or warning boxes.</li>
1104
- <li>
1105
- <a href="https://github.com/ericcornelissen/jekyll-fontello">jekyll-fontello</a>: A Jekyll plugin that automatically downloads your webfont from Fontello.</li>
1106
- </ul>
1107
-
1108
- <h4 id="converters-1">Converters</h4>
1109
-
1110
- <ul>
1111
- <li>
1112
- <a href="http://jekyll-pug.dougie.io">Pug plugin by Doug Beney</a>: Use the popular Pug (previously Jade) templating language in Jekyll. Complete with caching, includes support, and much more.</li>
1113
- <li>
1114
- <a href="https://github.com/jekyll/jekyll-textile-converter">Textile converter</a>: Convert <code class="language-plaintext highlighter-rouge">.textile</code> files into HTML. Also includes the <code class="language-plaintext highlighter-rouge">textilize</code> Liquid filter.</li>
1115
- <li>
1116
- <a href="https://github.com/slim-template/jekyll-slim">Slim plugin</a>: Slim converter and includes for Jekyll with support for Liquid tags.</li>
1117
- <li>
1118
- <a href="https://github.com/olov/jekyll-references">Markdown References by Olov Lassus</a>: Keep all your markdown reference-style link definitions in one _references.md file.</li>
1119
- <li>
1120
- <a href="https://github.com/xdissent/jekyll-rst">ReStructuredText Converter</a>: Converts ReST documents to HTML with Pygments syntax highlighting.</li>
1121
- <li>
1122
- <a href="https://github.com/fauno/jekyll-pandoc-multiple-formats">Jekyll-pandoc-multiple-formats</a> by <a href="https://github.com/edsl">edsl</a>: Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.</li>
1123
- <li>
1124
- <a href="https://github.com/mvdbos/kramdown-with-pygments">Customized Kramdown Converter</a>: Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.</li>
1125
- <li>
1126
- <a href="https://github.com/TheFox/jekyll-bigfootnotes">Bigfootnotes Plugin</a>: Enables big footnotes for Kramdown.</li>
1127
- <li>
1128
- <a href="https://github.com/asciidoctor/jekyll-asciidoc">AsciiDoc Plugin</a>: AsciiDoc convertor for Jekyll using <a href="http://asciidoctor.org/">Asciidoctor</a>.</li>
1129
- <li>
1130
- <a href="https://github.com/takuti/jekyll-lazy-tweet-embedding">Lazy Tweet Embedding</a>: Automatically convert tweet urls into twitter cards.</li>
1131
- <li>
1132
- <a href="https://github.com/pathawks/jekyll-commonmark">jekyll-commonmark</a>: Markdown converter that uses <a href="https://github.com/jgm/CommonMark">libcmark</a>, the reference parser for CommonMark.</li>
1133
- </ul>
1134
-
1135
- <h4 id="filters">Filters</h4>
1136
-
1137
- <ul>
1138
- <li>
1139
- <a href="https://github.com/MattHall/truncatehtml">Truncate HTML</a> by <a href="https://codebeef.com/">Matt Hall</a>: A Jekyll filter that truncates HTML while preserving markup structure.</li>
1140
- <li>
1141
- <a href="https://github.com/LawrenceWoodman/domain_name-liquid_filter">Domain Name Filter by Lawrence Woodman</a>: Filters the input text so that just the domain name is left.</li>
1142
- <li>
1143
- <a href="https://github.com/SaswatPadhi/jekyll_smilify">Smilify</a> by <a href="https://github.com/SaswatPadhi">SaswatPadhi</a>: Convert text emoticons in your content to themeable smiley pics.</li>
1144
- <li>
1145
- <a href="https://github.com/markets/jekyll-timeago">Jekyll-timeago</a>: Converts a time value to the time ago in words.</li>
1146
- <li>
1147
- <a href="https://github.com/bdesham/pluralize">pluralize</a>: Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minute<strong>s</strong>”.</li>
1148
- <li>
1149
- <a href="https://github.com/bdesham/reading_time">reading_time</a>: Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.</li>
1150
- <li>
1151
- <a href="https://github.com/dafi/jekyll-toc-generator">Table of Content Generator</a>: Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.</li>
1152
- <li>
1153
- <a href="https://github.com/toshimaru/jekyll-toc">jekyll-toc</a>: A liquid filter plugin for Jekyll which generates a table of contents.</li>
1154
- <li>
1155
- <a href="https://github.com/23maverick23/jekyll-humanize">jekyll-humanize</a>: This is a port of the Django app humanize which adds a “human touch” to data. Each method represents a Fluid type filter that can be used in your Jekyll site templates. Given that Jekyll produces static sites, some of the original methods do not make logical sense to port (e.g. naturaltime).</li>
1156
- <li>
1157
- <a href="https://github.com/PatrickC8t/Jekyll-Ordinal">Jekyll-Ordinal</a>: Jekyll liquid filter to output a date ordinal such as “st”, “nd”, “rd”, or “th”.</li>
1158
- <li>
1159
- <a href="https://github.com/kzykbys/JekyllPlugins">Deprecated articles keeper</a> by <a href="http://blog.kazuya.co/">Kazuya Kobayashi</a>: A simple Jekyll filter which monitor how old an article is.</li>
1160
- <li>
1161
- <a href="https://github.com/mehdisadeghi/jekyll-jalali">Jekyll-jalali</a> by <a href="http://mehdix.ir">Mehdi Sadeghi</a>: A simple Gregorian to Jalali date converter filter.</li>
1162
- <li>
1163
- <a href="https://github.com/matallo/jekyll-thumbnail-filter">Jekyll Thumbnail Filter</a>: Related posts thumbnail filter.</li>
1164
- <li>
1165
- <a href="https://github.com/pathawks/liquid-md5">liquid-md5</a>: Returns an MD5 hash. Helpful for generating Gravatars in templates.</li>
1166
- <li>
1167
- <a href="https://github.com/paulrobertlloyd/jekyll-roman">jekyll-roman</a>: A liquid filter for Jekyll that converts numbers into Roman numerals.</li>
1168
- <li>
1169
- <a href="https://github.com/myles/jekyll-typogrify">jekyll-typogrify</a>: A Jekyll plugin that brings the functions of <a href="http://avdgaag.github.io/typogruby/">typogruby</a>.</li>
1170
- <li>
1171
- <a href="https://github.com/vwochnik/jekyll-email-protect">Jekyll Email Protect</a>: Email protection liquid filter for Jekyll</li>
1172
- <li>
1173
- <a href="https://github.com/mattg/jekyll-uglify-filter">Jekyll Uglify Filter</a>: A Liquid filter that runs your JavaScript through UglifyJS.</li>
1174
- <li>
1175
- <a href="https://github.com/sparanoid/match_regex">match_regex</a>: A Liquid filter to perform regex match.</li>
1176
- <li>
1177
- <a href="https://github.com/sparanoid/replace_regex">replace_regex</a>: A Liquid filter to perform regex replace.</li>
1178
- <li>
1179
- <a href="https://rubygems.org/gems/jekyll-money">Jekyll Money</a>: A Jekyll plugin for dealing with money. Because we all have to at some point.</li>
1180
- <li>
1181
- <a href="https://github.com/codecalm/jekyll-random">jekyll-random</a> by <a href="https://nodecalm.net">codecalm</a>: A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data.</li>
1182
- </ul>
1183
-
1184
- <h4 id="tags-1">Tags</h4>
1185
-
1186
- <p>You can find a few useful plugins at the following locations:</p>
1187
-
1188
- <ul>
1189
- <li>
1190
- <a href="https://github.com/jekyll/jekyll-gist">Jekyll-gist</a>: Use the <code class="language-plaintext highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.</li>
1191
- <li>
1192
- <a href="https://github.com/samrayner/jekyll-asset-path-plugin">Asset Path Tag</a> by <a href="http://www.samrayner.com/">Sam Rayner</a>: Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.</li>
1193
- <li>
1194
- <a href="https://github.com/christianhellsten/jekyll-plugins">Delicious Plugin by Christian Hellsten</a>: Fetches and renders bookmarks from delicious.com.</li>
1195
- <li>
1196
- <a href="https://github.com/robb/jekyll-embedly-client">Embed.ly client by Robert Böhnke</a>: Autogenerate embeds from URLs using oEmbed.</li>
1197
- <li>
1198
- <a href="https://github.com/tsmango/jekyll_flickr_set_tag">FlickrSetTag by Thomas Mango</a>: Generates image galleries from Flickr sets.</li>
1199
- <li>
1200
- <a href="https://github.com/scottwb/jekyll-tweet-tag">Tweet Tag by Scott W. Bradley</a>: Liquid tag for <a href="https://dev.twitter.com/docs/embedded-tweets">Embedded Tweets</a> using Twitter’s shortcodes.</li>
1201
- <li>
1202
- <a href="https://github.com/rob-murray/jekyll-twitter-plugin">Jekyll Twitter Plugin</a>: A Liquid tag plugin that renders Tweets from Twitter API. Currently supports the <a href="https://dev.twitter.com/rest/reference/get/statuses/oembed">oEmbed</a> API.</li>
1203
- <li>
1204
- <a href="https://github.com/rustygeldmacher/jekyll-contentblocks">Jekyll-contentblocks</a>: Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.</li>
1205
- <li>
1206
- <a href="https://github.com/okeeblow/jekyll-beastiepress">Jekyll-beastiepress</a>: FreeBSD utility tags for Jekyll sites.</li>
1207
- <li>
1208
- <a href="https://github.com/pablooliveira/bibjekyll">Bibjekyll</a>: Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.</li>
1209
- <li>
1210
- <a href="https://github.com/archome/jekyll-citation">Jekyll-citation</a>: Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).</li>
1211
- <li>
1212
- <a href="https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag">Jekyll Dribbble Set Tag</a>: Builds Dribbble image galleries from any user.</li>
1213
- <li>
1214
- <a href="https://github.com/redwallhp/JekyllGalleryTag">JekyllGalleryTag</a> by <a href="https://github.com/redwallhp">redwallhp</a>: Generates thumbnails from a directory of images and displays them in a grid.</li>
1215
- <li>
1216
- <a href="https://github.com/sectore/jekyll-swfobject">Jekyll-swfobject</a>: Liquid plugin for embedding Adobe Flash files (.swf) using <a href="https://github.com/swfobject/swfobject">SWFObject</a>.</li>
1217
- <li>
1218
- <a href="https://github.com/robwierzbowski/jekyll-picture-tag">Jekyll Picture Tag</a>: Easy responsive images for Jekyll. Based on the proposed <a href="https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element"><code class="language-plaintext highlighter-rouge">&lt;picture&gt;</code></a> element, polyfilled with Scott Jehl’s <a href="https://github.com/scottjehl/picturefill">Picturefill</a>.</li>
1219
- <li>
1220
- <a href="https://github.com/robwierzbowski/jekyll-image-tag">Jekyll Image Tag</a>: Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.</li>
1221
- <li>
1222
- <a href="https://github.com/wildlyinaccurate/jekyll-responsive-image">Jekyll Responsive Image</a>: Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (<code class="language-plaintext highlighter-rouge">&lt;picture&gt;</code>, <code class="language-plaintext highlighter-rouge">srcset</code>, Imager.js, etc), super-flexible configuration.</li>
1223
- <li>
1224
- <a href="https://github.com/matze/jekyll-ditaa">Ditaa Tag</a> by <a href="https://github.com/matze">matze</a>: Renders ASCII diagram art into PNG images and inserts a figure tag.</li>
1225
- <li>
1226
- <a href="https://github.com/davidensinger/jekyll-suggested-tweet">Jekyll Suggested Tweet</a> by <a href="https://github.com/davidensinger/">David Ensinger</a>: A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitter’s Web Intents API.</li>
1227
- <li>
1228
- <a href="https://github.com/GSI/jekyll_date_chart">Jekyll Date Chart</a> by <a href="https://github.com/GSI">GSI</a>: Block that renders date line charts based on textile-formatted tables.</li>
1229
- <li>
1230
- <a href="https://github.com/GSI/jekyll_image_encode">Jekyll Image Encode</a> by <a href="https://github.com/GSI">GSI</a>: Tag that renders base64 codes of images fetched from the web.</li>
1231
- <li>
1232
- <a href="https://github.com/GSI/jekyll_quick_man">Jekyll Quick Man</a> by <a href="https://github.com/GSI">GSI</a>: Tag that renders pretty links to man page sources on the internet.</li>
1233
- <li>
1234
- <a href="https://github.com/callmeed/jekyll-image-set">Image Set/Gallery Tag</a> by <a href="https://github.com/callmeed">callmeed</a>: Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.</li>
1235
- <li>
1236
- <a href="https://github.com/lmullen/jekyll_figure">jekyll_figure</a>: Generate figures and captions with links to the figure in a variety of formats</li>
1237
- <li>
1238
- <a href="https://github.com/bwillis/jekyll-github-sample">Jekyll GitHub Sample Tag</a>: A liquid tag to include a sample of a github repo file in your Jekyll site.</li>
1239
- <li>
1240
- <a href="https://github.com/rob-murray/jekyll-version-plugin">Jekyll Project Version Tag</a>: A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.</li>
1241
- <li>
1242
- <a href="https://github.com/AlessandroLorenzi/piwigo_gallery">Piwigo Gallery</a> by <a href="http://blog.alorenzi.eu/">Alessandro Lorenzi</a>: Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag</li>
1243
- <li>
1244
- <a href="https://github.com/tmthrgd/jekyll-plugins">mathml.rb</a> by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.</li>
1245
- <li>
1246
- <a href="https://github.com/aarongustafson/jekyll-webmention_io">webmention_io.rb</a> by <a href="http://aaron-gustafson.com/">Aaron Gustafson</a>: A plugin to enable <a href="https://indieweb.org/webmention">webmention</a> integration using <a href="https://webmention.io/">Webmention.io</a>. Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.</li>
1247
- <li>
1248
- <a href="https://github.com/lkorth/jekyll-500px-embed">Jekyll 500px Embed</a> by Luke Korth. A Liquid tag plugin that embeds <a href="https://500px.com/">500px</a> photos.</li>
1249
- <li>
1250
- <a href="https://github.com/bdesham/inline_highlight">inline_highlight</a>: A tag for inline syntax highlighting.</li>
1251
- <li>
1252
- <a href="https://github.com/jasonbellamy/jekyll-mermaid">jekyll-mermaid</a>: Simplify the creation of mermaid diagrams and flowcharts in your posts and pages.</li>
1253
- <li>
1254
- <a href="https://github.com/Ezmyrelda/twa">twa</a>: Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.</li>
1255
- <li>
1256
- <a href="https://github.com/dimitri-koenig/jekyll-plugins">Fetch remote file content</a> by <a href="https://www.dimitrikoenig.net/">Dimitri König</a>: Using <code class="language-plaintext highlighter-rouge">remote_file_content</code> tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo’s to always have a current repo version.</li>
1257
- <li>
1258
- <a href="https://github.com/mnuessler/jekyll-asciinema">jekyll-asciinema</a>: A tag for embedding asciicasts recorded with <a href="https://asciinema.org">asciinema</a> in your Jekyll pages.</li>
1259
- <li>
1260
- <a href="https://github.com/dommmel/jekyll-youtube">Jekyll-Youtube</a> A Liquid tag that embeds Youtube videos. The default emded markup is responsive but you can also specify your own by using an include/partial.</li>
1261
- <li>
1262
- <a href="https://github.com/lawmurray/indii-jekyll-flickr">Jekyll Flickr Plugin</a> by <a href="http://www.indii.org">Lawrence Murray</a>: Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.</li>
1263
- <li>
1264
- <a href="https://github.com/paulrobertlloyd/jekyll-figure">jekyll-figure</a>: A liquid tag for Jekyll that generates <code class="language-plaintext highlighter-rouge">&lt;figure&gt;</code> elements.</li>
1265
- <li>
1266
- <a href="https://github.com/eug/jekyll-video-embed">Jekyll Video Embed</a>: It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)</li>
1267
- <li>
1268
- <a href="https://github.com/KrzysiekJ/jekyll-i18n_tags">jekyll-i18n_tags</a>: Translate your templates.</li>
1269
- <li>
1270
- <a href="https://github.com/jekylltools/jekyll-ideal-image-slider">Jekyll Ideal Image Slider</a>: Liquid tag plugin to create image sliders using <a href="https://github.com/gilbitron/Ideal-Image-Slider">Ideal Image Slider</a>.</li>
1271
- <li>
1272
- <a href="https://github.com/crispgm/jekyll-tags-list-plugin">Jekyll Tags List Plugin</a>: A Liquid tag plugin that creates tags list in specific order.</li>
1273
- <li>
1274
- <a href="https://github.com/ayastreb/jekyll-maps">Jekyll Maps</a> by <a href="https://github.com/ayastreb">Anatoliy Yastreb</a>: A Jekyll plugin to easily embed maps with filterable locations.</li>
1275
- <li>
1276
- <a href="https://nhoizey.github.io/jekyll-cloudinary/">Jekyll Cloudinary</a> by <a href="https://nicolas-hoizey.com/">Nicolas Hoizey</a>: a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.</li>
1277
- <li>
1278
- <a href="https://github.com/tnhu/jekyll-include-absolute-plugin">jekyll-include-absolute-plugin</a> by <a href="https://github.com/tnhu">Tan Nhu</a>: A Jekyll plugin to include a file from its path relative to Jekyll’s source folder.</li>
1279
- <li>
1280
- <a href="https://github.com/mattg/jekyll-download-tag">Jekyll Download Tag</a>: A Liquid tag that acts like <code class="language-plaintext highlighter-rouge">include</code>, but for external resources.</li>
1281
- <li>
1282
- <a href="https://github.com/MediaComem/jekyll-brand-social-wall">Jekyll Brand Social Wall</a>: A jekyll plugin to generate a social wall with your favorite social networks</li>
1283
- <li>
1284
- <a href="https://github.com/k-funk/jekyll-if-file-exists">Jekyll If File Exists</a>: A Jekyll Plugin that checks if a file exists with an if/else block.</li>
1285
- <li>
1286
- <a href="https://github.com/rjoberon/bibsonomy-jekyll">BibSonomy</a>: Jekyll
1287
- plugin to generate publication lists from <a href="https://www.bibsonomy.org/">BibSonomy</a>.</li>
1288
- <li>
1289
- <a href="https://github.com/edward-shen/github-cards">github-cards</a>: Creates styleable Github cards for your Github projects.</li>
1290
- <li>
1291
- <a href="https://github.com/kacperduras/disqus-for-jekyll">disqus-for-jekyll</a>: A Jekyll plugin to view the comments powered by Disqus.</li>
1292
- <li>
1293
- <a href="https://github.com/kacperduras/jekyll-html">jekyll-html</a>: A Jekyll plugin to use HTML tags in Jekyll pages, posts and collections.</li>
1294
- <li>
1295
- <a href="https://github.com/rriemann/jekyll-onebox">jekyll-onebox</a>: Liquid tag for displaying HTML previews (embeds) for links to popular domains. Plugin is based on <a href="https://github.com/discourse/onebox">Onebox</a> that powers link previews in <a href="http://github.com/discourse/discourse">Discourse</a> forums.</li>
1296
- <li>
1297
- <a href="https://github.com/kacperduras/jekyll-w2m">jekyll-w2m</a>: A Jekyll plugin to liberate content from Microsoft Word documents (powered by <a href="https://github.com/benbalter/word-to-markdown">word-to-markdown</a>).</li>
1298
- </ul>
1299
-
1300
- <h4 id="collections">Collections</h4>
1301
-
1302
- <ul>
1303
- <li>
1304
- <a href="https://github.com/recurser/jekyll-plugins">Jekyll Plugins by Recursive Design</a>: Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.</li>
1305
- <li>
1306
- <a href="https://github.com/flatterline/jekyll-plugins">Company website and blog plugins</a> by Flatterline, a Ruby on Rails development company: Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.</li>
1307
- <li>
1308
- <a href="https://github.com/aucor/jekyll-plugins">Jekyll plugins by Aucor</a>: Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.</li>
1309
- </ul>
1310
-
1311
- <h4 id="other">Other</h4>
1312
-
1313
- <ul>
1314
- <li>
1315
- <a href="https://github.com/hendrikschneider/jekyll-analytics">Analytics for Jekyll</a> by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Matomo (formerly Piwik), mPulse, etc. to your site.</li>
1316
- <li>
1317
- <a href="https://github.com/tmthrgd/ditaa-ditaa">ditaa-ditaa</a> by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.</li>
1318
- <li>
1319
- <a href="https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb">Pygments Cache Path by Raimonds Simanovskis</a>: Plugin to cache syntax-highlighted code from Pygments.</li>
1320
- <li>
1321
- <a href="https://github.com/LawrenceWoodman/related_posts-jekyll_plugin">Related Posts by Lawrence Woodman</a>: Overrides <code class="language-plaintext highlighter-rouge">site.related_posts</code> to use categories to assess relationship.</li>
1322
- <li>
1323
- <a href="https://github.com/toshimaru/jekyll-tagging-related_posts">jekyll-tagging-related_posts</a>: Jekyll related_posts function based on tags (works on Jekyll3).</li>
1324
- <li>
1325
- <a href="https://github.com/blackwinter/jekyll-localization">Jekyll-localization</a>: Jekyll plugin that adds localization features to the rendering engine.</li>
1326
- <li>
1327
- <a href="https://github.com/blackwinter/jekyll-rendering">Jekyll-rendering</a>: Jekyll plugin to provide alternative rendering engines.</li>
1328
- <li>
1329
- <a href="https://github.com/blackwinter/jekyll-pagination">Jekyll-pagination</a>: Jekyll plugin to extend the pagination generator.</li>
1330
- <li>
1331
- <a href="https://github.com/pattex/jekyll-tagging">Jekyll-tagging</a>: Jekyll plugin to automatically generate a tag cloud and tag pages.</li>
1332
- <li>
1333
- <a href="https://github.com/inukshuk/jekyll-scholar">Jekyll-scholar</a>: Jekyll extensions for the blogging scholar.</li>
1334
- <li>
1335
- <a href="http://jekyll.github.io/jekyll-assets/">Jekyll-assets</a> by <a href="https://github.com/ixti">ixti</a>: Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).</li>
1336
- <li>
1337
- <a href="https://github.com/kitsched/japr">JAPR</a>: Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.</li>
1338
- <li>
1339
- <a href="https://github.com/tkareine/jekyll-minibundle">Jekyll-minibundle</a>: Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.</li>
1340
- <li>
1341
- <a href="https://github.com/JCB-K/singlepage-jekyll">Singlepage-jekyll</a> by <a href="https://github.com/JCB-K">JCB-K</a>: Turns Jekyll into a dynamic one-page website.</li>
1342
- <li>
1343
- <a href="https://github.com/robwierzbowski/generator-jekyllrb">generator-jekyllrb</a>: A generator that wraps Jekyll in <a href="http://yeoman.io/">Yeoman</a>, a tool collection and workflow for building modern web apps.</li>
1344
- <li>
1345
- <a href="https://github.com/dannygarcia/grunt-jekyll">grunt-jekyll</a>: A straightforward <a href="http://gruntjs.com/">Grunt</a> plugin for Jekyll.</li>
1346
- <li>
1347
- <a href="https://github.com/indirect/jekyll-postfiles">jekyll-postfiles</a>: Add <code class="language-plaintext highlighter-rouge">_postfiles</code> directory and <code class="language-plaintext highlighter-rouge">{{ postfile }}</code> tag so the files a post refers to will always be right there inside your repo.</li>
1348
- <li>
1349
- <a href="http://jch.penibelst.de/">A layout that compresses HTML</a>: GitHub Pages compatible, configurable way to compress HTML files on site build.</li>
1350
- <li>
1351
- <a href="https://github.com/wdenton/jekyll-co2">Jekyll CO₂</a>: Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.</li>
1352
- <li>
1353
- <a href="http://www.northfieldx.co.uk/remote-include/">remote-include</a>: Includes files using remote URLs</li>
1354
- <li>
1355
- <a href="https://github.com/digitalsparky/jekyll-minifier">jekyll-minifier</a>: Minifies HTML, XML, CSS, and Javascript both inline and as separate files utilising yui-compressor and htmlcompressor.</li>
1356
- <li>
1357
- <a href="https://bitbucket.org/nyufac/jekyll-views-router">Jekyll views router</a>: Simple router between generator plugins and templates.</li>
1358
- <li>
1359
- <a href="https://github.com/vwochnik/jekyll-language-plugin">Jekyll Language Plugin</a>: Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.</li>
1360
- <li>
1361
- <a href="https://github.com/vwochnik/jekyll-deploy">Jekyll Deploy</a>: Adds a <code class="language-plaintext highlighter-rouge">deploy</code> sub-command to Jekyll.</li>
1362
- <li>
1363
- <a href="https://github.com/contentful/jekyll-contentful-data-import">Official Contentful Jekyll Plugin</a>: Adds a <code class="language-plaintext highlighter-rouge">contentful</code> sub-command to Jekyll to import data from Contentful.</li>
1364
- <li>
1365
- <a href="https://github.com/KrzysiekJ/jekyll-paspagon">jekyll-paspagon</a>: Sell your posts in various formats for cryptocurrencies.</li>
1366
- <li>
1367
- <a href="https://github.com/awood/hawkins">Hawkins</a>: Adds a <code class="language-plaintext highlighter-rouge">liveserve</code> sub-command to Jekyll that incorporates <a href="http://livereload.com/">LiveReload</a> into your pages while you preview them. No more hitting the refresh button in your browser!</li>
1368
- <li>
1369
- <a href="https://github.com/vwochnik/jekyll-autoprefixer">Jekyll Autoprefixer</a>: Autoprefixer integration for Jekyll</li>
1370
- <li>
1371
- <a href="https://github.com/git-no/jekyll-breadcrumbs">Jekyll-breadcrumbs</a>: Creates breadcrumbs for Jekyll 3.x, includes features like SEO optimization, optional breadcrumb item translation and more.</li>
1372
- <li>
1373
- <a href="https://github.com/sondr3/generator-jekyllized">generator-jekyllized</a>: A Yeoman generator for rapidly developing sites with Gulp. Live reload your site, automatically minify and optimize your assets and much more.</li>
1374
- <li>
1375
- <a href="https://github.com/MertcanGokgoz/Jekyll-Spotify">Jekyll-Spotify</a>: Easily output Spotify Embed Player for jekyll</li>
1376
- <li>
1377
- <a href="https://github.com/forestryio/jekyll-menus">jekyll-menus</a>: Hugo style menus for your Jekyll site… recursive menus included.</li>
1378
- <li>
1379
- <a href="https://github.com/ashmaroli/jekyll-data">jekyll-data</a>: Read data files within Jekyll Theme Gems.</li>
1380
- <li>
1381
- <a href="https://github.com/snaptortoise/jekyll-pinboard-plugin">jekyll-pinboard</a>: Access your Pinboard bookmarks within your Jekyll theme.</li>
1382
- <li>
1383
- <a href="https://github.com/mpchadwick/jekyll-migrate-permalink">jekyll-migrate-permalink</a>: Adds a <code class="language-plaintext highlighter-rouge">migrate-permalink</code> sub-command to help deal with side effects of changing your permalink.</li>
1384
- <li>
1385
- <a href="https://github.com/robcrocombe/jekyll-post">Jekyll-Post</a>: A CLI tool to easily draft, edit, and publish Jekyll posts.</li>
1386
- <li>
1387
- <a href="https://github.com/muratayusuke/jekyll-numbered-headings">jekyll-numbered-headings</a>: Adds ordered number to headings.</li>
1388
- <li>
1389
- <a href="https://github.com/mpchadwick/jekyll-pre-commit">jekyll-pre-commit</a>: A framework for running checks against your posts using a git pre-commit hook before you publish them.</li>
1390
- <li>
1391
- <a href="https://github.com/lavas-project/jekyll-pwa">jekyll-pwa-plugin</a>: A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.</li>
1392
- <li>
1393
- <a href="https://community.algolia.com/jekyll-algolia/">jekyll-algolia</a>: Add fast and relevant search to your Jekyll site through the Algolia API.</li>
1394
- </ul>
1395
-
1396
- <div class="note info">
1397
- <h5>Submit your gem plugins</h5>
1398
- <p>
1399
- You're encouraged to add your Jekyll gem plugins to this list, <a href="../contributing/">read the contributing page</a> to find
1400
- out how to make that happen.
1401
- </p>
1402
- </div>
1403
-
1404
-
1405
-
1406
-
1407
-
1408
-
1409
-
1410
-
1411
-
1412
-
1413
-
1414
-
1415
-
1416
-
1417
-
1418
-
1419
-
1420
-
1421
-
1422
-
1423
-
1424
-
1425
-
1426
-
1427
-
1428
-
1429
-
1430
-
1431
-
1432
-
1433
-
1434
-
1435
-
1436
-
1437
-
1438
-
1439
-
1440
-
1441
-
1442
-
1443
-
1444
-
1445
-
1446
-
1447
-
1448
-
1449
-
1450
-
1451
-
1452
-
1453
-
1454
-
1455
-
1456
-
1457
-
1458
-
1459
-
1460
-
1461
-
1462
-
1463
-
1464
-
1465
-
1466
-
1467
-
1468
-
1469
-
1470
-
1471
-
1472
-
1473
-
1474
-
1475
- <div class="section-nav">
1476
- <div class="left align-right">
1477
-
1478
-
1479
-
1480
- <a href="/docs/pagination/" class="prev">Back</a>
1481
-
1482
- </div>
1483
- <div class="right align-left">
1484
-
1485
-
1486
-
1487
- <a href="/docs/themes/" class="next">Next</a>
1488
-
1489
- </div>
1490
- </div>
1491
- <div class="clear"></div>
1492
-
1493
- </article>
1494
- </div>
1495
-
1496
- <div class="unit one-fifth hide-on-mobiles">
1497
- <aside>
1498
-
1499
- <h4>Getting Started</h4>
1500
- <ul>
1501
-
1502
-
1503
-
1504
- <li class=""><a href="/docs/home/">Welcome</a></li>
1505
-
1506
-
1507
-
1508
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
1509
-
1510
-
1511
-
1512
- <li class=""><a href="/docs/installation/">Installation</a></li>
1513
-
1514
-
1515
-
1516
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
1517
-
1518
-
1519
-
1520
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
1521
-
1522
-
1523
-
1524
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
1525
-
1526
-
1527
-
1528
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
1529
-
1530
- </ul>
1531
-
1532
-
1533
- <h4>Your Content</h4>
1534
- <ul>
1535
-
1536
-
1537
-
1538
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
1539
-
1540
-
1541
-
1542
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
1543
-
1544
-
1545
-
1546
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
1547
-
1548
-
1549
-
1550
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
1551
-
1552
-
1553
-
1554
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
1555
-
1556
-
1557
-
1558
- <li class=""><a href="/docs/variables/">Variables</a></li>
1559
-
1560
-
1561
-
1562
- <li class=""><a href="/docs/collections/">Collections</a></li>
1563
-
1564
-
1565
-
1566
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
1567
-
1568
-
1569
-
1570
- <li class=""><a href="/docs/assets/">Assets</a></li>
1571
-
1572
-
1573
-
1574
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
1575
-
1576
- </ul>
1577
-
1578
-
1579
- <h4>Customization</h4>
1580
- <ul>
1581
-
1582
-
1583
-
1584
- <li class=""><a href="/docs/templates/">Templates</a></li>
1585
-
1586
-
1587
-
1588
- <li class=""><a href="/docs/includes/">Includes</a></li>
1589
-
1590
-
1591
-
1592
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
1593
-
1594
-
1595
-
1596
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
1597
-
1598
-
1599
-
1600
- <li class="current"><a href="/docs/plugins/">Plugins</a></li>
1601
-
1602
-
1603
-
1604
- <li class=""><a href="/docs/themes/">Themes</a></li>
1605
-
1606
-
1607
-
1608
- <li class=""><a href="/docs/extras/">Extras</a></li>
1609
-
1610
- </ul>
1611
-
1612
-
1613
- <h4>Deployment</h4>
1614
- <ul>
1615
-
1616
-
1617
-
1618
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
1619
-
1620
-
1621
-
1622
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
1623
-
1624
-
1625
-
1626
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
1627
-
1628
- </ul>
1629
-
1630
-
1631
- <h4>Miscellaneous</h4>
1632
- <ul>
1633
-
1634
-
1635
-
1636
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
1637
-
1638
-
1639
-
1640
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
1641
-
1642
-
1643
-
1644
- <li class=""><a href="/docs/resources/">Resources</a></li>
1645
-
1646
-
1647
-
1648
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
1649
-
1650
-
1651
-
1652
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
1653
-
1654
- </ul>
1655
-
1656
-
1657
- <h4>Meta</h4>
1658
- <ul>
1659
-
1660
-
1661
-
1662
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
1663
-
1664
-
1665
-
1666
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
1667
-
1668
-
1669
-
1670
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
1671
-
1672
-
1673
-
1674
- <li class=""><a href="/docs/history/">History</a></li>
1675
-
1676
- </ul>
1677
-
1678
-
1679
- </aside>
1680
- </div>
1681
-
1682
-
1683
- <div class="clear"></div>
1684
-
1685
- </div>
1686
- </section>
526
+ </div>
527
+ </section>
1687
528
 
1688
529
 
1689
530
  <footer>
1690
531
  <div class="grid">
1691
532
  <div class="unit one-third center-on-mobiles">
1692
- <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>
533
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
534
+ <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>
1693
535
  </div>
1694
536
  <div class="unit two-thirds align-right center-on-mobiles">
1695
537
  <p>
@@ -1699,6 +541,14 @@ plugin to generate publication lists from <a href="https://www.bibsonomy.org/">B
1699
541
  </a>
1700
542
  </p>
1701
543
  </div>
544
+ <div class="unit two-thirds align-right center-on-mobiles">
545
+ <p>
546
+ Jekyll is funded thanks to its
547
+ <a href="https://github.com/jekyll/jekyll#sponsors">
548
+ sponsors!
549
+ </a>
550
+ </p>
551
+ </div>
1702
552
  </div>
1703
553
  </footer>
1704
554