jekyll-docs 3.1.6 → 3.2.0

Sign up to get free protection for your applications and to get access to all the features.
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,751 @@
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>Themes - Jekyll • Simple, blog-aware, static sites</title>
15
+ <meta property="og:title" content="Themes">
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/themes/">
19
+ <meta property="og:url" content="https://jekyllrb.com/docs/themes/">
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": "Themes",
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/themes/"
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/themes.md"><i class="fa fa-pencil"></i>  Improve this page</a>
283
+ </div>
284
+ <h1>Themes</h1>
285
+ <div class="note unreleased">
286
+ <h5>This feature is unreleased!</h5>
287
+ <p>
288
+ Jekyll 3.0 and 3.1 do NOT have the ability to add themes in this way.
289
+ The documentation below is for an unreleased version of Jekyll and
290
+ cannot be used at the moment.
291
+ </p>
292
+ </div>
293
+
294
+ <p>Jekyll has an extensive theme system, which allows you to leverage community-maintained templates and styles to customize your site’s presentation. Jekyll themes package layouts, includes, and stylesheets in a way that can be overridden by your site’s content.</p>
295
+
296
+ <h2 id="installing-a-theme">Installing a theme</h2>
297
+
298
+ <ol>
299
+ <li>
300
+ <p>To install a theme, first, add the theme to your site’s <code class="highlighter-rouge">Gemfile</code>:</p>
301
+
302
+ <div class="highlighter-rouge">
303
+ <pre class="highlight"><code> gem 'my-awesome-jekyll-theme'
304
+ </code></pre>
305
+ </div>
306
+ </li>
307
+ <li>Save the changes to your <code class="highlighter-rouge">Gemfile</code>
308
+ </li>
309
+ <li>Run the command <code class="highlighter-rouge">bundle install</code> to install the theme</li>
310
+ <li>
311
+ <p>Finally, activate the theme by adding the following to your site’s <code class="highlighter-rouge">_config.yml</code>:</p>
312
+
313
+ <div class="highlighter-rouge">
314
+ <pre class="highlight"><code> theme: my-awesome-jekyll-theme
315
+ </code></pre>
316
+ </div>
317
+ </li>
318
+ </ol>
319
+
320
+ <p class="note info">You can have multiple themes listed in your site’s Gemfile, but only one theme can be selected in your site’s <code class="highlighter-rouge">_config.yml</code>.</p>
321
+
322
+ <h2 id="overriding-theme-defaults">Overriding theme defaults</h2>
323
+
324
+ <p>Jekyll themes set default layouts, includes, and stylesheets, that can be overridden by your site’s content. For example, if your selected theme has a <code class="highlighter-rouge">page</code> layout, you can override the theme’s layout by creating your own <code class="highlighter-rouge">page</code> layout in the <code class="highlighter-rouge">_layouts</code> folder (e.g., <code class="highlighter-rouge">_layouts/page.html</code>).</p>
325
+
326
+ <p>Jekyll will look first to your site’s content, before looking to the theme’s defaults, for any requested file in the following folders:</p>
327
+
328
+ <ul>
329
+ <li><code class="highlighter-rouge">/_layouts</code></li>
330
+ <li><code class="highlighter-rouge">/_includes</code></li>
331
+ <li><code class="highlighter-rouge">/_sass</code></li>
332
+ </ul>
333
+
334
+ <p class="note info">Refer to your selected theme’s documentation and source repository for more information on what files you can override.</p>
335
+
336
+ <h2 id="creating-a-theme">Creating a theme</h2>
337
+
338
+ <p>Jekyll themes are distributed as Ruby gems. The only required file is the <a href="http://guides.rubygems.org/specification-reference/">Ruby Gemspec</a>. Here’s an example of a minimal Gemspec for the <code class="highlighter-rouge">my-awesome-jekyll-theme</code> theme, saved as <code class="highlighter-rouge">/my-awsome-jekyll-theme.gemspec</code>:</p>
339
+
340
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Gem</span><span class="o">::</span><span class="no">Specification</span><span class="p">.</span><span class="nf">new</span> <span class="k">do</span> <span class="o">|</span><span class="n">s</span><span class="o">|</span>
341
+ <span class="n">s</span><span class="p">.</span><span class="nf">name</span> <span class="o">=</span> <span class="s1">'&lt;THEME TITLE&gt;'</span>
342
+ <span class="n">s</span><span class="p">.</span><span class="nf">version</span> <span class="o">=</span> <span class="s1">'0.1.0'</span>
343
+ <span class="n">s</span><span class="p">.</span><span class="nf">license</span> <span class="o">=</span> <span class="s1">'MIT'</span>
344
+ <span class="n">s</span><span class="p">.</span><span class="nf">summary</span> <span class="o">=</span> <span class="s1">'&lt;THEME DESCRIPTION&gt;'</span>
345
+ <span class="n">s</span><span class="p">.</span><span class="nf">author</span> <span class="o">=</span> <span class="s1">'&lt;YOUR NAME&gt;'</span>
346
+ <span class="n">s</span><span class="p">.</span><span class="nf">email</span> <span class="o">=</span> <span class="s1">'&lt;YOUR EMAIL&gt;'</span>
347
+ <span class="n">s</span><span class="p">.</span><span class="nf">homepage</span> <span class="o">=</span> <span class="s1">'https://github.com/jekyll/my-awesome-jekyll-theme'</span>
348
+ <span class="n">s</span><span class="p">.</span><span class="nf">files</span> <span class="o">=</span> <span class="sb">`git ls-files -z`</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\x0</span><span class="s2">"</span><span class="p">).</span><span class="nf">grep</span><span class="p">(</span><span class="sr">%r{^_(sass|includes|layouts)/}</span><span class="p">)</span>
349
+ <span class="k">end</span></code></pre></figure>
350
+
351
+ <h3 id="layouts-and-includes">Layouts and includes</h3>
352
+
353
+ <p>Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme’s <code class="highlighter-rouge">/_layouts</code> folder, and place includes in your themes <code class="highlighter-rouge">/_includes</code> folder.</p>
354
+
355
+ <p>For example, if your theme has a <code class="highlighter-rouge">/_layouts/page.html</code> file, and a page has <code class="highlighter-rouge">layout: page</code> in its YAML front matter, Jekyll will first look to the site’s <code class="highlighter-rouge">_layouts</code> folder for a the <code class="highlighter-rouge">page</code> layout, and if none exists, will use your theme’s <code class="highlighter-rouge">page</code> layout.</p>
356
+
357
+ <h3 id="stylesheets">Stylesheets</h3>
358
+
359
+ <p>Your theme’s stylesheets should be placed in your theme’s <code class="highlighter-rouge">/_sass</code> folder, again, just as you would when authoring a Jekyll site. Your theme’s styles can be included in the user’s stylesheet using the <code class="highlighter-rouge">@import</code> directive.</p>
360
+
361
+ <h3 id="documenting-your-theme">Documenting your theme</h3>
362
+
363
+ <p>Your theme should include a <code class="highlighter-rouge">/README.md</code> file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site’s configuration file?</p>
364
+
365
+ <h3 id="adding-a-screenshot">Adding a screenshot</h3>
366
+
367
+ <p>Themes are visual. Show users what your theme looks like by including a screenshot as <code class="highlighter-rouge">/screenshot.png</code> within your theme’s repository where it can be retrieved programatically. You can also include this screenshot within your theme’s documentation.</p>
368
+
369
+ <h3 id="previewing-your-theme">Previewing your theme</h3>
370
+
371
+ <p>To preview your theme as you’re authoring it, it may be helpful to add dummy content in, for example, <code class="highlighter-rouge">/index.html</code> and <code class="highlighter-rouge">/page.html</code> files. This will allow you to use the <code class="highlighter-rouge">jekyll build</code> and <code class="highlighter-rouge">jekyll serve</code> commands to preview your theme, just as you’d preview a Jekyll site.</p>
372
+
373
+ <p class="info note">If you do preview your theme locally, be sure to add <code class="highlighter-rouge">/_site</code> to your theme’s <code class="highlighter-rouge">.gitignore</code> file to prevent the compiled site from also being included when you distribute your theme.</p>
374
+
375
+ <h3 id="publishing-your-theme">Publishing your theme</h3>
376
+
377
+ <p>Themes are published via <a href="https://rubygems.org">RubyGems.org</a>. You’ll need a RubyGems account, which you can <a href="https://rubygems.org/sign_up">create for free</a>.</p>
378
+
379
+ <ol>
380
+ <li>
381
+ <p>First, package your theme, by running the following command, replacing <code class="highlighter-rouge">my-awesome-jekyll-theme</code> with the name of your theme:</p>
382
+
383
+ <div class="highlighter-rouge">
384
+ <pre class="highlight"><code> gem build my-awesome-jekyll-theme.gemspec
385
+ </code></pre>
386
+ </div>
387
+ </li>
388
+ <li>
389
+ <p>Next, push your packaged theme up to the RubyGems service, by running the following command, again replacing <code class="highlighter-rouge">my-awesome-jekyll-theme</code> with the name of your theme:</p>
390
+
391
+ <div class="highlighter-rouge">
392
+ <pre class="highlight"><code> gem push my-awesome-jekyll-theme-*.gem
393
+ </code></pre>
394
+ </div>
395
+ </li>
396
+ </ol>
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+ <div class="section-nav">
467
+ <div class="left align-right">
468
+
469
+
470
+
471
+ <a href="/docs/plugins/" class="prev">Back</a>
472
+
473
+ </div>
474
+ <div class="right align-left">
475
+
476
+
477
+
478
+ <a href="/docs/extras/" class="next">Next</a>
479
+
480
+ </div>
481
+ </div>
482
+ <div class="clear"></div>
483
+
484
+ </article>
485
+ </div>
486
+
487
+ <div class="unit one-fifth hide-on-mobiles">
488
+ <aside>
489
+
490
+ <h4>Getting Started</h4>
491
+ <ul>
492
+
493
+
494
+
495
+ <li class=""><a href="https://jekyllrb.com/docs/home/">Welcome</a></li>
496
+
497
+
498
+
499
+ <li class=""><a href="https://jekyllrb.com/docs/quickstart/">Quick-start guide</a></li>
500
+
501
+
502
+
503
+ <li class=""><a href="https://jekyllrb.com/docs/installation/">Installation</a></li>
504
+
505
+
506
+
507
+ <li class=""><a href="https://jekyllrb.com/docs/usage/">Basic Usage</a></li>
508
+
509
+
510
+
511
+ <li class=""><a href="https://jekyllrb.com/docs/structure/">Directory structure</a></li>
512
+
513
+
514
+
515
+ <li class=""><a href="https://jekyllrb.com/docs/configuration/">Configuration</a></li>
516
+
517
+ </ul>
518
+
519
+
520
+ <h4>Your Content</h4>
521
+ <ul>
522
+
523
+
524
+
525
+ <li class=""><a href="https://jekyllrb.com/docs/frontmatter/">Front Matter</a></li>
526
+
527
+
528
+
529
+ <li class=""><a href="https://jekyllrb.com/docs/posts/">Writing posts</a></li>
530
+
531
+
532
+
533
+ <li class=""><a href="https://jekyllrb.com/docs/drafts/">Working with drafts</a></li>
534
+
535
+
536
+
537
+ <li class=""><a href="https://jekyllrb.com/docs/pages/">Creating pages</a></li>
538
+
539
+
540
+
541
+ <li class=""><a href="https://jekyllrb.com/docs/static-files/">Static Files</a></li>
542
+
543
+
544
+
545
+ <li class=""><a href="https://jekyllrb.com/docs/variables/">Variables</a></li>
546
+
547
+
548
+
549
+ <li class=""><a href="https://jekyllrb.com/docs/collections/">Collections</a></li>
550
+
551
+
552
+
553
+ <li class=""><a href="https://jekyllrb.com/docs/datafiles/">Data Files</a></li>
554
+
555
+
556
+
557
+ <li class=""><a href="https://jekyllrb.com/docs/assets/">Assets</a></li>
558
+
559
+
560
+
561
+ <li class=""><a href="https://jekyllrb.com/docs/migrations/">Blog migrations</a></li>
562
+
563
+ </ul>
564
+
565
+
566
+ <h4>Customization</h4>
567
+ <ul>
568
+
569
+
570
+
571
+ <li class=""><a href="https://jekyllrb.com/docs/templates/">Templates</a></li>
572
+
573
+
574
+
575
+ <li class=""><a href="https://jekyllrb.com/docs/permalinks/">Permalinks</a></li>
576
+
577
+
578
+
579
+ <li class=""><a href="https://jekyllrb.com/docs/pagination/">Pagination</a></li>
580
+
581
+
582
+
583
+ <li class=""><a href="https://jekyllrb.com/docs/plugins/">Plugins</a></li>
584
+
585
+
586
+
587
+ <li class="current"><a href="https://jekyllrb.com/docs/themes/">Themes</a></li>
588
+
589
+
590
+
591
+ <li class=""><a href="https://jekyllrb.com/docs/extras/">Extras</a></li>
592
+
593
+ </ul>
594
+
595
+
596
+ <h4>Deployment</h4>
597
+ <ul>
598
+
599
+
600
+
601
+ <li class=""><a href="https://jekyllrb.com/docs/github-pages/">GitHub Pages</a></li>
602
+
603
+
604
+
605
+ <li class=""><a href="https://jekyllrb.com/docs/deployment-methods/">Deployment methods</a></li>
606
+
607
+
608
+
609
+ <li class=""><a href="https://jekyllrb.com/docs/continuous-integration/">Continuous Integration</a></li>
610
+
611
+ </ul>
612
+
613
+
614
+ <h4>Miscellaneous</h4>
615
+ <ul>
616
+
617
+
618
+
619
+ <li class=""><a href="https://jekyllrb.com/docs/troubleshooting/">Troubleshooting</a></li>
620
+
621
+
622
+
623
+ <li class=""><a href="https://jekyllrb.com/docs/sites/">Sites using Jekyll</a></li>
624
+
625
+
626
+
627
+ <li class=""><a href="https://jekyllrb.com/docs/resources/">Resources</a></li>
628
+
629
+
630
+
631
+ <li class=""><a href="https://jekyllrb.com/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
632
+
633
+
634
+
635
+ <li class=""><a href="https://jekyllrb.com/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
636
+
637
+ </ul>
638
+
639
+
640
+ <h4>Meta</h4>
641
+ <ul>
642
+
643
+
644
+
645
+ <li class=""><a href="https://jekyllrb.com/docs/contributing/">Contributing</a></li>
646
+
647
+
648
+
649
+ <li class=""><a href="https://jekyllrb.com/docs/conduct/">Code of Conduct</a></li>
650
+
651
+
652
+
653
+ <li class=""><a href="https://jekyllrb.com/docs/history/">History</a></li>
654
+
655
+ </ul>
656
+
657
+
658
+ </aside>
659
+ </div>
660
+
661
+
662
+ <div class="clear"></div>
663
+
664
+ </div>
665
+ </section>
666
+
667
+
668
+ <footer>
669
+ <div class="grid">
670
+ <div class="unit one-third center-on-mobiles">
671
+ <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>
672
+ </div>
673
+ <div class="unit two-thirds align-right center-on-mobiles">
674
+ <p>
675
+ Proudly hosted by
676
+ <a href="https://github.com">
677
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
678
+ </a>
679
+ </p>
680
+ </div>
681
+ </div>
682
+ </footer>
683
+
684
+ <script>
685
+ var anchorForId = function (id) {
686
+ var anchor = document.createElement("a");
687
+ anchor.className = "header-link";
688
+ anchor.href = "#" + id;
689
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
690
+ anchor.title = "Permalink";
691
+ return anchor;
692
+ };
693
+
694
+ var linkifyAnchors = function (level, containingElement) {
695
+ var headers = containingElement.getElementsByTagName("h" + level);
696
+ for (var h = 0; h < headers.length; h++) {
697
+ var header = headers[h];
698
+
699
+ if (typeof header.id !== "undefined" && header.id !== "") {
700
+ header.appendChild(anchorForId(header.id));
701
+ }
702
+ }
703
+ };
704
+
705
+ document.onreadystatechange = function () {
706
+ if (this.readyState === "complete") {
707
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
708
+ if (!contentBlock) {
709
+ return;
710
+ }
711
+ for (var level = 1; level <= 6; level++) {
712
+ linkifyAnchors(level, contentBlock);
713
+ }
714
+ }
715
+ };
716
+ </script>
717
+
718
+
719
+ <!-- Gauges (http://gaug.es/) -->
720
+ <script>
721
+ var _gauges = _gauges || [];
722
+ (function() {
723
+ var t = document.createElement('script');
724
+ t.type = 'text/javascript';
725
+ t.async = true;
726
+ t.id = 'gauges-tracker';
727
+ t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
728
+ t.src = '//secure.gaug.es/track.js';
729
+ var s = document.getElementsByTagName('script')[0];
730
+ s.parentNode.insertBefore(t, s);
731
+ })();
732
+ </script>
733
+
734
+
735
+
736
+ <!-- Google Analytics (http://google.com/analytics) -->
737
+ <script>
738
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
739
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
740
+ L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
741
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
742
+
743
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
744
+ ga('send', 'pageview');
745
+
746
+ </script>
747
+
748
+
749
+
750
+ </body>
751
+ </html>