jekyll-docs 3.6.0 → 3.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (253) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll.rb +195 -0
  3. data/lib/jekyll/cleaner.rb +110 -0
  4. data/lib/jekyll/collection.rb +230 -0
  5. data/lib/jekyll/command.rb +78 -0
  6. data/lib/jekyll/commands/build.rb +102 -0
  7. data/lib/jekyll/commands/clean.rb +43 -0
  8. data/lib/jekyll/commands/doctor.rb +153 -0
  9. data/lib/jekyll/commands/help.rb +34 -0
  10. data/lib/jekyll/commands/new.rb +156 -0
  11. data/lib/jekyll/commands/new_theme.rb +40 -0
  12. data/lib/jekyll/commands/serve.rb +245 -0
  13. data/lib/jekyll/commands/serve/servlet.rb +62 -0
  14. data/lib/jekyll/configuration.rb +410 -0
  15. data/lib/jekyll/converter.rb +54 -0
  16. data/lib/jekyll/converters/identity.rb +23 -0
  17. data/lib/jekyll/converters/markdown.rb +104 -0
  18. data/lib/jekyll/converters/markdown/kramdown_parser.rb +123 -0
  19. data/lib/jekyll/converters/markdown/rdiscount_parser.rb +35 -0
  20. data/lib/jekyll/converters/markdown/redcarpet_parser.rb +108 -0
  21. data/lib/jekyll/converters/smartypants.rb +36 -0
  22. data/lib/jekyll/convertible.rb +251 -0
  23. data/lib/jekyll/deprecator.rb +52 -0
  24. data/lib/jekyll/document.rb +507 -0
  25. data/lib/jekyll/drops/collection_drop.rb +22 -0
  26. data/lib/jekyll/drops/document_drop.rb +69 -0
  27. data/lib/jekyll/drops/drop.rb +214 -0
  28. data/lib/jekyll/drops/excerpt_drop.rb +15 -0
  29. data/lib/jekyll/drops/jekyll_drop.rb +33 -0
  30. data/lib/jekyll/drops/site_drop.rb +47 -0
  31. data/lib/jekyll/drops/static_file_drop.rb +13 -0
  32. data/lib/jekyll/drops/unified_payload_drop.rb +25 -0
  33. data/lib/jekyll/drops/url_drop.rb +88 -0
  34. data/lib/jekyll/entry_filter.rb +123 -0
  35. data/lib/jekyll/errors.rb +20 -0
  36. data/lib/jekyll/excerpt.rb +126 -0
  37. data/lib/jekyll/external.rb +74 -0
  38. data/lib/jekyll/filters.rb +430 -0
  39. data/lib/jekyll/filters/grouping_filters.rb +65 -0
  40. data/lib/jekyll/filters/url_filters.rb +60 -0
  41. data/lib/jekyll/frontmatter_defaults.rb +197 -0
  42. data/lib/jekyll/generator.rb +5 -0
  43. data/lib/jekyll/hooks.rb +104 -0
  44. data/lib/jekyll/layout.rb +62 -0
  45. data/lib/jekyll/liquid_extensions.rb +24 -0
  46. data/lib/jekyll/liquid_renderer.rb +49 -0
  47. data/lib/jekyll/liquid_renderer/file.rb +56 -0
  48. data/lib/jekyll/liquid_renderer/table.rb +96 -0
  49. data/lib/jekyll/log_adapter.rb +147 -0
  50. data/lib/jekyll/mime.types +825 -0
  51. data/lib/jekyll/page.rb +187 -0
  52. data/lib/jekyll/plugin.rb +98 -0
  53. data/lib/jekyll/plugin_manager.rb +113 -0
  54. data/lib/jekyll/publisher.rb +23 -0
  55. data/lib/jekyll/reader.rb +134 -0
  56. data/lib/jekyll/readers/collection_reader.rb +22 -0
  57. data/lib/jekyll/readers/data_reader.rb +77 -0
  58. data/lib/jekyll/readers/layout_reader.rb +71 -0
  59. data/lib/jekyll/readers/page_reader.rb +25 -0
  60. data/lib/jekyll/readers/post_reader.rb +72 -0
  61. data/lib/jekyll/readers/static_file_reader.rb +25 -0
  62. data/lib/jekyll/readers/theme_assets_reader.rb +49 -0
  63. data/lib/jekyll/regenerator.rb +201 -0
  64. data/lib/jekyll/related_posts.rb +52 -0
  65. data/lib/jekyll/renderer.rb +269 -0
  66. data/lib/jekyll/site.rb +471 -0
  67. data/lib/jekyll/static_file.rb +162 -0
  68. data/lib/jekyll/stevenson.rb +61 -0
  69. data/lib/jekyll/tags/highlight.rb +141 -0
  70. data/lib/jekyll/tags/include.rb +215 -0
  71. data/lib/jekyll/tags/link.rb +37 -0
  72. data/lib/jekyll/tags/post_url.rb +103 -0
  73. data/lib/jekyll/theme.rb +68 -0
  74. data/lib/jekyll/theme_builder.rb +119 -0
  75. data/lib/jekyll/url.rb +161 -0
  76. data/lib/jekyll/utils.rb +337 -0
  77. data/lib/jekyll/utils/ansi.rb +59 -0
  78. data/lib/jekyll/utils/exec.rb +27 -0
  79. data/lib/jekyll/utils/platforms.rb +82 -0
  80. data/lib/jekyll/utils/rouge.rb +21 -0
  81. data/lib/jekyll/utils/win_tz.rb +75 -0
  82. data/lib/jekyll/version.rb +5 -0
  83. data/lib/site_template/404.html +24 -0
  84. data/lib/site_template/_config.yml +43 -0
  85. data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +25 -0
  86. data/lib/site_template/about.md +18 -0
  87. data/lib/site_template/index.md +6 -0
  88. data/lib/theme_template/CODE_OF_CONDUCT.md.erb +74 -0
  89. data/lib/theme_template/Gemfile +4 -0
  90. data/lib/theme_template/LICENSE.txt.erb +21 -0
  91. data/lib/theme_template/README.md.erb +52 -0
  92. data/lib/theme_template/_layouts/default.html +1 -0
  93. data/lib/theme_template/_layouts/page.html +5 -0
  94. data/lib/theme_template/_layouts/post.html +5 -0
  95. data/lib/theme_template/example/_config.yml.erb +1 -0
  96. data/lib/theme_template/example/_post.md +12 -0
  97. data/lib/theme_template/example/index.html +14 -0
  98. data/lib/theme_template/example/style.scss +7 -0
  99. data/lib/theme_template/gitignore.erb +5 -0
  100. data/lib/theme_template/theme.gemspec.erb +19 -0
  101. metadata +103 -156
  102. data/lib/jekyll-docs.rb +0 -31
  103. data/site/404.html +0 -153
  104. data/site/CNAME +0 -1
  105. data/site/community/index.html +0 -299
  106. data/site/conduct/index.html +0 -10
  107. data/site/css/screen.css +0 -1
  108. data/site/docs/assets/index.html +0 -724
  109. data/site/docs/code_of_conduct/index.html +0 -730
  110. data/site/docs/collections/index.html +0 -1097
  111. data/site/docs/conduct/index.html +0 -744
  112. data/site/docs/configuration/index.html +0 -1403
  113. data/site/docs/continuous-integration/buddyworks/index.html +0 -726
  114. data/site/docs/continuous-integration/circleci/index.html +0 -757
  115. data/site/docs/continuous-integration/index.html +0 -681
  116. data/site/docs/continuous-integration/travis-ci/index.html +0 -891
  117. data/site/docs/contributing/index.html +0 -863
  118. data/site/docs/datafiles/index.html +0 -780
  119. data/site/docs/deployment-methods/index.html +0 -875
  120. data/site/docs/drafts/index.html +0 -636
  121. data/site/docs/extras/index.html +0 -689
  122. data/site/docs/frontmatter/index.html +0 -807
  123. data/site/docs/github-pages/index.html +0 -819
  124. data/site/docs/history/index.html +0 -3955
  125. data/site/docs/home/index.html +0 -644
  126. data/site/docs/includes/index.html +0 -800
  127. data/site/docs/index.html +0 -10
  128. data/site/docs/installation/index.html +0 -732
  129. data/site/docs/maintaining/affinity-team-captain/index.html +0 -706
  130. data/site/docs/maintaining/avoiding-burnout/index.html +0 -709
  131. data/site/docs/maintaining/becoming-a-maintainer/index.html +0 -717
  132. data/site/docs/maintaining/index.html +0 -713
  133. data/site/docs/maintaining/merging-a-pull-request/index.html +0 -747
  134. data/site/docs/maintaining/reviewing-a-pull-request/index.html +0 -725
  135. data/site/docs/maintaining/special-labels/index.html +0 -705
  136. data/site/docs/maintaining/triaging-an-issue/index.html +0 -735
  137. data/site/docs/migrations/index.html +0 -647
  138. data/site/docs/pages/index.html +0 -695
  139. data/site/docs/pagination/index.html +0 -870
  140. data/site/docs/permalinks/index.html +0 -1027
  141. data/site/docs/plugins/index.html +0 -1800
  142. data/site/docs/posts/index.html +0 -858
  143. data/site/docs/quickstart/index.html +0 -650
  144. data/site/docs/resources/index.html +0 -769
  145. data/site/docs/sites/index.html +0 -702
  146. data/site/docs/static-files/index.html +0 -720
  147. data/site/docs/structure/index.html +0 -822
  148. data/site/docs/templates/index.html +0 -1208
  149. data/site/docs/themes/index.html +0 -935
  150. data/site/docs/troubleshooting/index.html +0 -893
  151. data/site/docs/upgrading/0-to-2/index.html +0 -826
  152. data/site/docs/upgrading/2-to-3/index.html +0 -824
  153. data/site/docs/upgrading/index.html +0 -693
  154. data/site/docs/usage/index.html +0 -705
  155. data/site/docs/variables/index.html +0 -1048
  156. data/site/docs/windows/index.html +0 -799
  157. data/site/favicon.ico +0 -0
  158. data/site/feed.xml +0 -372
  159. data/site/fonts/FontAwesome.eot +0 -0
  160. data/site/fonts/FontAwesome.svg +0 -12
  161. data/site/fonts/FontAwesome.ttf +0 -0
  162. data/site/fonts/FontAwesome.woff +0 -0
  163. data/site/github.html +0 -10
  164. data/site/help/index.html +0 -244
  165. data/site/icomoon-selection.json +0 -96
  166. data/site/img/article-footer.png +0 -0
  167. data/site/img/footer-arrow.png +0 -0
  168. data/site/img/footer-logo.png +0 -0
  169. data/site/img/jekyll-sticker.jpg +0 -0
  170. data/site/img/jekylllayoutconcept.png +0 -0
  171. data/site/img/logo-2x.png +0 -0
  172. data/site/img/logo-rss.png +0 -0
  173. data/site/img/octojekyll.png +0 -0
  174. data/site/index.html +0 -267
  175. data/site/issues.html +0 -10
  176. data/site/js/html5shiv.min.js +0 -4
  177. data/site/js/respond.min.js +0 -5
  178. data/site/latest_version.txt +0 -1
  179. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +0 -570
  180. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +0 -570
  181. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +0 -571
  182. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +0 -568
  183. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +0 -570
  184. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +0 -569
  185. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +0 -565
  186. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +0 -565
  187. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +0 -572
  188. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +0 -566
  189. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +0 -564
  190. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +0 -599
  191. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +0 -568
  192. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +0 -583
  193. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +0 -565
  194. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +0 -564
  195. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +0 -573
  196. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +0 -564
  197. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +0 -569
  198. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +0 -585
  199. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +0 -565
  200. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +0 -567
  201. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +0 -582
  202. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +0 -579
  203. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +0 -568
  204. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +0 -588
  205. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +0 -574
  206. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +0 -597
  207. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +0 -575
  208. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +0 -565
  209. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +0 -572
  210. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +0 -567
  211. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +0 -568
  212. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +0 -588
  213. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +0 -563
  214. data/site/news/2015/10/26/jekyll-3-0-released/index.html +0 -592
  215. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +0 -576
  216. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +0 -566
  217. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +0 -599
  218. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +0 -583
  219. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +0 -578
  220. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +0 -569
  221. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +0 -565
  222. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +0 -571
  223. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +0 -566
  224. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +0 -572
  225. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +0 -576
  226. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +0 -564
  227. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +0 -566
  228. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +0 -567
  229. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +0 -676
  230. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +0 -571
  231. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +0 -566
  232. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +0 -645
  233. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +0 -569
  234. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +0 -592
  235. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +0 -649
  236. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +0 -598
  237. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +0 -594
  238. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +0 -589
  239. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +0 -569
  240. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +0 -573
  241. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +0 -565
  242. data/site/news/index.html +0 -3609
  243. data/site/news/releases/index.html +0 -3344
  244. data/site/philosophy.html +0 -46
  245. data/site/readme.md +0 -23
  246. data/site/robots.txt +0 -1
  247. data/site/sitemap.xml +0 -485
  248. data/site/tutorials/convert-site-to-jekyll/index.html +0 -793
  249. data/site/tutorials/custom-404-page/index.html +0 -358
  250. data/site/tutorials/home/index.html +0 -323
  251. data/site/tutorials/index.html +0 -10
  252. data/site/tutorials/navigation/index.html +0 -872
  253. data/site/tutorials/orderofinterpretation/index.html +0 -441
