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
@@ -0,0 +1,733 @@
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>Jekyll on Windows | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Jekyll on Windows" />
19
+ <meta property="og:locale" content="en_US" />
20
+ <meta name="description" content="While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users." />
21
+ <meta property="og:description" content="While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users." />
22
+ <link rel="canonical" href="https://jekyllrb.com/docs/installation/windows/" />
23
+ <meta property="og:url" content="https://jekyllrb.com/docs/installation/windows/" />
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="Jekyll on Windows" />
31
+ <meta name="twitter:site" content="@jekyllrb" />
32
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
33
+ <script type="application/ld+json">
34
+ {"description":"While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/installation/windows/"},"headline":"Jekyll on Windows","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/installation/windows/","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/installation/windows.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
290
+ </div>
291
+ <h1>Jekyll on Windows</h1>
292
+ <p>While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to
293
+ collect some of the general knowledge and lessons that have been unearthed by Windows users.</p>
294
+
295
+ <h2 id="installing-jekyll">Installing Jekyll</h2>
296
+
297
+ <h3 id="installation-via-rubyinstaller">Installation via RubyInstaller</h3>
298
+
299
+ <p>The easiest way to run Jekyll is by using the <a href="https://rubyinstaller.org/">RubyInstaller</a> for Windows.</p>
300
+
301
+ <p>RubyInstaller is a self-contained Windows-based installer that includes the Ruby language, an execution environment,
302
+ important documentation, and more.
303
+ We only cover RubyInstaller-2.4 and newer here, older versions need to
304
+ <a href="https://github.com/oneclick/rubyinstaller/wiki/Development-Kit">install the Devkit</a> manually.</p>
305
+
306
+ <ol>
307
+ <li>Download and Install a <strong>Ruby+Devkit</strong> version from <a href="https://rubyinstaller.org/downloads/">RubyInstaller Downloads</a>.
308
+ Use default options for installation.</li>
309
+ <li>Run the <code class="highlighter-rouge">ridk install</code> step on the last stage of the installation wizard. This is needed for installing gems with native
310
+ extensions. You can find additional information regarding this in the
311
+ <a href="https://github.com/oneclick/rubyinstaller2#using-the-installer-on-a-target-system">RubyInstaller Documentation</a></li>
312
+ <li>Open a new command prompt window from the start menu, so that changes to the <code class="highlighter-rouge">PATH</code> environment variable becomes effective.
313
+ Install Jekyll and Bundler via: <code class="highlighter-rouge">gem install jekyll bundler</code></li>
314
+ <li>Check if Jekyll installed properly: <code class="highlighter-rouge">jekyll -v</code></li>
315
+ </ol>
316
+
317
+ <p>That’s it, you’re ready to use Jekyll!</p>
318
+
319
+ <h3 id="installation-via-bash-on-windows-10">Installation via Bash on Windows 10</h3>
320
+
321
+ <p>If you are using Windows 10 version 1607 or later, another option to run Jekyll is by
322
+ <a href="https://msdn.microsoft.com/en-us/commandline/wsl/install_guide">installing</a> the Windows Subsystem for Linux.</p>
323
+
324
+ <p><em>Note:</em> You must have <a href="https://msdn.microsoft.com/en-us/commandline/wsl/about">Windows Subsystem for Linux</a> enabled.</p>
325
+
326
+ <p>First let’s make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:</p>
327
+
328
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bash
329
+ </code></pre></div></div>
330
+ <p>Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.</p>
331
+
332
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>apt-get update <span class="nt">-y</span> <span class="o">&amp;&amp;</span> <span class="nb">sudo </span>apt-get upgrade <span class="nt">-y</span>
333
+ </code></pre></div></div>
334
+ <p>Now we can install Ruby. To do this we will use a repository from <a href="https://www.brightbox.com/docs/ruby/ubuntu/">BrightBox</a>,
335
+ which hosts optimized versions of Ruby for Ubuntu.</p>
336
+
337
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">sudo </span>apt-add-repository ppa:brightbox/ruby-ng
338
+ <span class="nb">sudo </span>apt-get update
339
+ <span class="nb">sudo </span>apt-get <span class="nb">install </span>ruby2.5 ruby2.5-dev build-essential dh-autoreconf
340
+ </code></pre></div></div>
341
+
342
+ <p>Next let’s update our Ruby gems:</p>
343
+
344
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem update
345
+ </code></pre></div></div>
346
+
347
+ <p>Now all that is left to do is install Jekyll.</p>
348
+
349
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem <span class="nb">install </span>jekyll bundler
350
+ </code></pre></div></div>
351
+
352
+ <p>(<em>Note: no <code class="highlighter-rouge">sudo</code> here.</em>)</p>
353
+
354
+ <p>Check if Jekyll installed properly by running:</p>
355
+
356
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>jekyll <span class="nt">-v</span>
357
+ </code></pre></div></div>
358
+
359
+ <p><strong>And that’s it!</strong></p>
360
+
361
+ <p>You can make sure time management is working properly by inspecting your <code class="highlighter-rouge">_posts</code> folder. You should see a markdown file
362
+ with the current date in the filename.</p>
363
+
364
+ <div class="note info">
365
+ <h5>Non-superuser account issues</h5>
366
+ <p>If the `jekyll new` command prints the error "Your user account isn't allowed to install to the system RubyGems", see
367
+ the "Running Jekyll as Non-Superuser" instructions in <a href="/docs/troubleshooting/#no-sudo">Troubleshooting</a>.</p>
368
+ </div>
369
+
370
+ <p><strong>Note:</strong> Bash on Ubuntu on Windows is still under development, so you may run into issues.</p>
371
+
372
+ <h2 id="encoding">Encoding</h2>
373
+
374
+ <p>If you use UTF-8 encoding, make sure that no <code class="highlighter-rouge">BOM</code> header characters exist in your files or very, very bad things will happen to
375
+ Jekyll. This is especially relevant when you’re running Jekyll on Windows.</p>
376
+
377
+ <p>Additionally, you might need to change the code page of the console window to UTF-8 in case you get a
378
+ <code class="highlighter-rouge">Liquid Exception: Incompatible character encoding</code> error during the site generation process. It can be done with the following
379
+ command:</p>
380
+
381
+ <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>chcp 65001
382
+ </code></pre></div></div>
383
+
384
+ <h2 id="time-zone-management">Time-Zone Management</h2>
385
+
386
+ <p>Since Windows doesn’t have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence
387
+ using them had the <code class="highlighter-rouge">TZ</code> environment variable default to UTC/GMT 00:00.</p>
388
+
389
+ <p>Though Windows users could alternatively define their blog’s timezone by setting the key to use POSIX format of defining
390
+ timezones, it wasn’t as user-friendly when it came to having the clock altered to changing DST-rules.</p>
391
+
392
+ <p>Jekyll now uses a rubygem to internally configure Timezone based on established
393
+ <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">IANA Timezone Database</a>.
394
+ While ‘new’ blogs created with Jekyll v3.4 and greater, will have the following added to their <code class="highlighter-rouge">Gemfile</code> by default, existing
395
+ sites <em>will</em> have to update their <code class="highlighter-rouge">Gemfile</code> (and installed) to enable development on Windows:</p>
396
+
397
+ <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1"># Windows does not include zoneinfo files, so bundle the tzinfo-data gem</span>
398
+ <span class="n">gem</span> <span class="s1">'tzinfo-data'</span><span class="p">,</span> <span class="ss">platforms: </span><span class="p">[</span><span class="ss">:mingw</span><span class="p">,</span> <span class="ss">:mswin</span><span class="p">,</span> <span class="ss">:x64_mingw</span><span class="p">,</span> <span class="ss">:jruby</span><span class="p">]</span>
399
+ </code></pre></div></div>
400
+
401
+ <div class="note warning">
402
+ <h5>TZInfo 2.0 incompatibility</h5>
403
+ <p>
404
+ <code>v2.0</code> of the TZInfo library has introduced a change in how timezone offsets are calculated.
405
+ This will result in incorrect date and time for your posts when the site is built with Jekyll 3.x on Windows.
406
+ </p>
407
+ <p>
408
+ We therefore recommend that you lock the Timezone library to <code>v1.2</code> and above by listing
409
+ <code>gem 'tzinfo', '~&gt; 1.2'</code> in your <code>Gemfile</code>.
410
+ </p>
411
+ </div>
412
+
413
+ <h2 id="auto-regeneration">Auto Regeneration</h2>
414
+
415
+ <p>Jekyll uses the <code class="highlighter-rouge">listen</code> gem to watch for changes when the <code class="highlighter-rouge">--watch</code> switch is specified during a build or serve.
416
+ While <code class="highlighter-rouge">listen</code> has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.</p>
417
+
418
+ <p>Add the following to the <code class="highlighter-rouge">Gemfile</code> for your site if you have issues with auto-regeneration on Windows alone:</p>
419
+
420
+ <div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">gem</span> <span class="s1">'wdm'</span><span class="p">,</span> <span class="s1">'~&gt; 0.1.1'</span><span class="p">,</span> <span class="ss">:install_if</span> <span class="o">=&gt;</span> <span class="no">Gem</span><span class="p">.</span><span class="nf">win_platform?</span>
421
+ </code></pre></div></div>
422
+
423
+ <p>You have to use a <a href="https://rubyinstaller.org/downloads/">Ruby+Devkit</a> version of the RubyInstaller and install
424
+ the MSYS2 build tools to successfully install the <code class="highlighter-rouge">wdm</code> gem.</p>
425
+
426
+ </article>
427
+ </div>
428
+
429
+ <div class="unit one-fifth hide-on-mobiles">
430
+ <aside>
431
+
432
+ <h4>Getting Started</h4>
433
+ <ul>
434
+
435
+
436
+ <li>
437
+ <a href="/docs/">
438
+ Quickstart
439
+ </a>
440
+ </li>
441
+
442
+
443
+ <li>
444
+ <a href="/docs/ruby-101/">
445
+ Ruby 101
446
+ </a>
447
+ </li>
448
+
449
+
450
+ <li>
451
+ <a href="/docs/installation/">
452
+ Installation
453
+ </a>
454
+ </li>
455
+
456
+
457
+ <li>
458
+ <a href="/docs/community/">
459
+ Community
460
+ </a>
461
+ </li>
462
+
463
+
464
+ <li>
465
+ <a href="/docs/step-by-step/01-setup/">
466
+ Step by Step Tutorial
467
+ </a>
468
+ </li>
469
+
470
+ </ul>
471
+
472
+ <h4>Build</h4>
473
+ <ul>
474
+
475
+
476
+ <li>
477
+ <a href="/docs/usage/">
478
+ Command Line Usage
479
+ </a>
480
+ </li>
481
+
482
+
483
+ <li>
484
+ <a href="/docs/configuration/">
485
+ Configuration
486
+ </a>
487
+ </li>
488
+
489
+ </ul>
490
+
491
+ <h4>Content</h4>
492
+ <ul>
493
+
494
+
495
+ <li>
496
+ <a href="/docs/pages/">
497
+ Pages
498
+ </a>
499
+ </li>
500
+
501
+
502
+ <li>
503
+ <a href="/docs/posts/">
504
+ Posts
505
+ </a>
506
+ </li>
507
+
508
+
509
+ <li>
510
+ <a href="/docs/front-matter/">
511
+ Front Matter
512
+ </a>
513
+ </li>
514
+
515
+
516
+ <li>
517
+ <a href="/docs/collections/">
518
+ Collections
519
+ </a>
520
+ </li>
521
+
522
+
523
+ <li>
524
+ <a href="/docs/datafiles/">
525
+ Data Files
526
+ </a>
527
+ </li>
528
+
529
+
530
+ <li>
531
+ <a href="/docs/assets/">
532
+ Assets
533
+ </a>
534
+ </li>
535
+
536
+
537
+ <li>
538
+ <a href="/docs/static-files/">
539
+ Static Files
540
+ </a>
541
+ </li>
542
+
543
+ </ul>
544
+
545
+ <h4>Site Structure</h4>
546
+ <ul>
547
+
548
+
549
+ <li>
550
+ <a href="/docs/structure/">
551
+ Directory Structure
552
+ </a>
553
+ </li>
554
+
555
+
556
+ <li>
557
+ <a href="/docs/liquid/">
558
+ Liquid
559
+ </a>
560
+ </li>
561
+
562
+
563
+ <li>
564
+ <a href="/docs/variables/">
565
+ Variables
566
+ </a>
567
+ </li>
568
+
569
+
570
+ <li>
571
+ <a href="/docs/includes/">
572
+ Includes
573
+ </a>
574
+ </li>
575
+
576
+
577
+ <li>
578
+ <a href="/docs/layouts/">
579
+ Layouts
580
+ </a>
581
+ </li>
582
+
583
+
584
+ <li>
585
+ <a href="/docs/permalinks/">
586
+ Permalinks
587
+ </a>
588
+ </li>
589
+
590
+
591
+ <li>
592
+ <a href="/docs/themes/">
593
+ Themes
594
+ </a>
595
+ </li>
596
+
597
+
598
+ <li>
599
+ <a href="/docs/pagination/">
600
+ Pagination
601
+ </a>
602
+ </li>
603
+
604
+ </ul>
605
+
606
+ <h4>Guides</h4>
607
+ <ul>
608
+
609
+
610
+ <li>
611
+ <a href="/docs/plugins/">
612
+ Plugins
613
+ </a>
614
+ </li>
615
+
616
+
617
+ <li>
618
+ <a href="/docs/migrations/">
619
+ Blog Migrations
620
+ </a>
621
+ </li>
622
+
623
+
624
+ <li>
625
+ <a href="/docs/upgrading/">
626
+ Upgrading
627
+ </a>
628
+ </li>
629
+
630
+
631
+ <li>
632
+ <a href="/docs/deployment/">
633
+ Deployment
634
+ </a>
635
+ </li>
636
+
637
+ </ul>
638
+
639
+ </aside>
640
+ </div>
641
+
642
+
643
+ <div class="clear"></div>
644
+
645
+ </div>
646
+ </section>
647
+
648
+
649
+ <footer>
650
+ <div class="grid">
651
+ <div class="unit one-third center-on-mobiles">
652
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
653
+ <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>
654
+ </div>
655
+ <div class="unit two-thirds align-right center-on-mobiles">
656
+ <p>
657
+ Proudly hosted by
658
+ <a href="https://github.com">
659
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
660
+ </a>
661
+ </p>
662
+ </div>
663
+ <div class="unit two-thirds align-right center-on-mobiles">
664
+ <p>
665
+ Jekyll is funded thanks to its
666
+ <a href="https://github.com/jekyll/jekyll#sponsors">
667
+ sponsors!
668
+ </a>
669
+ </p>
670
+ </div>
671
+ </div>
672
+ </footer>
673
+
674
+ <script>
675
+ var anchorForId = function (id) {
676
+ var anchor = document.createElement("a");
677
+ anchor.className = "header-link";
678
+ anchor.href = "#" + id;
679
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
680
+ anchor.title = "Permalink";
681
+ return anchor;
682
+ };
683
+
684
+ var linkifyAnchors = function (level, containingElement) {
685
+ var headers = containingElement.getElementsByTagName("h" + level);
686
+ for (var h = 0; h < headers.length; h++) {
687
+ var header = headers[h];
688
+
689
+ if (typeof header.id !== "undefined" && header.id !== "") {
690
+ header.appendChild(anchorForId(header.id));
691
+ }
692
+ }
693
+ };
694
+
695
+ document.onreadystatechange = function () {
696
+ if (this.readyState === "complete") {
697
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
698
+ if (!contentBlock) {
699
+ return;
700
+ }
701
+ for (var level = 1; level <= 6; level++) {
702
+ linkifyAnchors(level, contentBlock);
703
+ }
704
+ }
705
+ };
706
+ </script>
707
+
708
+
709
+ <!-- Google Analytics (https://www.google.com/analytics) -->
710
+ <script>
711
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
712
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
713
+ L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
714
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
715
+
716
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
717
+ ga('send', 'pageview');
718
+
719
+ </script>
720
+
721
+
722
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
723
+ <script type="text/javascript"> docsearch({
724
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
725
+ indexName: 'jekyllrb',
726
+ inputSelector: '#docsearch-input',
727
+ enhancedSearchInput: true,
728
+ debug: false // Set debug to true if you want to inspect the dropdown
729
+ });
730
+ </script>
731
+
732
+ </body>
733
+ </html>