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
@@ -1,822 +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>Directory structure | Jekyll • Simple, blog-aware, static sites</title>
15
- <meta property="og:title" content="Directory structure">
16
- <meta property="og:locale" content="en_US">
17
- <meta name="description" content="Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product.">
18
- <meta property="og:description" content="Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product.">
19
- <link rel="canonical" href="https://jekyllrb.com/docs/structure/">
20
- <meta property="og:url" content="https://jekyllrb.com/docs/structure/">
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":"Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or a series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files; the static web site is the final product.","url":"https://jekyllrb.com/docs/structure/","headline":"Directory structure","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/structure/"},"@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/structure.md"><i class="fa fa-pencil"></i>  Improve this page</a>
288
- </div>
289
- <h1>Directory structure</h1>
290
- <p>Jekyll is, at its core, a text transformation engine. The concept behind the
291
- system is this: you give it text written in your favorite markup language, be
292
- that Markdown, Textile, or just plain HTML, and it churns that through a layout
293
- or a series of layout files. Throughout that process you can tweak how you want
294
- the site URLs to look, what data gets displayed in the layout, and more. This
295
- is all done through editing text files; the static web site is the final
296
- product.</p>
297
-
298
- <p>A basic Jekyll site usually looks something like this:</p>
299
-
300
- <div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">.</span>
301
- ├── _config.yml
302
- ├── _data
303
- | └── members.yml
304
- ├── _drafts
305
- | ├── begin-with-the-crazy-ideas.md
306
- | └── on-simplicity-in-technology.md
307
- ├── _includes
308
- | ├── footer.html
309
- | └── header.html
310
- ├── _layouts
311
- | ├── default.html
312
- | └── post.html
313
- ├── _posts
314
- | ├── 2007-10-29-why-every-programmer-should-play-nethack.md
315
- | └── 2009-04-26-barcamp-boston-4-roundup.md
316
- ├── _sass
317
- | ├── _base.scss
318
- | └── _layout.scss
319
- ├── _site
320
- ├── .jekyll-metadata
321
- └── index.html <span class="c"># can also be an 'index.md' with valid YAML Frontmatter</span>
322
- </code></pre></div></div>
323
-
324
- <div class="note info">
325
- <h5>Directory structure of Jekyll sites using gem-based themes</h5>
326
- <p>
327
- Starting <strong>Jekyll 3.2</strong>, a new Jekyll project bootstrapped with <code>jekyll new</code> uses <a href="../themes/">gem-based themes</a> to define the look of the site. This results in a lighter default directory structure : <code>_layouts</code>, <code>_includes</code> and <code>_sass</code> are stored in the theme-gem, by default.
328
- </p>
329
- <br>
330
- <p>
331
- <a href="https://github.com/jekyll/minima">minima</a> is the current default theme, and <code>bundle show minima</code> will show you where minima theme's files are stored on your computer.
332
- </p>
333
- </div>
334
-
335
- <p>An overview of what each of these does:</p>
336
-
337
- <div class="mobile-side-scroller">
338
- <table>
339
- <thead>
340
- <tr>
341
- <th>File / Directory</th>
342
- <th>Description</th>
343
- </tr>
344
- </thead>
345
- <tbody>
346
- <tr>
347
- <td>
348
- <p><code>_config.yml</code></p>
349
- </td>
350
- <td>
351
- <p>
352
- Stores <a href="../configuration/">configuration</a> data. Many of
353
- these options can be specified from the command line executable but
354
- it’s easier to specify them here so you don’t have to remember them.
355
- </p>
356
- </td>
357
- </tr>
358
- <tr>
359
- <td>
360
- <p><code>_drafts</code></p>
361
- </td>
362
- <td>
363
- <p>
364
- Drafts are unpublished posts. The format of these files is without a
365
- date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
366
- work with drafts</a>.
367
- </p>
368
- </td>
369
- </tr>
370
- <tr>
371
- <td>
372
- <p><code>_includes</code></p>
373
- </td>
374
- <td>
375
- <p>
376
- These are the partials that can be mixed and matched by your layouts
377
- and posts to facilitate reuse. The liquid tag
378
- <code>{% include file.ext %}</code>
379
- can be used to include the partial in
380
- <code>_includes/file.ext</code>.
381
- </p>
382
- </td>
383
- </tr>
384
- <tr>
385
- <td>
386
- <p><code>_layouts</code></p>
387
- </td>
388
- <td>
389
- <p>
390
- These are the templates that wrap posts. Layouts are chosen on a
391
- post-by-post basis in the
392
- <a href="../frontmatter/">YAML Front Matter</a>,
393
- which is described in the next section. The liquid tag
394
- <code>{{ content }}</code>
395
- is used to inject content into the web page.
396
- </p>
397
- </td>
398
- </tr>
399
- <tr>
400
- <td>
401
- <p><code>_posts</code></p>
402
- </td>
403
- <td>
404
- <p>
405
- Your dynamic content, so to speak. The naming convention of these
406
- files is important, and must follow the format:
407
- <code>YEAR-MONTH-DAY-title.MARKUP</code>.
408
- The <a href="../permalinks/">permalinks</a> can be customized for
409
- each post, but the date and markup language are determined solely by
410
- the file name.
411
- </p>
412
- </td>
413
- </tr>
414
- <tr>
415
- <td>
416
- <p><code>_data</code></p>
417
- </td>
418
- <td>
419
- <p>
420
- Well-formatted site data should be placed here. The Jekyll engine
421
- will autoload all data files (using either the <code>.yml</code>,
422
- <code>.yaml</code>, <code>.json</code> or <code>.csv</code>
423
- formats and extensions) in this directory, and they will be
424
- accessible via `site.data`. If there's a file
425
- <code>members.yml</code> under the directory, then you can access
426
- contents of the file through <code>site.data.members</code>.
427
- </p>
428
- </td>
429
- </tr>
430
- <tr>
431
- <td>
432
- <p><code>_sass</code></p>
433
- </td>
434
- <td>
435
- <p>
436
- These are sass partials that can be imported into your <code>main.scss</code>
437
- which will then be processed into a single stylesheet
438
- <code>main.css</code> that defines the styles to be used by your site.
439
- </p>
440
- </td>
441
- </tr>
442
- <tr>
443
- <td>
444
- <p><code>_site</code></p>
445
- </td>
446
- <td>
447
- <p>
448
- This is where the generated site will be placed (by default) once
449
- Jekyll is done transforming it. It’s probably a good idea to add this
450
- to your <code>.gitignore</code> file.
451
- </p>
452
- </td>
453
- </tr>
454
- <tr>
455
- <td>
456
- <p><code>.jekyll-metadata</code></p>
457
- </td>
458
- <td>
459
- <p>
460
- This helps Jekyll keep track of which files have not been modified
461
- since the site was last built, and which files will need to be
462
- regenerated on the next build. This file will not be included in the
463
- generated site. It’s probably a good idea to add this to your
464
- <code>.gitignore</code> file.
465
- </p>
466
- </td>
467
- </tr>
468
- <tr>
469
- <td>
470
- <p><code>index.html</code> or <code>index.md</code> and other HTML,
471
- Markdown, Textile files</p>
472
- </td>
473
- <td>
474
- <p>
475
- Provided that the file has a <a href="../frontmatter/">YAML Front
476
- Matter</a> section, it will be transformed by Jekyll. The same will
477
- happen for any <code>.html</code>, <code>.markdown</code>,
478
- <code>.md</code>, or <code>.textile</code> file in your site’s root
479
- directory or directories not listed above.
480
- </p>
481
- </td>
482
- </tr>
483
- <tr>
484
- <td>
485
- <p>Other Files/Folders</p>
486
- </td>
487
- <td>
488
- <p>
489
- Every other directory and file except for those listed above—such as
490
- <code>css</code> and <code>images</code> folders,
491
- <code>favicon.ico</code> files, and so forth—will be copied verbatim
492
- to the generated site. There are plenty of <a href="../sites/">sites
493
- already using Jekyll</a> if you’re curious to see how they’re laid
494
- out.
495
- </p>
496
- </td>
497
- </tr>
498
- </tbody>
499
- </table>
500
- </div>
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
- <div class="section-nav">
526
- <div class="left align-right">
527
-
528
-
529
-
530
- <a href="/docs/usage/" class="prev">Back</a>
531
-
532
- </div>
533
- <div class="right align-left">
534
-
535
-
536
-
537
- <a href="/docs/configuration/" class="next">Next</a>
538
-
539
- </div>
540
- </div>
541
- <div class="clear"></div>
542
-
543
- </article>
544
- </div>
545
-
546
- <div class="unit one-fifth hide-on-mobiles">
547
- <aside>
548
-
549
- <h4>Getting Started</h4>
550
- <ul>
551
-
552
-
553
-
554
- <li class=""><a href="/docs/home/">Welcome</a></li>
555
-
556
-
557
-
558
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
559
-
560
-
561
-
562
- <li class=""><a href="/docs/installation/">Installation</a></li>
563
-
564
-
565
-
566
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
567
-
568
-
569
-
570
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
571
-
572
-
573
-
574
- <li class="current"><a href="/docs/structure/">Directory structure</a></li>
575
-
576
-
577
-
578
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
579
-
580
- </ul>
581
-
582
-
583
- <h4>Your Content</h4>
584
- <ul>
585
-
586
-
587
-
588
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
589
-
590
-
591
-
592
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
593
-
594
-
595
-
596
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
597
-
598
-
599
-
600
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
601
-
602
-
603
-
604
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
605
-
606
-
607
-
608
- <li class=""><a href="/docs/variables/">Variables</a></li>
609
-
610
-
611
-
612
- <li class=""><a href="/docs/collections/">Collections</a></li>
613
-
614
-
615
-
616
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
617
-
618
-
619
-
620
- <li class=""><a href="/docs/assets/">Assets</a></li>
621
-
622
-
623
-
624
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
625
-
626
- </ul>
627
-
628
-
629
- <h4>Customization</h4>
630
- <ul>
631
-
632
-
633
-
634
- <li class=""><a href="/docs/templates/">Templates</a></li>
635
-
636
-
637
-
638
- <li class=""><a href="/docs/includes/">Includes</a></li>
639
-
640
-
641
-
642
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
643
-
644
-
645
-
646
- <li class=""><a href="/docs/pagination/">Pagination</a></li>
647
-
648
-
649
-
650
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
651
-
652
-
653
-
654
- <li class=""><a href="/docs/themes/">Themes</a></li>
655
-
656
-
657
-
658
- <li class=""><a href="/docs/extras/">Extras</a></li>
659
-
660
- </ul>
661
-
662
-
663
- <h4>Deployment</h4>
664
- <ul>
665
-
666
-
667
-
668
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
669
-
670
-
671
-
672
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
673
-
674
-
675
-
676
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
677
-
678
- </ul>
679
-
680
-
681
- <h4>Miscellaneous</h4>
682
- <ul>
683
-
684
-
685
-
686
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
687
-
688
-
689
-
690
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
691
-
692
-
693
-
694
- <li class=""><a href="/docs/resources/">Resources</a></li>
695
-
696
-
697
-
698
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
699
-
700
-
701
-
702
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
703
-
704
- </ul>
705
-
706
-
707
- <h4>Meta</h4>
708
- <ul>
709
-
710
-
711
-
712
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
713
-
714
-
715
-
716
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
717
-
718
-
719
-
720
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
721
-
722
-
723
-
724
- <li class=""><a href="/docs/history/">History</a></li>
725
-
726
- </ul>
727
-
728
-
729
- </aside>
730
- </div>
731
-
732
-
733
- <div class="clear"></div>
734
-
735
- </div>
736
- </section>
737
-
738
-
739
- <footer>
740
- <div class="grid">
741
- <div class="unit one-third center-on-mobiles">
742
- <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>
743
- </div>
744
- <div class="unit two-thirds align-right center-on-mobiles">
745
- <p>
746
- Proudly hosted by
747
- <a href="https://github.com">
748
- <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
749
- </a>
750
- </p>
751
- </div>
752
- </div>
753
- </footer>
754
-
755
- <script>
756
- var anchorForId = function (id) {
757
- var anchor = document.createElement("a");
758
- anchor.className = "header-link";
759
- anchor.href = "#" + id;
760
- anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
761
- anchor.title = "Permalink";
762
- return anchor;
763
- };
764
-
765
- var linkifyAnchors = function (level, containingElement) {
766
- var headers = containingElement.getElementsByTagName("h" + level);
767
- for (var h = 0; h < headers.length; h++) {
768
- var header = headers[h];
769
-
770
- if (typeof header.id !== "undefined" && header.id !== "") {
771
- header.appendChild(anchorForId(header.id));
772
- }
773
- }
774
- };
775
-
776
- document.onreadystatechange = function () {
777
- if (this.readyState === "complete") {
778
- var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
779
- if (!contentBlock) {
780
- return;
781
- }
782
- for (var level = 1; level <= 6; level++) {
783
- linkifyAnchors(level, contentBlock);
784
- }
785
- }
786
- };
787
- </script>
788
-
789
-
790
- <!-- Gauges (http://get.gaug.es/) -->
791
- <script>
792
- var _gauges = _gauges || [];
793
- (function() {
794
- var t = document.createElement('script');
795
- t.type = 'text/javascript';
796
- t.async = true;
797
- t.id = 'gauges-tracker';
798
- t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
799
- t.src = '//secure.gaug.es/track.js';
800
- var s = document.getElementsByTagName('script')[0];
801
- s.parentNode.insertBefore(t, s);
802
- })();
803
- </script>
804
-
805
-
806
-
807
- <!-- Google Analytics (https://www.google.com/analytics) -->
808
- <script>
809
- !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
810
- (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
811
- L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
812
- L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
813
-
814
- ga('create', 'UA-50755011-1', 'jekyllrb.com');
815
- ga('send', 'pageview');
816
-
817
- </script>
818
-
819
-
820
-
821
- </body>
822
- </html>