data/site/docs/index.html DELETED
@@ -1,10 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en-US">
3
- <meta charset="utf-8">
4
- <title>Redirecting…</title>
5
- <link rel="canonical" href="https://jekyllrb.com/docs/home/">
6
- <meta http-equiv="refresh" content="0; url=https://jekyllrb.com/docs/home/">
7
- <h1>Redirecting…</h1>
8
- <a href="https://jekyllrb.com/docs/home/">Click here if you are not redirected.</a>
9
- <script>location="https://jekyllrb.com/docs/home/"</script>
10
- </html>
@@ -1,732 +0,0 @@
1
- <!DOCTYPE HTML>
2
- <html lang="en-US">
3
- <head>
4
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
- <meta charset="UTF-8">
6
- <meta name="viewport" content="width=device-width,initial-scale=1">
7
- <meta name="generator" content="Jekyll v3.6.0">
8
- <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
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="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
11
- <link rel="stylesheet" href="/css/screen.css">
12
- <link rel="icon" type="image/x-icon" href="/favicon.ico">
13
- <!-- Begin Jekyll SEO tag v2.3.0 -->
14
- <title>Installation | Jekyll • Simple, blog-aware, static sites</title>
15
- <meta property="og:title" content="Installation">
16
- <meta property="og:locale" content="en_US">
17
- <meta name="description" content="Getting Jekyll installed and ready-to-go should only take a few minutes. If it ever becomes a pain, please file an issue (or submit a pull request) describing the issue you encountered and how we might make the process easier.">
18
- <meta property="og:description" content="Getting Jekyll installed and ready-to-go should only take a few minutes. If it ever becomes a pain, please file an issue (or submit a pull request) describing the issue you encountered and how we might make the process easier.">
19
- <link rel="canonical" href="https://jekyllrb.com/docs/installation/">
20
- <meta property="og:url" content="https://jekyllrb.com/docs/installation/">
21
- <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
22
- <meta property="og:type" content="article">
23
- <meta property="article:published_time" content="2017-10-24T08:07:43-07:00">
24
- <meta name="twitter:card" content="summary">
25
- <meta name="twitter:site" content="@jekyllrb">
26
- <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
27
- <script type="application/ld+json">
28
- {"name":null,"description":"Getting Jekyll installed and ready-to-go should only take a few minutes. If it ever becomes a pain, please file an issue (or submit a pull request) describing the issue you encountered and how we might make the process easier.","url":"https://jekyllrb.com/docs/installation/","headline":"Installation","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/installation/"},"@context":"http://schema.org"}</script>
29
- <!-- End Jekyll SEO tag -->
30
-
31
- <!--[if lt IE 9]>
32
- <script src="/js/html5shiv.min.js"></script>
33
- <script src="/js/respond.min.js"></script>
34
- <![endif]-->
35
- </head>
36
-
37
-
38
- <body class="wrap">
39
- <header>
40
- <nav class="mobile-nav show-on-mobiles">
41
- <ul>
42
- <li class="">
43
- <a href="/">Home</a>
44
- </li>
45
- <li class="current">
46
- <a href="/docs/home/">Docs</a>
47
- </li>
48
- <li class="">
49
- <a href="/news/">News</a>
50
- </li>
51
- <li class="">
52
- <a href="/community/">Community</a>
53
- </li>
54
- <li class="">
55
- <a href="/help/">Help</a>
56
- </li>
57
- <li>
58
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
59
- </li>
60
- </ul>
61
-
62
- </nav>
63
- <div class="grid">
64
- <div class="unit one-third center-on-mobiles">
65
- <h1>
66
- <a href="/">
67
- <span class="sr-only">Jekyll</span>
68
- <img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
69
- </a>
70
- </h1>
71
- </div>
72
- <nav class="main-nav unit two-thirds hide-on-mobiles">
73
- <ul>
74
- <li class="">
75
- <a href="/">Home</a>
76
- </li>
77
- <li class="current">
78
- <a href="/docs/home/">Docs</a>
79
- </li>
80
- <li class="">
81
- <a href="/news/">News</a>
82
- </li>
83
- <li class="">
84
- <a href="/community/">Community</a>
85
- </li>
86
- <li class="">
87
- <a href="/help/">Help</a>
88
- </li>
89
- <li>
90
- <a href="https://github.com/jekyll/jekyll">GitHub</a>
91
- </li>
92
- </ul>
93
-
94
- </nav>
95
- </div>
96
- </header>
97
-
98
-
99
- <section class="docs">
100
- <div class="grid">
101
-
102
- <div class="docs-nav-mobile unit whole show-on-mobiles">
103
- <select onchange="if (this.value) window.location.href=this.value">
104
- <option value="">Navigate the docs…</option>
105
-
106
- <optgroup label="Getting Started">
107
-
108
-
109
-
110
- <option value="/docs/home/">Welcome</option>
111
-
112
-
113
-
114
- <option value="/docs/quickstart/">Quick-start guide</option>
115
-
116
-
117
-
118
- <option value="/docs/installation/">Installation</option>
119
-
120
-
121
-
122
- <option value="/docs/windows/">Jekyll on Windows</option>
123
-
124
-
125
-
126
- <option value="/docs/usage/">Basic Usage</option>
127
-
128
-
129
-
130
- <option value="/docs/structure/">Directory structure</option>
131
-
132
-
133
-
134
- <option value="/docs/configuration/">Configuration</option>
135
-
136
-
137
- </optgroup>
138
-
139
- <optgroup label="Your Content">
140
-
141
-
142
-
143
- <option value="/docs/frontmatter/">Front Matter</option>
144
-
145
-
146
-
147
- <option value="/docs/posts/">Writing posts</option>
148
-
149
-
150
-
151
- <option value="/docs/drafts/">Working with drafts</option>
152
-
153
-
154
-
155
- <option value="/docs/pages/">Creating pages</option>
156
-
157
-
158
-
159
- <option value="/docs/static-files/">Static Files</option>
160
-
161
-
162
-
163
- <option value="/docs/variables/">Variables</option>
164
-
165
-
166
-
167
- <option value="/docs/collections/">Collections</option>
168
-
169
-
170
-
171
- <option value="/docs/datafiles/">Data Files</option>
172
-
173
-
174
-
175
- <option value="/docs/assets/">Assets</option>
176
-
177
-
178
-
179
- <option value="/docs/migrations/">Blog migrations</option>
180
-
181
-
182
- </optgroup>
183
-
184
- <optgroup label="Customization">
185
-
186
-
187
-
188
- <option value="/docs/templates/">Templates</option>
189
-
190
-
191
-
192
- <option value="/docs/includes/">Includes</option>
193
-
194
-
195
-
196
- <option value="/docs/permalinks/">Permalinks</option>
197
-
198
-
199
-
200
- <option value="/docs/pagination/">Pagination</option>
201
-
202
-
203
-
204
- <option value="/docs/plugins/">Plugins</option>
205
-
206
-
207
-
208
- <option value="/docs/themes/">Themes</option>
209
-
210
-
211
-
212
- <option value="/docs/extras/">Extras</option>
213
-
214
-
215
- </optgroup>
216
-
217
- <optgroup label="Deployment">
218
-
219
-
220
-
221
- <option value="/docs/github-pages/">GitHub Pages</option>
222
-
223
-
224
-
225
- <option value="/docs/deployment-methods/">Deployment methods</option>
226
-
227
-
228
-
229
- <option value="/docs/continuous-integration/">Continuous Integration</option>
230
-
231
-
232
- </optgroup>
233
-
234
- <optgroup label="Miscellaneous">
235
-
236
-
237
-
238
- <option value="/docs/troubleshooting/">Troubleshooting</option>
239
-
240
-
241
-
242
- <option value="/docs/sites/">Sites using Jekyll</option>
243
-
244
-
245
-
246
- <option value="/docs/resources/">Resources</option>
247
-
248
-
249
-
250
- <option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
251
-
252
-
253
-
254
- <option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
255
-
256
-
257
- </optgroup>
258
-
259
- <optgroup label="Meta">
260
-
261
-
262
-
263
- <option value="/docs/contributing/">Contributing</option>
264
-
265
-
266
-
267
- <option value="/docs/maintaining/">Maintaining Jekyll</option>
268
-
269
-
270
-
271
- <option value="/docs/conduct/">Code of Conduct</option>
272
-
273
-
274
-
275
- <option value="/docs/history/">History</option>
276
-
277
-
278
- </optgroup>
279
-
280
- </select>
281
- </div>
282
-
283
-
284
- <div class="unit four-fifths">
285
- <article>
286
- <div class="improve right hide-on-mobiles">
287
- <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/installation.md"><i class="fa fa-pencil"></i>  Improve this page</a>
288
- </div>
289
- <h1>Installation</h1>
290
- <p>Getting Jekyll installed and ready-to-go should only take a few minutes.
291
- If it ever becomes a pain, please <a href="https://github.com/jekyll/jekyll/issues/new">file an issue</a>
292
- (or submit a pull request) describing the issue you
293
- encountered and how we might make the process easier.</p>
294
-
295
- <h3 id="requirements">Requirements</h3>
296
-
297
- <p>Installing Jekyll should be straight-forward if all requirements are met.
298
- Before you start, make sure your system has the following:</p>
299
-
300
- <ul>
301
- <li>GNU/Linux, Unix, or macOS</li>
302
- <li>
303
- <a href="https://www.ruby-lang.org/en/downloads/">Ruby</a> version 2.1 or above, including all development
304
- headers</li>
305
- <li><a href="https://rubygems.org/pages/download">RubyGems</a></li>
306
- <li>
307
- <a href="https://gcc.gnu.org/install/">GCC</a> and <a href="https://www.gnu.org/software/make/">Make</a> (in case your system doesn’t have them installed, which you can check by running <code class="highlighter-rouge">gcc -v</code> and <code class="highlighter-rouge">make -v</code> in your system’s command line interface)</li>
308
- </ul>
309
-
310
- <h4 id="only-required-for-jekyll-2-and-earlier">Only required for Jekyll 2 and earlier</h4>
311
-
312
- <ul>
313
- <li>
314
- <a href="https://nodejs.org/">NodeJS</a>, or another JavaScript runtime (for CoffeeScript support).</li>
315
- <li><a href="https://www.python.org/downloads/">Python 2.7</a></li>
316
- </ul>
317
-
318
- <div class="note info">
319
- <h5>Problems installing Jekyll?</h5>
320
- <p>
321
- Check out the <a href="../troubleshooting/">troubleshooting</a> page or
322
- <a href="https://github.com/jekyll/jekyll/issues/new">report an issue</a> so the
323
- Jekyll community can improve the experience for everyone.
324
- </p>
325
- </div>
326
-
327
- <div class="note info">
328
- <h5>Running Jekyll on Windows</h5>
329
- <p>
330
- While Windows is not officially supported, it is possible to get Jekyll running
331
- on Windows. Special instructions can be found on our
332
- <a href="../windows/#installation">Windows-specific docs page</a>.
333
- </p>
334
- </div>
335
-
336
- <h2 id="install-with-rubygems">Install with RubyGems</h2>
337
-
338
- <p>The best way to install Jekyll is via
339
- <a href="https://rubygems.org/pages/download">RubyGems</a>. At the terminal prompt,
340
- simply run the following command to install Jekyll:</p>
341
-
342
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>gem install jekyll
343
- </code></pre></div></div>
344
-
345
- <p>All of Jekyll’s gem dependencies are automatically installed by the above
346
- command, so you won’t have to worry about them at all.</p>
347
-
348
- <div class="note info">
349
- <h5>Installing Xcode Command-Line Tools</h5>
350
- <p>
351
- If you run into issues installing Jekyll's dependencies which make use of
352
- native extensions and are using macOS, you will need to install Xcode
353
- and the Command-Line Tools it ships with. Download them in
354
- <code>Preferences → Downloads → Components</code>.
355
- </p>
356
- </div>
357
-
358
- <h2 id="pre-releases">Pre-releases</h2>
359
-
360
- <p>In order to install a pre-release, make sure you have all the requirements
361
- installed properly and run:</p>
362
-
363
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem install jekyll <span class="nt">--pre</span>
364
- </code></pre></div></div>
365
-
366
- <p>This will install the latest pre-release. If you want a particular pre-release,
367
- use the <code class="highlighter-rouge">-v</code> switch to indicate the version you’d like to install:</p>
368
-
369
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem install jekyll <span class="nt">-v</span> <span class="s1">'2.0.0.alpha.1'</span>
370
- </code></pre></div></div>
371
-
372
- <p>If you’d like to install a development version of Jekyll, the process is a bit
373
- more involved. This gives you the advantage of having the latest and greatest,
374
- but may be unstable.</p>
375
-
376
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>git clone git://github.com/jekyll/jekyll.git
377
- <span class="nv">$ </span><span class="nb">cd </span>jekyll
378
- <span class="nv">$ </span>script/bootstrap
379
- <span class="nv">$ </span>bundle <span class="nb">exec </span>rake build
380
- <span class="nv">$ </span><span class="nb">ls </span>pkg/<span class="k">*</span>.gem | head <span class="nt">-n</span> 1 | xargs gem install <span class="nt">-l</span>
381
- </code></pre></div></div>
382
-
383
- <h2 id="optional-extras">Optional Extras</h2>
384
-
385
- <p>There are a number of (optional) extra features that Jekyll supports that you
386
- may want to install, depending on how you plan to use Jekyll. These extras
387
- include LaTeX support, and the use of alternative content rendering engines.
388
- Check out <a href="../extras/">the extras page</a> for more information.</p>
389
-
390
- <div class="note">
391
- <h5>ProTip™: Enable Syntax Highlighting</h5>
392
- <p>
393
- If you’re the kind of person who is using Jekyll, then chances are you’ll
394
- want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
395
- or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
396
- <a href="../templates/#code-snippet-highlighting">check out how to
397
- do that</a> before you go any farther.
398
- </p>
399
- </div>
400
-
401
- <h2 id="already-have-jekyll">Already Have Jekyll?</h2>
402
-
403
- <p>Before you start developing with Jekyll, you may want to check that you’re up to date with the latest version. To find your version of Jekyll, run one of these commands:</p>
404
-
405
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll <span class="nt">--version</span>
406
- <span class="nv">$ </span>gem list jekyll
407
- </code></pre></div></div>
408
-
409
- <p>You can also use <a href="https://rubygems.org/gems/jekyll">RubyGems</a> to find the current versioning of any gem. But you can also use the <code class="highlighter-rouge">gem</code> command line tool:</p>
410
-
411
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>gem search jekyll <span class="nt">--remote</span>
412
- </code></pre></div></div>
413
-
414
- <p>and you’ll search for just the name <code class="highlighter-rouge">jekyll</code>, and in brackets will be latest version. Another way to check if you have the latest version is to run the command <code class="highlighter-rouge">gem outdated</code>. This will provide a list of all the gems on your system that need to be updated. If you aren’t running the latest version, run this command:</p>
415
-
416
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>gem update jekyll
417
- </code></pre></div></div>
418
-
419
- <p>Now that you’ve got everything up-to-date and installed, let’s get to work!</p>
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
429
-
430
-
431
-
432
-
433
-
434
-
435
- <div class="section-nav">
436
- <div class="left align-right">
437
-
438
-
439
-
440
- <a href="/docs/quickstart/" class="prev">Back</a>
441
-
442
- </div>
443
- <div class="right align-left">
444
-
445
-
446
-
447
- <a href="/docs/windows/" class="next">Next</a>
448
-
449
- </div>
450
- </div>
451
- <div class="clear"></div>
452
-
453
- </article>
454
- </div>
455
-
456
- <div class="unit one-fifth hide-on-mobiles">
457
- <aside>
458
-
459
- <h4>Getting Started</h4>
460
- <ul>
461
-
462
-
463
-
464
- <li class=""><a href="/docs/home/">Welcome</a></li>
465
-
466
-
467
-
468
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
469
-
470
-
471
-
472
- <li class="current"><a href="/docs/installation/">Installation</a></li>
473
-
474
-
475
-
476
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
477
-
478
-
479
-
480
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
481
-
482
-
483
-
484
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
485
-
486
-
487
-
488
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
489
-
490
- </ul>
491
-
492
-
493
- <h4>Your Content</h4>
494
- <ul>
495
-
496
-
497
-
498
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
499
-
500
-
501
-
502
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
503
-
504
-
505
-
506
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
507
-
508
-
509
-
510
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
511
-
512
-
513
-
514
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
515
-
516
-
517
-
518
- <li class=""><a href="/docs/variables/">Variables</a></li>
519
-
520
-
521
-
522
- <li class=""><a href="/docs/collections/">Collections</a></li>
523
-
524
-
525
-
526
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
527
-
528
-
529
-
530
- <li class=""><a href="/docs/assets/">Assets</a></li>
531
-
532
-
533
-
534
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
535
-
536
- </ul>
537
-
538
-
539
- <h4>Customization</h4>
540
- <ul>
541
-
542
-
543
-
544
- <li class=""><a href="/docs/templates/">Templates</a></li>
545
-
546
-
547
-
548
- <li class=""><a href="/docs/includes/">Includes</a></li>
549
-
550
-
551
-
552
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
553
-
554
-
555
-
556
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
557
-
558
-
559
-
560
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
561
-
562
-
563
-
564
- <li class=""><a href="/docs/themes/">Themes</a></li>
565
-
566
-
567
-
568
- <li class=""><a href="/docs/extras/">Extras</a></li>
569
-
570
- </ul>
571
-
572
-
573
- <h4>Deployment</h4>
574
- <ul>
575
-
576
-
577
-
578
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
579
-
580
-
581
-
582
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
583
-
584
-
585
-
586
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
587
-
588
- </ul>
589
-
590
-
591
- <h4>Miscellaneous</h4>
592
- <ul>
593
-
594
-
595
-
596
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
597
-
598
-
599
-
600
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
601
-
602
-
603
-
604
- <li class=""><a href="/docs/resources/">Resources</a></li>
605
-
606
-
607
-
608
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
609
-
610
-
611
-
612
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
613
-
614
- </ul>
615
-
616
-
617
- <h4>Meta</h4>
618
- <ul>
619
-
620
-
621
-
622
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
623
-
624
-
625
-
626
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
627
-
628
-
629
-
630
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
631
-
632
-
633
-
634
- <li class=""><a href="/docs/history/">History</a></li>
635
-
636
- </ul>
637
-
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>The contents of this website are <br>© 2017 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
653
- </div>
654
- <div class="unit two-thirds align-right center-on-mobiles">
655
- <p>
656
- Proudly hosted by
657
- <a href="https://github.com">
658
- <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
659
- </a>
660
- </p>
661
- </div>
662
- </div>
663
- </footer>
664
-
665
- <script>
666
- var anchorForId = function (id) {
667
- var anchor = document.createElement("a");
668
- anchor.className = "header-link";
669
- anchor.href = "#" + id;
670
- anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
671
- anchor.title = "Permalink";
672
- return anchor;
673
- };
674
-
675
- var linkifyAnchors = function (level, containingElement) {
676
- var headers = containingElement.getElementsByTagName("h" + level);
677
- for (var h = 0; h < headers.length; h++) {
678
- var header = headers[h];
679
-
680
- if (typeof header.id !== "undefined" && header.id !== "") {
681
- header.appendChild(anchorForId(header.id));
682
- }
683
- }
684
- };
685
-
686
- document.onreadystatechange = function () {
687
- if (this.readyState === "complete") {
688
- var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
689
- if (!contentBlock) {
690
- return;
691
- }
692
- for (var level = 1; level <= 6; level++) {
693
- linkifyAnchors(level, contentBlock);
694
- }
695
- }
696
- };
697
- </script>
698
-
699
-
700
- <!-- Gauges (http://get.gaug.es/) -->
701
- <script>
702
- var _gauges = _gauges || [];
703
- (function() {
704
- var t = document.createElement('script');
705
- t.type = 'text/javascript';
706
- t.async = true;
707
- t.id = 'gauges-tracker';
708
- t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
709
- t.src = '//secure.gaug.es/track.js';
710
- var s = document.getElementsByTagName('script')[0];
711
- s.parentNode.insertBefore(t, s);
712
- })();
713
- </script>
714
-
715
-
716
-
717
- <!-- Google Analytics (https://www.google.com/analytics) -->
718
- <script>
719
- !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
720
- (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
721
- L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
722
- L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
723
-
724
- ga('create', 'UA-50755011-1', 'jekyllrb.com');
725
- ga('send', 'pageview');
726
-
727
- </script>
728
-
729
-
730
-
731
- </body>
732
- </html>