jekyll-docs 3.1.6 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (211) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll-docs.rb +7 -13
  3. data/site/community/index.html +305 -0
  4. data/site/conduct/index.html +10 -0
  5. data/site/css/screen.css +1445 -0
  6. data/site/docs/assets/index.html +701 -0
  7. data/site/docs/collections/index.html +973 -0
  8. data/site/docs/conduct/index.html +718 -0
  9. data/site/docs/configuration/index.html +1337 -0
  10. data/site/docs/continuous-integration/index.html +846 -0
  11. data/site/docs/contributing/index.html +815 -0
  12. data/site/docs/datafiles/index.html +742 -0
  13. data/site/docs/deployment-methods/index.html +866 -0
  14. data/site/docs/drafts/index.html +615 -0
  15. data/site/docs/extras/index.html +656 -0
  16. data/site/docs/frontmatter/index.html +776 -0
  17. data/site/docs/github-pages/index.html +778 -0
  18. data/site/docs/history/index.html +3293 -0
  19. data/site/docs/home/index.html +627 -0
  20. data/site/docs/index.html +10 -0
  21. data/site/docs/installation/index.html +682 -0
  22. data/site/docs/migrations/index.html +627 -0
  23. data/site/docs/pages/index.html +698 -0
  24. data/site/docs/pagination/index.html +840 -0
  25. data/site/docs/permalinks/index.html +924 -0
  26. data/site/docs/plugins/index.html +1726 -0
  27. data/site/docs/posts/index.html +811 -0
  28. data/site/docs/quickstart/index.html +599 -0
  29. data/site/docs/resources/index.html +717 -0
  30. data/site/docs/sites/index.html +676 -0
  31. data/site/docs/static-files/index.html +655 -0
  32. data/site/docs/structure/index.html +794 -0
  33. data/site/docs/templates/index.html +1105 -0
  34. data/site/docs/themes/index.html +751 -0
  35. data/site/docs/troubleshooting/index.html +826 -0
  36. data/site/docs/upgrading/0-to-2/index.html +802 -0
  37. data/site/docs/upgrading/2-to-3/index.html +785 -0
  38. data/site/docs/upgrading/index.html +664 -0
  39. data/site/docs/usage/index.html +673 -0
  40. data/site/docs/variables/index.html +1013 -0
  41. data/site/docs/windows/index.html +775 -0
  42. data/site/feed.xml +222 -0
  43. data/site/github.html +10 -0
  44. data/site/help/index.html +246 -0
  45. data/site/img/article-footer.png +0 -0
  46. data/site/img/footer-logo.png +0 -0
  47. data/site/img/logo-2x.png +0 -0
  48. data/site/index.html +200 -16
  49. data/site/issues.html +10 -0
  50. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +524 -0
  51. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +524 -0
  52. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +525 -0
  53. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +522 -0
  54. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +524 -0
  55. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +523 -0
  56. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +519 -0
  57. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +519 -0
  58. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +526 -0
  59. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +520 -0
  60. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +518 -0
  61. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +553 -0
  62. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +522 -0
  63. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +537 -0
  64. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +519 -0
  65. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +518 -0
  66. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +527 -0
  67. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +518 -0
  68. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +523 -0
  69. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +539 -0
  70. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +519 -0
  71. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +521 -0
  72. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +536 -0
  73. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +533 -0
  74. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +522 -0
  75. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +542 -0
  76. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +528 -0
  77. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +551 -0
  78. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +529 -0
  79. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +519 -0
  80. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +526 -0
  81. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +521 -0
  82. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +522 -0
  83. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +542 -0
  84. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +517 -0
  85. data/site/news/2015/10/26/jekyll-3-0-released/index.html +546 -0
  86. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +530 -0
  87. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +520 -0
  88. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +553 -0
  89. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +537 -0
  90. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +532 -0
  91. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +523 -0
  92. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +519 -0
  93. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +525 -0
  94. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +521 -0
  95. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +526 -0
  96. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +530 -0
  97. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +518 -0
  98. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +520 -0
  99. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +521 -0
  100. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +630 -0
  101. data/site/news/index.html +2831 -10
  102. data/site/news/releases/index.html +2603 -10
  103. data/site/sitemap.xml +327 -0
  104. metadata +99 -111
  105. data/site/_config.yml +0 -25
  106. data/site/_data/docs.yml +0 -49
  107. data/site/_docs/assets.md +0 -94
  108. data/site/_docs/collections.md +0 -380
  109. data/site/_docs/conduct.md +0 -55
  110. data/site/_docs/configuration.md +0 -747
  111. data/site/_docs/continuous-integration.md +0 -221
  112. data/site/_docs/contributing.md +0 -124
  113. data/site/_docs/datafiles.md +0 -151
  114. data/site/_docs/deployment-methods.md +0 -213
  115. data/site/_docs/drafts.md +0 -20
  116. data/site/_docs/extras.md +0 -22
  117. data/site/_docs/frontmatter.md +0 -191
  118. data/site/_docs/github-pages.md +0 -133
  119. data/site/_docs/history.md +0 -2323
  120. data/site/_docs/index.md +0 -57
  121. data/site/_docs/installation.md +0 -106
  122. data/site/_docs/migrations.md +0 -9
  123. data/site/_docs/pages.md +0 -100
  124. data/site/_docs/pagination.md +0 -224
  125. data/site/_docs/permalinks.md +0 -308
  126. data/site/_docs/plugins.md +0 -903
  127. data/site/_docs/posts.md +0 -237
  128. data/site/_docs/quickstart.md +0 -26
  129. data/site/_docs/resources.md +0 -38
  130. data/site/_docs/sites.md +0 -23
  131. data/site/_docs/static_files.md +0 -52
  132. data/site/_docs/structure.md +0 -211
  133. data/site/_docs/templates.md +0 -451
  134. data/site/_docs/troubleshooting.md +0 -207
  135. data/site/_docs/upgrading.md +0 -10
  136. data/site/_docs/upgrading/0-to-2.md +0 -140
  137. data/site/_docs/upgrading/2-to-3.md +0 -126
  138. data/site/_docs/usage.md +0 -101
  139. data/site/_docs/variables.md +0 -390
  140. data/site/_docs/windows.md +0 -46
  141. data/site/_includes/analytics.html +0 -30
  142. data/site/_includes/anchor_links.html +0 -33
  143. data/site/_includes/docs_contents.html +0 -8
  144. data/site/_includes/docs_contents_mobile.html +0 -10
  145. data/site/_includes/docs_option.html +0 -11
  146. data/site/_includes/docs_ul.html +0 -17
  147. data/site/_includes/footer.html +0 -15
  148. data/site/_includes/header.html +0 -18
  149. data/site/_includes/news_contents.html +0 -33
  150. data/site/_includes/news_contents_mobile.html +0 -11
  151. data/site/_includes/news_item.html +0 -24
  152. data/site/_includes/primary-nav-items.html +0 -17
  153. data/site/_includes/section_nav.html +0 -39
  154. data/site/_includes/top.html +0 -17
  155. data/site/_layouts/default.html +0 -13
  156. data/site/_layouts/docs.html +0 -26
  157. data/site/_layouts/news.html +0 -19
  158. data/site/_layouts/news_item.html +0 -27
  159. data/site/_layouts/page.html +0 -18
  160. data/site/_posts/2013-05-06-jekyll-1-0-0-released.markdown +0 -23
  161. data/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown +0 -27
  162. data/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown +0 -28
  163. data/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown +0 -25
  164. data/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown +0 -27
  165. data/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown +0 -31
  166. data/site/_posts/2013-07-25-jekyll-1-0-4-released.markdown +0 -20
  167. data/site/_posts/2013-07-25-jekyll-1-1-2-released.markdown +0 -20
  168. data/site/_posts/2013-09-06-jekyll-1-2-0-released.markdown +0 -23
  169. data/site/_posts/2013-09-14-jekyll-1-2-1-released.markdown +0 -19
  170. data/site/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown +0 -17
  171. data/site/_posts/2013-11-04-jekyll-1-3-0-released.markdown +0 -43
  172. data/site/_posts/2013-11-26-jekyll-1-3-1-released.markdown +0 -21
  173. data/site/_posts/2013-12-07-jekyll-1-4-0-released.markdown +0 -30
  174. data/site/_posts/2013-12-09-jekyll-1-4-1-released.markdown +0 -18
  175. data/site/_posts/2013-12-16-jekyll-1-4-2-released.markdown +0 -18
  176. data/site/_posts/2014-01-13-jekyll-1-4-3-released.markdown +0 -26
  177. data/site/_posts/2014-03-24-jekyll-1-5-0-released.markdown +0 -19
  178. data/site/_posts/2014-03-27-jekyll-1-5-1-released.markdown +0 -26
  179. data/site/_posts/2014-05-06-jekyll-turns-2-0-0.markdown +0 -31
  180. data/site/_posts/2014-05-08-jekyll-2-0-3-released.markdown +0 -18
  181. data/site/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown +0 -19
  182. data/site/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown +0 -31
  183. data/site/_posts/2014-07-01-jekyll-2-1-1-released.markdown +0 -30
  184. data/site/_posts/2014-07-29-jekyll-2-2-0-released.markdown +0 -19
  185. data/site/_posts/2014-08-10-jekyll-2-3-0-released.markdown +0 -41
  186. data/site/_posts/2014-09-09-jekyll-2-4-0-released.markdown +0 -25
  187. data/site/_posts/2014-11-06-jekylls-midlife-crisis-jekyll-turns-2-5-0.markdown +0 -47
  188. data/site/_posts/2014-11-08-jekyll-2-5-1-released.markdown +0 -29
  189. data/site/_posts/2014-11-12-jekyll-2-5-2-released.markdown +0 -18
  190. data/site/_posts/2014-12-17-alfredxing-welcome-to-jekyll-core.md +0 -27
  191. data/site/_posts/2014-12-22-jekyll-2-5-3-released.markdown +0 -20
  192. data/site/_posts/2015-01-20-jekyll-meet-and-greet.markdown +0 -20
  193. data/site/_posts/2015-01-24-jekyll-3-0-0-beta1-released.markdown +0 -40
  194. data/site/_posts/2015-02-26-introducing-jekyll-talk.markdown +0 -15
  195. data/site/_posts/2015-10-26-jekyll-3-0-released.markdown +0 -35
  196. data/site/_posts/2015-11-17-jekyll-3-0-1-released.markdown +0 -25
  197. data/site/_posts/2016-01-20-jekyll-3-0-2-released.markdown +0 -19
  198. data/site/_posts/2016-01-24-jekyll-3-1-0-released.markdown +0 -50
  199. data/site/_posts/2016-01-28-jekyll-3-1-1-released.markdown +0 -33
  200. data/site/_posts/2016-02-08-jekyll-3-0-3-released.markdown +0 -32
  201. data/site/_posts/2016-02-19-jekyll-3-1-2-released.markdown +0 -20
  202. data/site/_sass/_font-awesome.scss +0 -25
  203. data/site/_sass/_gridism.scss +0 -124
  204. data/site/_sass/_mixins.scss +0 -38
  205. data/site/_sass/_normalize.scss +0 -1
  206. data/site/_sass/_pygments.scss +0 -78
  207. data/site/_sass/_style.scss +0 -1002
  208. data/site/css/screen.scss +0 -9
  209. data/site/help/index.md +0 -41
  210. data/site/redirects/github.html +0 -4
  211. data/site/redirects/issues.html +0 -4
