jekyll-docs 3.9.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
@@ -0,0 +1,766 @@
1
+ <!DOCTYPE HTML>
2
+ <html lang="en-US">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <meta name="generator" content="Jekyll v4.0.0">
7
+ <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
8
+ <link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
9
+ <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
+ <link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
11
+ <link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
12
+ <link rel="preload" href="/css/screen.css" as="style">
13
+ <link rel="stylesheet" href="/css/screen.css">
14
+ <link rel="icon" type="image/x-icon" href="/favicon.ico">
15
+ <!-- Begin Jekyll SEO tag v2.6.1 -->
16
+ <title>Markdown Options | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Markdown Options" />
19
+ <meta property="og:locale" content="en_US" />
20
+ <meta name="description" content="The various Markdown renderers supported by Jekyll sometimes have extra options available." />
21
+ <meta property="og:description" content="The various Markdown renderers supported by Jekyll sometimes have extra options available." />
22
+ <link rel="canonical" href="https://jekyllrb.com/docs/configuration/markdown/" />
23
+ <meta property="og:url" content="https://jekyllrb.com/docs/configuration/markdown/" />
24
+ <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
25
+ <meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
26
+ <meta property="og:type" content="article" />
27
+ <meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
28
+ <meta name="twitter:card" content="summary_large_image" />
29
+ <meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
30
+ <meta property="twitter:title" content="Markdown Options" />
31
+ <meta name="twitter:site" content="@jekyllrb" />
32
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
33
+ <script type="application/ld+json">
34
+ {"description":"The various Markdown renderers supported by Jekyll sometimes have extra options available.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/configuration/markdown/"},"headline":"Markdown Options","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/configuration/markdown/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
35
+ <!-- End Jekyll SEO tag -->
36
+
37
+ <!--[if lt IE 9]>
38
+ <script src="/js/html5shiv.min.js"></script>
39
+ <script src="/js/respond.min.js"></script>
40
+ <![endif]-->
41
+ </head>
42
+
43
+
44
+ <body class="wrap">
45
+ <header>
46
+ <div class="flexbox">
47
+ <div class="center-on-mobiles">
48
+ <h1>
49
+ <a href="/" class="logo">
50
+ <span class="sr-only">Jekyll</span>
51
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
52
+ </a>
53
+ </h1>
54
+ </div>
55
+ <nav class="main-nav hide-on-mobiles">
56
+ <ul>
57
+
58
+ <li>
59
+ <a href="/">Home</a>
60
+ </li>
61
+
62
+ <li class="current">
63
+ <a href="/docs/">Docs</a>
64
+ </li>
65
+
66
+ <li>
67
+ <a href="/resources/">Resources</a>
68
+ </li>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
72
+ </li>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
76
+ </li>
77
+
78
+ </ul>
79
+
80
+ </nav>
81
+ <div class="search hide-on-mobiles">
82
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
83
+
84
+ </div>
85
+ <div class="meta hide-on-mobiles">
86
+ <ul>
87
+ <li>
88
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
89
+ </li>
90
+ <li>
91
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
92
+ </li>
93
+ </ul>
94
+ </div>
95
+ </div>
96
+ <nav class="mobile-nav show-on-mobiles">
97
+ <ul>
98
+
99
+ <li>
100
+ <a href="/">Home</a>
101
+ </li>
102
+
103
+ <li 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
+
116
+ <li>
117
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
118
+ </li>
119
+ </ul>
120
+
121
+ </nav>
122
+ </header>
123
+
124
+
125
+ <section class="docs">
126
+ <div class="grid">
127
+
128
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
129
+ <select onchange="if (this.value) window.location.href=this.value">
130
+ <option value="">Navigate the docs…</option>
131
+
132
+ <optgroup label="Getting Started">
133
+
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>
158
+
159
+ </optgroup>
160
+
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>
172
+
173
+ </optgroup>
174
+
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>
211
+
212
+ </optgroup>
213
+
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>
255
+
256
+ </optgroup>
257
+
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>
279
+
280
+ </optgroup>
281
+
282
+ </select>
283
+ </div>
284
+
285
+
286
+ <div class="unit four-fifths">
287
+ <article>
288
+ <div class="improve right hide-on-mobiles">
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/configuration/markdown.md"><i class="fa fa-pencil"></i>  Improve this page</a>
290
+ </div>
291
+ <h1>Markdown Options</h1>
292
+ <p>The various Markdown renderers supported by Jekyll sometimes have extra options
293
+ available.</p>
294
+
295
+ <h3 id="kramdown">Kramdown</h3>
296
+
297
+ <p>Kramdown is the default Markdown renderer for Jekyll. Below is a list of the
298
+ currently supported options:</p>
299
+
300
+ <ul>
301
+ <li>
302
+ <strong>auto_id_prefix</strong> - Prefix used for automatically generated header IDs</li>
303
+ <li>
304
+ <strong>auto_id_stripping</strong> - Strip all formatting from header text for automatic ID generation</li>
305
+ <li>
306
+ <strong>auto_ids</strong> - Use automatic header ID generation</li>
307
+ <li>
308
+ <strong>coderay_bold_every</strong> - Defines how often a line number should be made bold</li>
309
+ <li>
310
+ <strong>coderay_css</strong> - Defines how the highlighted code gets styled</li>
311
+ <li>
312
+ <strong>coderay_default_lang</strong> - Sets the default language for highlighting code blocks</li>
313
+ <li>
314
+ <strong>coderay_line_number_start</strong> - The start value for the line numbers</li>
315
+ <li>
316
+ <strong>coderay_line_numbers</strong> - Defines how and if line numbers should be shown</li>
317
+ <li>
318
+ <strong>coderay_tab_width</strong> - The tab width used in highlighted code</li>
319
+ <li>
320
+ <strong>coderay_wrap</strong> - Defines how the highlighted code should be wrapped</li>
321
+ <li>
322
+ <strong>enable_coderay</strong> - Use coderay for syntax highlighting</li>
323
+ <li>
324
+ <strong>entity_output</strong> - Defines how entities are output</li>
325
+ <li>
326
+ <strong>footnote_backlink</strong> - Defines the text that should be used for the footnote backlinks</li>
327
+ <li>
328
+ <strong>footnote_backlink_inline</strong> - Specifies whether the footnote backlink should always be inline</li>
329
+ <li>
330
+ <strong>footnote_nr</strong> - The number of the first footnote</li>
331
+ <li>
332
+ <strong>gfm_quirks</strong> - Enables a set of GFM specific quirks</li>
333
+ <li>
334
+ <strong>hard_wrap</strong> - Interprets line breaks literally</li>
335
+ <li>
336
+ <strong>header_offset</strong> - Sets the output offset for headers</li>
337
+ <li>
338
+ <strong>html_to_native</strong> - Convert HTML elements to native elements</li>
339
+ <li>
340
+ <strong>line_width</strong> - Defines the line width to be used when outputting a document</li>
341
+ <li>
342
+ <strong>link_defs</strong> - Pre-defines link definitions</li>
343
+ <li>
344
+ <strong>math_engine</strong> - Set the math engine</li>
345
+ <li>
346
+ <strong>math_engine_opts</strong> - Set the math engine options</li>
347
+ <li>
348
+ <strong>parse_block_html</strong> - Process kramdown syntax in block HTML tags</li>
349
+ <li>
350
+ <strong>parse_span_html</strong> - Process kramdown syntax in span HTML tags</li>
351
+ <li>
352
+ <strong>smart_quotes</strong> - Defines the HTML entity names or code points for smart quote output</li>
353
+ <li>
354
+ <strong>syntax_highlighter</strong> - Set the syntax highlighter</li>
355
+ <li>
356
+ <strong>syntax_highlighter_opts</strong> - Set the syntax highlighter options</li>
357
+ <li>
358
+ <strong>toc_levels</strong> - Defines the levels that are used for the table of contents</li>
359
+ <li>
360
+ <strong>transliterated_header_ids</strong> - Transliterate the header text before generating the ID</li>
361
+ <li>
362
+ <strong>typographic_symbols</strong> - Defines a mapping from typographical symbol to output characters</li>
363
+ </ul>
364
+
365
+ <div class="note warning">
366
+ <h5>There are two unsupported kramdown options</h5>
367
+ <p>
368
+ Please note that both <code>remove_block_html_tags</code> and
369
+ <code>remove_span_html_tags</code> are currently unsupported in Jekyll due
370
+ to the fact that they are not included within the kramdown HTML converter.
371
+ </p>
372
+ </div>
373
+
374
+ <p>For more details about these options have a look at the <a href="https://kramdown.gettalong.org/options.html">Kramdown configuration documentation</a>.</p>
375
+
376
+ <h3 id="commonmark">CommonMark</h3>
377
+
378
+ <p><a href="https://commonmark.org/">CommonMark</a> is a rationalized version of Markdown syntax, implemented in C and thus faster than default Kramdown implemented in Ruby. It <a href="https://github.com/commonmark/CommonMark#differences-from-original-markdown">slightly differs</a> from original Markdown and does not support all the syntax elements implemented in Kramdown, like <a href="https://kramdown.gettalong.org/syntax.html#block-ials">Block Inline Attribute Lists</a>.</p>
379
+
380
+ <p>It comes in two flavors: basic CommonMark with <a href="https://github.com/jekyll/jekyll-commonmark">jekyll-commonmark</a> plugin and <a href="https://github.com/github/jekyll-commonmark-ghpages">GitHub Flavored Markdown supported by GitHub Pages</a>.</p>
381
+
382
+ <h3 id="redcarpet">Redcarpet</h3>
383
+
384
+ <p>Redcarpet can be configured by providing an <code class="highlighter-rouge">extensions</code> sub-setting, whose
385
+ value should be an array of strings. Each string should be the name of one of
386
+ the <code class="highlighter-rouge">Redcarpet::Markdown</code> class’s extensions; if present in the array, it will
387
+ set the corresponding extension to <code class="highlighter-rouge">true</code>.</p>
388
+
389
+ <p>Jekyll handles two special Redcarpet extensions:</p>
390
+
391
+ <ul>
392
+ <li>
393
+ <code class="highlighter-rouge">no_fenced_code_blocks</code> — By default, Jekyll sets the <code class="highlighter-rouge">fenced_code_blocks</code>
394
+ extension (for delimiting code blocks with triple tildes or triple backticks)
395
+ to <code class="highlighter-rouge">true</code>, probably because GitHub’s eager adoption of them is starting to make
396
+ them inescapable. Redcarpet’s normal <code class="highlighter-rouge">fenced_code_blocks</code> extension is inert
397
+ when used with Jekyll; instead, you can use this inverted version of the
398
+ extension for disabling fenced code.</li>
399
+ </ul>
400
+
401
+ <p>Note that you can also specify a language for highlighting after the first
402
+ delimiter:</p>
403
+
404
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> ```ruby
405
+ # ...ruby code
406
+ ```
407
+ </code></pre></div></div>
408
+
409
+ <p>With both fenced code blocks and highlighter enabled, this will statically
410
+ highlight the code; without any syntax highlighter, it will add a
411
+ <code class="highlighter-rouge">class="LANGUAGE"</code> attribute to the <code class="highlighter-rouge">&lt;code&gt;</code> element, which can be used as a
412
+ hint by various JavaScript code highlighting libraries.</p>
413
+
414
+ <ul>
415
+ <li>
416
+ <code class="highlighter-rouge">smart</code> — This pseudo-extension turns on SmartyPants, which converts
417
+ straight quotes to curly quotes and runs of hyphens to em (<code class="highlighter-rouge">---</code>) and en (<code class="highlighter-rouge">--</code>) dashes.</li>
418
+ </ul>
419
+
420
+ <p>All other extensions retain their usual names from Redcarpet, and no renderer
421
+ options aside from <code class="highlighter-rouge">smart</code> can be specified in Jekyll. <a href="https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use">A list of available
422
+ extensions can be found in the Redcarpet README file.</a>
423
+ Make sure you’re looking at the README for the right version of
424
+ Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
425
+ extensions are:</p>
426
+
427
+ <ul>
428
+ <li><code class="highlighter-rouge">tables</code></li>
429
+ <li><code class="highlighter-rouge">no_intra_emphasis</code></li>
430
+ <li><code class="highlighter-rouge">autolink</code></li>
431
+ </ul>
432
+
433
+ <h3 id="custom-markdown-processors">Custom Markdown Processors</h3>
434
+
435
+ <p>If you’re interested in creating a custom markdown processor, you’re in luck! Create a new class in the <code class="highlighter-rouge">Jekyll::Converters::Markdown</code> namespace:</p>
436
+
437
+ <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">Jekyll</span><span class="o">::</span><span class="no">Converters</span><span class="o">::</span><span class="no">Markdown</span><span class="o">::</span><span class="no">MyCustomProcessor</span>
438
+ <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
439
+ <span class="nb">require</span> <span class="s1">'funky_markdown'</span>
440
+ <span class="vi">@config</span> <span class="o">=</span> <span class="n">config</span>
441
+ <span class="k">rescue</span> <span class="no">LoadError</span>
442
+ <span class="no">STDERR</span><span class="p">.</span><span class="nf">puts</span> <span class="s1">'You are missing a library required for Markdown. Please run:'</span>
443
+ <span class="no">STDERR</span><span class="p">.</span><span class="nf">puts</span> <span class="s1">' $ [sudo] gem install funky_markdown'</span>
444
+ <span class="k">raise</span> <span class="no">FatalException</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="s2">"Missing dependency: funky_markdown"</span><span class="p">)</span>
445
+ <span class="k">end</span>
446
+
447
+ <span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
448
+ <span class="o">::</span><span class="no">FunkyMarkdown</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">content</span><span class="p">).</span><span class="nf">convert</span>
449
+ <span class="k">end</span>
450
+ <span class="k">end</span>
451
+ </code></pre></div></div>
452
+
453
+ <p>Once you’ve created your class and have it properly set up either as a plugin
454
+ in the <code class="highlighter-rouge">_plugins</code> folder or as a gem, specify it in your <code class="highlighter-rouge">_config.yml</code>:</p>
455
+
456
+ <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">markdown</span><span class="pi">:</span> <span class="s">MyCustomProcessor</span>
457
+ </code></pre></div></div>
458
+
459
+ </article>
460
+ </div>
461
+
462
+ <div class="unit one-fifth hide-on-mobiles">
463
+ <aside>
464
+
465
+ <h4>Getting Started</h4>
466
+ <ul>
467
+
468
+
469
+ <li>
470
+ <a href="/docs/">
471
+ Quickstart
472
+ </a>
473
+ </li>
474
+
475
+
476
+ <li>
477
+ <a href="/docs/ruby-101/">
478
+ Ruby 101
479
+ </a>
480
+ </li>
481
+
482
+
483
+ <li>
484
+ <a href="/docs/installation/">
485
+ Installation
486
+ </a>
487
+ </li>
488
+
489
+
490
+ <li>
491
+ <a href="/docs/community/">
492
+ Community
493
+ </a>
494
+ </li>
495
+
496
+
497
+ <li>
498
+ <a href="/docs/step-by-step/01-setup/">
499
+ Step by Step Tutorial
500
+ </a>
501
+ </li>
502
+
503
+ </ul>
504
+
505
+ <h4>Build</h4>
506
+ <ul>
507
+
508
+
509
+ <li>
510
+ <a href="/docs/usage/">
511
+ Command Line Usage
512
+ </a>
513
+ </li>
514
+
515
+
516
+ <li>
517
+ <a href="/docs/configuration/">
518
+ Configuration
519
+ </a>
520
+ </li>
521
+
522
+ </ul>
523
+
524
+ <h4>Content</h4>
525
+ <ul>
526
+
527
+
528
+ <li>
529
+ <a href="/docs/pages/">
530
+ Pages
531
+ </a>
532
+ </li>
533
+
534
+
535
+ <li>
536
+ <a href="/docs/posts/">
537
+ Posts
538
+ </a>
539
+ </li>
540
+
541
+
542
+ <li>
543
+ <a href="/docs/front-matter/">
544
+ Front Matter
545
+ </a>
546
+ </li>
547
+
548
+
549
+ <li>
550
+ <a href="/docs/collections/">
551
+ Collections
552
+ </a>
553
+ </li>
554
+
555
+
556
+ <li>
557
+ <a href="/docs/datafiles/">
558
+ Data Files
559
+ </a>
560
+ </li>
561
+
562
+
563
+ <li>
564
+ <a href="/docs/assets/">
565
+ Assets
566
+ </a>
567
+ </li>
568
+
569
+
570
+ <li>
571
+ <a href="/docs/static-files/">
572
+ Static Files
573
+ </a>
574
+ </li>
575
+
576
+ </ul>
577
+
578
+ <h4>Site Structure</h4>
579
+ <ul>
580
+
581
+
582
+ <li>
583
+ <a href="/docs/structure/">
584
+ Directory Structure
585
+ </a>
586
+ </li>
587
+
588
+
589
+ <li>
590
+ <a href="/docs/liquid/">
591
+ Liquid
592
+ </a>
593
+ </li>
594
+
595
+
596
+ <li>
597
+ <a href="/docs/variables/">
598
+ Variables
599
+ </a>
600
+ </li>
601
+
602
+
603
+ <li>
604
+ <a href="/docs/includes/">
605
+ Includes
606
+ </a>
607
+ </li>
608
+
609
+
610
+ <li>
611
+ <a href="/docs/layouts/">
612
+ Layouts
613
+ </a>
614
+ </li>
615
+
616
+
617
+ <li>
618
+ <a href="/docs/permalinks/">
619
+ Permalinks
620
+ </a>
621
+ </li>
622
+
623
+
624
+ <li>
625
+ <a href="/docs/themes/">
626
+ Themes
627
+ </a>
628
+ </li>
629
+
630
+
631
+ <li>
632
+ <a href="/docs/pagination/">
633
+ Pagination
634
+ </a>
635
+ </li>
636
+
637
+ </ul>
638
+
639
+ <h4>Guides</h4>
640
+ <ul>
641
+
642
+
643
+ <li>
644
+ <a href="/docs/plugins/">
645
+ Plugins
646
+ </a>
647
+ </li>
648
+
649
+
650
+ <li>
651
+ <a href="/docs/migrations/">
652
+ Blog Migrations
653
+ </a>
654
+ </li>
655
+
656
+
657
+ <li>
658
+ <a href="/docs/upgrading/">
659
+ Upgrading
660
+ </a>
661
+ </li>
662
+
663
+
664
+ <li>
665
+ <a href="/docs/deployment/">
666
+ Deployment
667
+ </a>
668
+ </li>
669
+
670
+ </ul>
671
+
672
+ </aside>
673
+ </div>
674
+
675
+
676
+ <div class="clear"></div>
677
+
678
+ </div>
679
+ </section>
680
+
681
+
682
+ <footer>
683
+ <div class="grid">
684
+ <div class="unit one-third center-on-mobiles">
685
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
686
+ <p>The contents of this website are <br>© 2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
687
+ </div>
688
+ <div class="unit two-thirds align-right center-on-mobiles">
689
+ <p>
690
+ Proudly hosted by
691
+ <a href="https://github.com">
692
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
693
+ </a>
694
+ </p>
695
+ </div>
696
+ <div class="unit two-thirds align-right center-on-mobiles">
697
+ <p>
698
+ Jekyll is funded thanks to its
699
+ <a href="https://github.com/jekyll/jekyll#sponsors">
700
+ sponsors!
701
+ </a>
702
+ </p>
703
+ </div>
704
+ </div>
705
+ </footer>
706
+
707
+ <script>
708
+ var anchorForId = function (id) {
709
+ var anchor = document.createElement("a");
710
+ anchor.className = "header-link";
711
+ anchor.href = "#" + id;
712
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
713
+ anchor.title = "Permalink";
714
+ return anchor;
715
+ };
716
+
717
+ var linkifyAnchors = function (level, containingElement) {
718
+ var headers = containingElement.getElementsByTagName("h" + level);
719
+ for (var h = 0; h < headers.length; h++) {
720
+ var header = headers[h];
721
+
722
+ if (typeof header.id !== "undefined" && header.id !== "") {
723
+ header.appendChild(anchorForId(header.id));
724
+ }
725
+ }
726
+ };
727
+
728
+ document.onreadystatechange = function () {
729
+ if (this.readyState === "complete") {
730
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
731
+ if (!contentBlock) {
732
+ return;
733
+ }
734
+ for (var level = 1; level <= 6; level++) {
735
+ linkifyAnchors(level, contentBlock);
736
+ }
737
+ }
738
+ };
739
+ </script>
740
+
741
+
742
+ <!-- Google Analytics (https://www.google.com/analytics) -->
743
+ <script>
744
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
745
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
746
+ L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
747
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
748
+
749
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
750
+ ga('send', 'pageview');
751
+
752
+ </script>
753
+
754
+
755
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
756
+ <script type="text/javascript"> docsearch({
757
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
758
+ indexName: 'jekyllrb',
759
+ inputSelector: '#docsearch-input',
760
+ enhancedSearchInput: true,
761
+ debug: false // Set debug to true if you want to inspect the dropdown
762
+ });
763
+ </script>
764
+
765
+ </body>
766
+ </html>