@@ -0,0 +1,794 @@
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.2.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.0.0 -->
14
+ <title>Directory structure - Jekyll • Simple, blog-aware, static sites</title>
15
+ <meta property="og:title" content="Directory structure">
16
+ <meta name="description" content="Transform your plain text into static websites and blogs">
17
+ <meta property="og:description" content="Transform your plain text into static websites and blogs">
18
+ <link rel="canonical" href="https://jekyllrb.com/docs/structure/">
19
+ <meta property="og:url" content="https://jekyllrb.com/docs/structure/">
20
+ <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
21
+ <meta property="og:type" content="article">
22
+ <meta property="article:published_time" content="2016-07-27T18:44:57-07:00">
23
+ <meta name="twitter:card" content="summary">
24
+ <meta name="twitter:site" content="@jekyllrb">
25
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
26
+ <script type="application/ld+json">
27
+ {
28
+ "@context": "http://schema.org",
29
+ "@type": "BlogPosting",
30
+ "headline": "Directory structure",
31
+ "datePublished": "2016-07-27T18:44:57-07:00",
32
+ "description": "Transform your plain text into static websites and blogs",
33
+ "logo": "https://jekyllrb.comimg/logo-2x.png",
34
+ "url": "https://jekyllrb.com/docs/structure/"
35
+ }
36
+ </script>
37
+ <!-- End Jekyll SEO tag -->
38
+ <!--[if lt IE 9]>
39
+ <script src="/js/html5shiv.min.js"></script>
40
+ <script src="/js/respond.min.js"></script>
41
+ <![endif]-->
42
+ </head>
43
+
44
+
45
+ <body class="wrap">
46
+ <header>
47
+ <nav class="mobile-nav show-on-mobiles">
48
+ <ul>
49
+ <li class="">
50
+ <a href="/">Home</a>
51
+ </li>
52
+ <li class="current">
53
+ <a href="/docs/home/">Docs</a>
54
+ </li>
55
+ <li class="">
56
+ <a href="/news/">News</a>
57
+ </li>
58
+ <li class="">
59
+ <a href="/community/">Community</a>
60
+ </li>
61
+ <li class="">
62
+ <a href="/help/">Help</a>
63
+ </li>
64
+ <li>
65
+ <a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
66
+ </li>
67
+ </ul>
68
+
69
+ </nav>
70
+ <div class="grid">
71
+ <div class="unit one-third center-on-mobiles">
72
+ <h1>
73
+ <a href="/">
74
+ <span class="sr-only">Jekyll</span>
75
+ <img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
76
+ </a>
77
+ </h1>
78
+ </div>
79
+ <nav class="main-nav unit two-thirds hide-on-mobiles">
80
+ <ul>
81
+ <li class="">
82
+ <a href="/">Home</a>
83
+ </li>
84
+ <li class="current">
85
+ <a href="/docs/home/">Docs</a>
86
+ </li>
87
+ <li class="">
88
+ <a href="/news/">News</a>
89
+ </li>
90
+ <li class="">
91
+ <a href="/community/">Community</a>
92
+ </li>
93
+ <li class="">
94
+ <a href="/help/">Help</a>
95
+ </li>
96
+ <li>
97
+ <a href="https://github.com/jekyll/jekyll"><span class="hide-on-mobiles">View on </span>GitHub</a>
98
+ </li>
99
+ </ul>
100
+
101
+ </nav>
102
+ </div>
103
+ </header>
104
+
105
+
106
+ <section class="docs">
107
+ <div class="grid">
108
+
109
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
110
+ <select onchange="if (this.value) window.location.href=this.value">
111
+ <option value="">Navigate the docs…</option>
112
+
113
+ <optgroup label="Getting Started">
114
+
115
+
116
+
117
+ <option value="https://jekyllrb.com/docs/home/">Welcome</option>
118
+
119
+
120
+
121
+ <option value="https://jekyllrb.com/docs/quickstart/">Quick-start guide</option>
122
+
123
+
124
+
125
+ <option value="https://jekyllrb.com/docs/installation/">Installation</option>
126
+
127
+
128
+
129
+ <option value="https://jekyllrb.com/docs/usage/">Basic Usage</option>
130
+
131
+
132
+
133
+ <option value="https://jekyllrb.com/docs/structure/">Directory structure</option>
134
+
135
+
136
+
137
+ <option value="https://jekyllrb.com/docs/configuration/">Configuration</option>
138
+
139
+
140
+ </optgroup>
141
+
142
+ <optgroup label="Your Content">
143
+
144
+
145
+
146
+ <option value="https://jekyllrb.com/docs/frontmatter/">Front Matter</option>
147
+
148
+
149
+
150
+ <option value="https://jekyllrb.com/docs/posts/">Writing posts</option>
151
+
152
+
153
+
154
+ <option value="https://jekyllrb.com/docs/drafts/">Working with drafts</option>
155
+
156
+
157
+
158
+ <option value="https://jekyllrb.com/docs/pages/">Creating pages</option>
159
+
160
+
161
+
162
+ <option value="https://jekyllrb.com/docs/static-files/">Static Files</option>
163
+
164
+
165
+
166
+ <option value="https://jekyllrb.com/docs/variables/">Variables</option>
167
+
168
+
169
+
170
+ <option value="https://jekyllrb.com/docs/collections/">Collections</option>
171
+
172
+
173
+
174
+ <option value="https://jekyllrb.com/docs/datafiles/">Data Files</option>
175
+
176
+
177
+
178
+ <option value="https://jekyllrb.com/docs/assets/">Assets</option>
179
+
180
+
181
+
182
+ <option value="https://jekyllrb.com/docs/migrations/">Blog migrations</option>
183
+
184
+
185
+ </optgroup>
186
+
187
+ <optgroup label="Customization">
188
+
189
+
190
+
191
+ <option value="https://jekyllrb.com/docs/templates/">Templates</option>
192
+
193
+
194
+
195
+ <option value="https://jekyllrb.com/docs/permalinks/">Permalinks</option>
196
+
197
+
198
+
199
+ <option value="https://jekyllrb.com/docs/pagination/">Pagination</option>
200
+
201
+
202
+
203
+ <option value="https://jekyllrb.com/docs/plugins/">Plugins</option>
204
+
205
+
206
+
207
+ <option value="https://jekyllrb.com/docs/themes/">Themes</option>
208
+
209
+
210
+
211
+ <option value="https://jekyllrb.com/docs/extras/">Extras</option>
212
+
213
+
214
+ </optgroup>
215
+
216
+ <optgroup label="Deployment">
217
+
218
+
219
+
220
+ <option value="https://jekyllrb.com/docs/github-pages/">GitHub Pages</option>
221
+
222
+
223
+
224
+ <option value="https://jekyllrb.com/docs/deployment-methods/">Deployment methods</option>
225
+
226
+
227
+
228
+ <option value="https://jekyllrb.com/docs/continuous-integration/">Continuous Integration</option>
229
+
230
+
231
+ </optgroup>
232
+
233
+ <optgroup label="Miscellaneous">
234
+
235
+
236
+
237
+ <option value="https://jekyllrb.com/docs/troubleshooting/">Troubleshooting</option>
238
+
239
+
240
+
241
+ <option value="https://jekyllrb.com/docs/sites/">Sites using Jekyll</option>
242
+
243
+
244
+
245
+ <option value="https://jekyllrb.com/docs/resources/">Resources</option>
246
+
247
+
248
+
249
+ <option value="https://jekyllrb.com/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
250
+
251
+
252
+
253
+ <option value="https://jekyllrb.com/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
254
+
255
+
256
+ </optgroup>
257
+
258
+ <optgroup label="Meta">
259
+
260
+
261
+
262
+ <option value="https://jekyllrb.com/docs/contributing/">Contributing</option>
263
+
264
+
265
+
266
+ <option value="https://jekyllrb.com/docs/conduct/">Code of Conduct</option>
267
+
268
+
269
+
270
+ <option value="https://jekyllrb.com/docs/history/">History</option>
271
+
272
+
273
+ </optgroup>
274
+
275
+ </select>
276
+ </div>
277
+
278
+
279
+ <div class="unit four-fifths">
280
+ <article>
281
+ <div class="improve right hide-on-mobiles">
282
+ <a href="https://github.com/jekyll/jekyll/edit/master/site/_docs/structure.md"><i class="fa fa-pencil"></i>  Improve this page</a>
283
+ </div>
284
+ <h1>Directory structure</h1>
285
+ <p>Jekyll is, at its core, a text transformation engine. The concept behind the
286
+ system is this: you give it text written in your favorite markup language, be
287
+ that Markdown, Textile, or just plain HTML, and it churns that through a layout
288
+ or a series of layout files. Throughout that process you can tweak how you want
289
+ the site URLs to look, what data gets displayed in the layout, and more. This
290
+ is all done through editing text files; the static web site is the final
291
+ product.</p>
292
+
293
+ <p>A basic Jekyll site usually looks something like this:</p>
294
+
295
+ <figure class="highlight"><pre><code class="language-shell" data-lang="shell">.
296
+ ├── _config.yml
297
+ ├── _drafts
298
+ | ├── begin-with-the-crazy-ideas.textile
299
+ | └── on-simplicity-in-technology.markdown
300
+ ├── _includes
301
+ | ├── footer.html
302
+ | └── header.html
303
+ ├── _layouts
304
+ | ├── default.html
305
+ | └── post.html
306
+ ├── _posts
307
+ | ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
308
+ | └── 2009-04-26-barcamp-boston-4-roundup.textile
309
+ ├── _data
310
+ | └── members.yml
311
+ ├── _site
312
+ ├── .jekyll-metadata
313
+ └── index.html</code></pre></figure>
314
+
315
+ <p>An overview of what each of these does:</p>
316
+
317
+ <div class="mobile-side-scroller">
318
+ <table>
319
+ <thead>
320
+ <tr>
321
+ <th>File / Directory</th>
322
+ <th>Description</th>
323
+ </tr>
324
+ </thead>
325
+ <tbody>
326
+ <tr>
327
+ <td>
328
+ <p><code>_config.yml</code></p>
329
+ </td>
330
+ <td>
331
+ <p>
332
+
333
+ Stores <a href="../configuration/">configuration</a> data. Many of
334
+ these options can be specified from the command line executable but
335
+ it’s easier to specify them here so you don’t have to remember them.
336
+
337
+ </p>
338
+ </td>
339
+ </tr>
340
+ <tr>
341
+ <td>
342
+ <p><code>_drafts</code></p>
343
+ </td>
344
+ <td>
345
+ <p>
346
+
347
+ Drafts are unpublished posts. The format of these files is without a
348
+ date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
349
+ work with drafts</a>.
350
+
351
+ </p>
352
+ </td>
353
+ </tr>
354
+ <tr>
355
+ <td>
356
+ <p><code>_includes</code></p>
357
+ </td>
358
+ <td>
359
+ <p>
360
+
361
+ These are the partials that can be mixed and matched by your layouts
362
+ and posts to facilitate reuse. The liquid tag
363
+ <code>{% include file.ext %}</code>
364
+ can be used to include the partial in
365
+ <code>_includes/file.ext</code>.
366
+
367
+ </p>
368
+ </td>
369
+ </tr>
370
+ <tr>
371
+ <td>
372
+ <p><code>_layouts</code></p>
373
+ </td>
374
+ <td>
375
+ <p>
376
+
377
+ These are the templates that wrap posts. Layouts are chosen on a
378
+ post-by-post basis in the
379
+ <a href="../frontmatter/">YAML Front Matter</a>,
380
+ which is described in the next section. The liquid tag
381
+ <code>{{ content }}</code>
382
+ is used to inject content into the web page.
383
+
384
+ </p>
385
+ </td>
386
+ </tr>
387
+ <tr>
388
+ <td>
389
+ <p><code>_posts</code></p>
390
+ </td>
391
+ <td>
392
+ <p>
393
+
394
+ Your dynamic content, so to speak. The naming convention of these
395
+ files is important, and must follow the format:
396
+ <code>YEAR-MONTH-DAY-title.MARKUP</code>.
397
+ The <a href="../permalinks/">permalinks</a> can be customized for
398
+ each post, but the date and markup language are determined solely by
399
+ the file name.
400
+
401
+ </p>
402
+ </td>
403
+ </tr>
404
+ <tr>
405
+ <td>
406
+ <p><code>_data</code></p>
407
+ </td>
408
+ <td>
409
+ <p>
410
+
411
+ Well-formatted site data should be placed here. The Jekyll engine
412
+ will autoload all YAML files in this directory (using either the
413
+ <code>.yml</code>, <code>.yaml</code>, <code>.json</code> or
414
+ <code>.csv</code> formats and extensions) and they will be
415
+ accessible via `site.data`. If there's a file
416
+ <code>members.yml</code> under the directory, then you can access
417
+ contents of the file through <code>site.data.members</code>.
418
+
419
+ </p>
420
+ </td>
421
+ </tr>
422
+ <tr>
423
+ <td>
424
+ <p><code>_site</code></p>
425
+ </td>
426
+ <td>
427
+ <p>
428
+
429
+ This is where the generated site will be placed (by default) once
430
+ Jekyll is done transforming it. It’s probably a good idea to add this
431
+ to your <code>.gitignore</code> file.
432
+
433
+ </p>
434
+ </td>
435
+ </tr>
436
+ <tr>
437
+ <td>
438
+ <p><code>.jekyll-metadata</code></p>
439
+ </td>
440
+ <td>
441
+ <p>
442
+
443
+ This helps Jekyll keep track of which files have not been modified
444
+ since the site was last built, and which files will need to be
445
+ regenerated on the next build. This file will not be included in the
446
+ generated site. It’s probably a good idea to add this to your
447
+ <code>.gitignore</code> file.
448
+
449
+ </p>
450
+ </td>
451
+ </tr>
452
+ <tr>
453
+ <td>
454
+ <p><code>index.html</code> and other HTML, Markdown, Textile files</p>
455
+ </td>
456
+ <td>
457
+ <p>
458
+
459
+ Provided that the file has a <a href="../frontmatter/">YAML Front
460
+ Matter</a> section, it will be transformed by Jekyll. The same will
461
+ happen for any <code>.html</code>, <code>.markdown</code>,
462
+ <code>.md</code>, or <code>.textile</code> file in your site’s root
463
+ directory or directories not listed above.
464
+
465
+ </p>
466
+ </td>
467
+ </tr>
468
+ <tr>
469
+ <td>
470
+ <p>Other Files/Folders</p>
471
+ </td>
472
+ <td>
473
+ <p>
474
+
475
+ Every other directory and file except for those listed above—such as
476
+ <code>css</code> and <code>images</code> folders,
477
+ <code>favicon.ico</code> files, and so forth—will be copied verbatim
478
+ to the generated site. There are plenty of <a href="../sites/">sites
479
+ already using Jekyll</a> if you’re curious to see how they’re laid
480
+ out.
481
+
482
+ </p>
483
+ </td>
484
+ </tr>
485
+ </tbody>
486
+ </table>
487
+ </div>
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+
507
+
508
+
509
+ <div class="section-nav">
510
+ <div class="left align-right">
511
+
512
+
513
+
514
+ <a href="/docs/usage/" class="prev">Back</a>
515
+
516
+ </div>
517
+ <div class="right align-left">
518
+
519
+
520
+
521
+ <a href="/docs/configuration/" class="next">Next</a>
522
+
523
+ </div>
524
+ </div>
525
+ <div class="clear"></div>
526
+
527
+ </article>
528
+ </div>
529
+
530
+ <div class="unit one-fifth hide-on-mobiles">
531
+ <aside>
532
+
533
+ <h4>Getting Started</h4>
534
+ <ul>
535
+
536
+
537
+
538
+ <li class=""><a href="https://jekyllrb.com/docs/home/">Welcome</a></li>
539
+
540
+
541
+
542
+ <li class=""><a href="https://jekyllrb.com/docs/quickstart/">Quick-start guide</a></li>
543
+
544
+
545
+
546
+ <li class=""><a href="https://jekyllrb.com/docs/installation/">Installation</a></li>
547
+
548
+
549
+
550
+ <li class=""><a href="https://jekyllrb.com/docs/usage/">Basic Usage</a></li>
551
+
552
+
553
+
554
+ <li class="current"><a href="https://jekyllrb.com/docs/structure/">Directory structure</a></li>
555
+
556
+
557
+
558
+ <li class=""><a href="https://jekyllrb.com/docs/configuration/">Configuration</a></li>
559
+
560
+ </ul>
561
+
562
+
563
+ <h4>Your Content</h4>
564
+ <ul>
565
+
566
+
567
+
568
+ <li class=""><a href="https://jekyllrb.com/docs/frontmatter/">Front Matter</a></li>
569
+
570
+
571
+
572
+ <li class=""><a href="https://jekyllrb.com/docs/posts/">Writing posts</a></li>
573
+
574
+
575
+
576
+ <li class=""><a href="https://jekyllrb.com/docs/drafts/">Working with drafts</a></li>
577
+
578
+
579
+
580
+ <li class=""><a href="https://jekyllrb.com/docs/pages/">Creating pages</a></li>
581
+
582
+
583
+
584
+ <li class=""><a href="https://jekyllrb.com/docs/static-files/">Static Files</a></li>
585
+
586
+
587
+
588
+ <li class=""><a href="https://jekyllrb.com/docs/variables/">Variables</a></li>
589
+
590
+
591
+
592
+ <li class=""><a href="https://jekyllrb.com/docs/collections/">Collections</a></li>
593
+
594
+
595
+
596
+ <li class=""><a href="https://jekyllrb.com/docs/datafiles/">Data Files</a></li>
597
+
598
+
599
+
600
+ <li class=""><a href="https://jekyllrb.com/docs/assets/">Assets</a></li>
601
+
602
+
603
+
604
+ <li class=""><a href="https://jekyllrb.com/docs/migrations/">Blog migrations</a></li>
605
+
606
+ </ul>
607
+
608
+
609
+ <h4>Customization</h4>
610
+ <ul>
611
+
612
+
613
+
614
+ <li class=""><a href="https://jekyllrb.com/docs/templates/">Templates</a></li>
615
+
616
+
617
+
618
+ <li class=""><a href="https://jekyllrb.com/docs/permalinks/">Permalinks</a></li>
619
+
620
+
621
+
622
+ <li class=""><a href="https://jekyllrb.com/docs/pagination/">Pagination</a></li>
623
+
624
+
625
+
626
+ <li class=""><a href="https://jekyllrb.com/docs/plugins/">Plugins</a></li>
627
+
628
+
629
+
630
+ <li class=""><a href="https://jekyllrb.com/docs/themes/">Themes</a></li>
631
+
632
+
633
+
634
+ <li class=""><a href="https://jekyllrb.com/docs/extras/">Extras</a></li>
635
+
636
+ </ul>
637
+
638
+
639
+ <h4>Deployment</h4>
640
+ <ul>
641
+
642
+
643
+
644
+ <li class=""><a href="https://jekyllrb.com/docs/github-pages/">GitHub Pages</a></li>
645
+
646
+
647
+
648
+ <li class=""><a href="https://jekyllrb.com/docs/deployment-methods/">Deployment methods</a></li>
649
+
650
+
651
+
652
+ <li class=""><a href="https://jekyllrb.com/docs/continuous-integration/">Continuous Integration</a></li>
653
+
654
+ </ul>
655
+
656
+
657
+ <h4>Miscellaneous</h4>
658
+ <ul>
659
+
660
+
661
+
662
+ <li class=""><a href="https://jekyllrb.com/docs/troubleshooting/">Troubleshooting</a></li>
663
+
664
+
665
+
666
+ <li class=""><a href="https://jekyllrb.com/docs/sites/">Sites using Jekyll</a></li>
667
+
668
+
669
+
670
+ <li class=""><a href="https://jekyllrb.com/docs/resources/">Resources</a></li>
671
+
672
+
673
+
674
+ <li class=""><a href="https://jekyllrb.com/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
675
+
676
+
677
+
678
+ <li class=""><a href="https://jekyllrb.com/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
679
+
680
+ </ul>
681
+
682
+
683
+ <h4>Meta</h4>
684
+ <ul>
685
+
686
+
687
+
688
+ <li class=""><a href="https://jekyllrb.com/docs/contributing/">Contributing</a></li>
689
+
690
+
691
+
692
+ <li class=""><a href="https://jekyllrb.com/docs/conduct/">Code of Conduct</a></li>
693
+
694
+
695
+
696
+ <li class=""><a href="https://jekyllrb.com/docs/history/">History</a></li>
697
+
698
+ </ul>
699
+
700
+
701
+ </aside>
702
+ </div>
703
+
704
+
705
+ <div class="clear"></div>
706
+
707
+ </div>
708
+ </section>
709
+
710
+
711
+ <footer>
712
+ <div class="grid">
713
+ <div class="unit one-third center-on-mobiles">
714
+ <p>The contents of this website are <br>© 2016 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
715
+ </div>
716
+ <div class="unit two-thirds align-right center-on-mobiles">
717
+ <p>
718
+ Proudly hosted by
719
+ <a href="https://github.com">
720
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
721
+ </a>
722
+ </p>
723
+ </div>
724
+ </div>
725
+ </footer>
726
+
727
+ <script>
728
+ var anchorForId = function (id) {
729
+ var anchor = document.createElement("a");
730
+ anchor.className = "header-link";
731
+ anchor.href = "#" + id;
732
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
733
+ anchor.title = "Permalink";
734
+ return anchor;
735
+ };
736
+
737
+ var linkifyAnchors = function (level, containingElement) {
738
+ var headers = containingElement.getElementsByTagName("h" + level);
739
+ for (var h = 0; h < headers.length; h++) {
740
+ var header = headers[h];
741
+
742
+ if (typeof header.id !== "undefined" && header.id !== "") {
743
+ header.appendChild(anchorForId(header.id));
744
+ }
745
+ }
746
+ };
747
+
748
+ document.onreadystatechange = function () {
749
+ if (this.readyState === "complete") {
750
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
751
+ if (!contentBlock) {
752
+ return;
753
+ }
754
+ for (var level = 1; level <= 6; level++) {
755
+ linkifyAnchors(level, contentBlock);
756
+ }
757
+ }
758
+ };
759
+ </script>
760
+
761
+
762
+ <!-- Gauges (http://gaug.es/) -->
763
+ <script>
764
+ var _gauges = _gauges || [];
765
+ (function() {
766
+ var t = document.createElement('script');
767
+ t.type = 'text/javascript';
768
+ t.async = true;
769
+ t.id = 'gauges-tracker';
770
+ t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
771
+ t.src = '//secure.gaug.es/track.js';
772
+ var s = document.getElementsByTagName('script')[0];
773
+ s.parentNode.insertBefore(t, s);
774
+ })();
775
+ </script>
776
+
777
+
778
+
779
+ <!-- Google Analytics (http://google.com/analytics) -->
780
+ <script>
781
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
782
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
783
+ L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
784
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
785
+
786
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
787
+ ga('send', 'pageview');
788
+
789
+ </script>
790
+
791
+
792
+
793
+ </body>
794
+ </html>