jekyll-docs 3.9.0 → 4.0.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 (225) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll-docs.rb +3 -3
  3. data/site/404.html +10 -7
  4. data/site/css/screen.css +3 -1
  5. data/site/css/screen.css.map +28 -0
  6. data/site/docs/assets/index.html +412 -453
  7. data/site/docs/code_of_conduct/index.html +447 -501
  8. data/site/docs/collections/index.html +487 -674
  9. data/site/docs/community/bug/index.html +603 -0
  10. data/site/docs/community/index.html +635 -0
  11. data/site/docs/conduct/index.html +447 -515
  12. data/site/docs/configuration/default/index.html +682 -0
  13. data/site/docs/configuration/environments/index.html +641 -0
  14. data/site/docs/configuration/front-matter-defaults/index.html +738 -0
  15. data/site/docs/configuration/incremental-regeneration/index.html +631 -0
  16. data/site/docs/configuration/index.html +405 -1230
  17. data/site/docs/configuration/liquid/index.html +616 -0
  18. data/site/docs/configuration/markdown/index.html +766 -0
  19. data/site/docs/configuration/options/index.html +1011 -0
  20. data/site/docs/configuration/webrick/index.html +615 -0
  21. data/site/docs/continuous-integration/buddyworks/index.html +393 -479
  22. data/site/docs/continuous-integration/circleci/index.html +465 -481
  23. data/site/docs/continuous-integration/travis-ci/index.html +450 -507
  24. data/site/docs/contributing/index.html +425 -514
  25. data/site/docs/datafiles/index.html +411 -453
  26. data/site/docs/deployment-methods/index.html +9 -871
  27. data/site/docs/deployment/automated/index.html +663 -0
  28. data/site/docs/deployment/index.html +607 -0
  29. data/site/docs/deployment/manual/index.html +631 -0
  30. data/site/docs/deployment/third-party/index.html +639 -0
  31. data/site/docs/drafts/index.html +9 -634
  32. data/site/docs/extras/index.html +9 -687
  33. data/site/docs/front-matter/index.html +799 -0
  34. data/site/docs/frontmatter/index.html +9 -819
  35. data/site/docs/github-pages/index.html +407 -475
  36. data/site/docs/history/index.html +1370 -1154
  37. data/site/docs/home/index.html +9 -627
  38. data/site/docs/includes/index.html +425 -501
  39. data/site/docs/index.html +630 -9
  40. data/site/docs/installation/index.html +403 -540
  41. data/site/docs/installation/macos/index.html +716 -0
  42. data/site/docs/installation/other-linux/index.html +613 -0
  43. data/site/docs/installation/ubuntu/index.html +623 -0
  44. data/site/docs/installation/windows/index.html +733 -0
  45. data/site/docs/layouts/index.html +726 -0
  46. data/site/docs/liquid/filters/index.html +1169 -0
  47. data/site/docs/liquid/index.html +615 -0
  48. data/site/docs/liquid/tags/index.html +728 -0
  49. data/site/docs/maintaining/affinity-team-captain/index.html +395 -479
  50. data/site/docs/maintaining/avoiding-burnout/index.html +391 -475
  51. data/site/docs/maintaining/becoming-a-maintainer/index.html +391 -475
  52. data/site/docs/maintaining/index.html +391 -486
  53. data/site/docs/maintaining/merging-a-pull-request/index.html +406 -490
  54. data/site/docs/maintaining/releasing-a-new-version/index.html +409 -485
  55. data/site/docs/maintaining/reviewing-a-pull-request/index.html +392 -476
  56. data/site/docs/maintaining/special-labels/index.html +397 -481
  57. data/site/docs/maintaining/triaging-an-issue/index.html +394 -478
  58. data/site/docs/markdown-101/index.html +601 -0
  59. data/site/docs/migrations/index.html +396 -440
  60. data/site/docs/pages/index.html +408 -482
  61. data/site/docs/pagination/index.html +450 -509
  62. data/site/docs/permalinks/index.html +552 -587
  63. data/site/docs/plugins/commands/index.html +656 -0
  64. data/site/docs/plugins/converters/index.html +685 -0
  65. data/site/docs/plugins/filters/index.html +624 -0
  66. data/site/docs/plugins/generators/index.html +697 -0
  67. data/site/docs/plugins/hooks/index.html +838 -0
  68. data/site/docs/plugins/index.html +415 -1565
  69. data/site/docs/plugins/installation/index.html +681 -0
  70. data/site/docs/plugins/tags/index.html +699 -0
  71. data/site/docs/plugins/your-first-plugin/index.html +741 -0
  72. data/site/docs/posts/index.html +491 -627
  73. data/site/docs/quickstart/index.html +9 -645
  74. data/site/docs/resources/index.html +9 -761
  75. data/site/docs/ruby-101/index.html +640 -0
  76. data/site/docs/sites/index.html +9 -696
  77. data/site/docs/static-files/index.html +401 -433
  78. data/site/docs/step-by-step/01-setup/index.html +771 -0
  79. data/site/docs/step-by-step/02-liquid/index.html +756 -0
  80. data/site/docs/step-by-step/03-front-matter/index.html +730 -0
  81. data/site/docs/step-by-step/04-layouts/index.html +770 -0
  82. data/site/docs/step-by-step/05-includes/index.html +768 -0
  83. data/site/docs/step-by-step/06-data-files/index.html +738 -0
  84. data/site/docs/step-by-step/07-assets/index.html +773 -0
  85. data/site/docs/step-by-step/08-blogging/index.html +835 -0
  86. data/site/docs/step-by-step/09-collections/index.html +932 -0
  87. data/site/docs/step-by-step/10-deployment/index.html +842 -0
  88. data/site/docs/structure/index.html +411 -430
  89. data/site/docs/support/index.html +392 -476
  90. data/site/docs/templates/index.html +9 -1232
  91. data/site/docs/themes/index.html +487 -521
  92. data/site/docs/troubleshooting/index.html +443 -520
  93. data/site/docs/upgrading/0-to-2/index.html +437 -523
  94. data/site/docs/upgrading/2-to-3/index.html +422 -507
  95. data/site/docs/upgrading/3-to-4/index.html +765 -0
  96. data/site/docs/upgrading/index.html +395 -478
  97. data/site/docs/usage/index.html +409 -506
  98. data/site/docs/variables/index.html +504 -652
  99. data/site/docs/windows/index.html +9 -784
  100. data/site/feed.xml +269 -188
  101. data/site/feed/release.xml +324 -0
  102. data/site/fonts/lato-v14-latin-300.woff +0 -0
  103. data/site/fonts/lato-v14-latin-300.woff2 +0 -0
  104. data/site/fonts/lato-v14-latin-300italic.woff +0 -0
  105. data/site/fonts/lato-v14-latin-300italic.woff2 +0 -0
  106. data/site/fonts/lato-v14-latin-700.woff +0 -0
  107. data/site/fonts/lato-v14-latin-700.woff2 +0 -0
  108. data/site/fonts/lato-v14-latin-700italic.woff +0 -0
  109. data/site/fonts/lato-v14-latin-700italic.woff2 +0 -0
  110. data/site/fonts/lato-v14-latin-900.woff +0 -0
  111. data/site/fonts/lato-v14-latin-900.woff2 +0 -0
  112. data/site/fonts/lato-v14-latin-900italic.woff +0 -0
  113. data/site/fonts/lato-v14-latin-900italic.woff2 +0 -0
  114. data/site/fonts/lato-v14-latin-italic.woff +0 -0
  115. data/site/fonts/lato-v14-latin-italic.woff2 +0 -0
  116. data/site/fonts/lato-v14-latin-regular.woff +0 -0
  117. data/site/fonts/lato-v14-latin-regular.woff2 +0 -0
  118. data/site/help/index.html +9 -247
  119. data/site/img/forestry-logo.svg +19 -0
  120. data/site/img/jekyll-og.png +0 -0
  121. data/site/img/spacer.gif +0 -0
  122. data/site/index.html +56 -29
  123. data/site/jekyllconf/index.html +62 -35
  124. data/site/latest_version.txt +1 -1
  125. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +180 -115
  126. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +182 -117
  127. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +183 -118
  128. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +184 -119
  129. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +183 -118
  130. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +180 -115
  131. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +182 -117
  132. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +182 -117
  133. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +185 -120
  134. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +183 -118
  135. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +180 -115
  136. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +189 -124
  137. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +181 -116
  138. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +181 -116
  139. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +180 -115
  140. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +182 -117
  141. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +181 -116
  142. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +181 -116
  143. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +181 -116
  144. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +184 -119
  145. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +180 -115
  146. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +181 -116
  147. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +185 -120
  148. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +182 -117
  149. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +181 -116
  150. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +189 -124
  151. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +187 -122
  152. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +188 -123
  153. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +180 -115
  154. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +182 -117
  155. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +179 -114
  156. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +180 -115
  157. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +179 -114
  158. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +180 -115
  159. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +180 -115
  160. data/site/news/2015/10/26/jekyll-3-0-released/index.html +185 -120
  161. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +184 -119
  162. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +182 -117
  163. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +186 -121
  164. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +183 -118
  165. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +181 -116
  166. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +182 -117
  167. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +179 -114
  168. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +181 -116
  169. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +181 -116
  170. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +180 -115
  171. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +186 -121
  172. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +181 -116
  173. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +181 -116
  174. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +179 -114
  175. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +184 -119
  176. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +180 -115
  177. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +179 -114
  178. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +207 -142
  179. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +181 -116
  180. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +183 -118
  181. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +181 -116
  182. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +189 -124
  183. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +190 -125
  184. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +187 -122
  185. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +182 -117
  186. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +185 -120
  187. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +181 -116
  188. data/site/news/2017/10/19/diversity-open-source/index.html +181 -116
  189. data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +183 -118
  190. data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +184 -119
  191. data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +189 -124
  192. data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +180 -115
  193. data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +185 -120
  194. data/site/news/2018/04/19/development-update/index.html +699 -0
  195. data/site/news/2018/04/19/jekyll-3-8-0-released/index.html +715 -0
  196. data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +182 -117
  197. data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +181 -116
  198. data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +183 -118
  199. data/site/news/2018/08/01/jekyll-sponsoring/index.html +748 -0
  200. data/site/news/2018/09/19/security-fixes-for-3-6-3-7-3-8/index.html +692 -0
  201. data/site/news/2018/11/04/jekyll-3-8-5-released/index.html +682 -0
  202. data/site/news/2019/03/18/jekyll-4-0-0-pre-alpha1-released/index.html +710 -0
  203. data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +180 -115
  204. data/site/news/2019/07/20/jekyll-4-0-0-pre-beta1-released/index.html +11 -0
  205. data/site/news/2019/08/04/jekyll-4-0-0-pre-beta1-released/index.html +708 -0
  206. data/site/news/2019/08/20/jekyll-4-0-0-released/index.html +809 -0
  207. data/site/news/index.html +976 -326
  208. data/site/news/releases/index.html +820 -321
  209. data/site/{philosophy.html → philosophy/index.html} +1 -1
  210. data/site/redirects.json +1 -1
  211. data/site/resources/index.html +332 -0
  212. data/site/showcase/index.html +844 -0
  213. data/site/sitemap.xml +256 -81
  214. data/site/team/index.html +63 -77
  215. data/site/tutorials/cache-api/index.html +418 -0
  216. data/site/tutorials/convert-site-to-jekyll/index.html +155 -124
  217. data/site/tutorials/custom-404-page/index.html +76 -43
  218. data/site/tutorials/home/index.html +64 -37
  219. data/site/tutorials/navigation/index.html +186 -103
  220. data/site/tutorials/orderofinterpretation/index.html +80 -53
  221. data/site/tutorials/using-jekyll-with-bundler/index.html +80 -51
  222. data/site/tutorials/video-walkthroughs/index.html +62 -35
  223. metadata +102 -13
  224. data/site/community/index.html +0 -11
  225. data/site/docs/continuous-integration/index.html +0 -681
@@ -0,0 +1,771 @@
1
+ <!DOCTYPE HTML>
2
+ <html lang="en-US">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <meta name="generator" content="Jekyll v4.0.0">
7
+ <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
8
+ <link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
9
+ <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
10
+ <link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
11
+ <link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
12
+ <link rel="preload" href="/css/screen.css" as="style">
13
+ <link rel="stylesheet" href="/css/screen.css">
14
+ <link rel="icon" type="image/x-icon" href="/favicon.ico">
15
+ <!-- Begin Jekyll SEO tag v2.6.1 -->
16
+ <title>Setup | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Setup" />
19
+ <meta property="og:locale" content="en_US" />
20
+ <meta name="description" content="Welcome to Jekyll’s step-by-step tutorial. The goal of this tutorial is to take you from having some front end web development experience to building your first Jekyll site from scratch — not relying on the default gem-based theme. Let’s get into it!" />
21
+ <meta property="og:description" content="Welcome to Jekyll’s step-by-step tutorial. The goal of this tutorial is to take you from having some front end web development experience to building your first Jekyll site from scratch — not relying on the default gem-based theme. Let’s get into it!" />
22
+ <link rel="canonical" href="https://jekyllrb.com/docs/step-by-step/01-setup/" />
23
+ <meta property="og:url" content="https://jekyllrb.com/docs/step-by-step/01-setup/" />
24
+ <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
25
+ <meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
26
+ <meta property="og:type" content="article" />
27
+ <meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
28
+ <meta name="twitter:card" content="summary_large_image" />
29
+ <meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
30
+ <meta property="twitter:title" content="Setup" />
31
+ <meta name="twitter:site" content="@jekyllrb" />
32
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
33
+ <script type="application/ld+json">
34
+ {"description":"Welcome to Jekyll’s step-by-step tutorial. The goal of this tutorial is to take you from having some front end web development experience to building your first Jekyll site from scratch — not relying on the default gem-based theme. Let’s get into it!","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/step-by-step/01-setup/"},"headline":"Setup","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/step-by-step/01-setup/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
35
+ <!-- End Jekyll SEO tag -->
36
+
37
+ <!--[if lt IE 9]>
38
+ <script src="/js/html5shiv.min.js"></script>
39
+ <script src="/js/respond.min.js"></script>
40
+ <![endif]-->
41
+ </head>
42
+
43
+
44
+ <body class="wrap">
45
+ <header>
46
+ <div class="flexbox">
47
+ <div class="center-on-mobiles">
48
+ <h1>
49
+ <a href="/" class="logo">
50
+ <span class="sr-only">Jekyll</span>
51
+ <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
52
+ </a>
53
+ </h1>
54
+ </div>
55
+ <nav class="main-nav hide-on-mobiles">
56
+ <ul>
57
+
58
+ <li>
59
+ <a href="/">Home</a>
60
+ </li>
61
+
62
+ <li class="current">
63
+ <a href="/docs/">Docs</a>
64
+ </li>
65
+
66
+ <li>
67
+ <a href="/resources/">Resources</a>
68
+ </li>
69
+
70
+ <li>
71
+ <a href="/showcase/">Showcase</a>
72
+ </li>
73
+
74
+ <li>
75
+ <a href="/news/">News</a>
76
+ </li>
77
+
78
+ </ul>
79
+
80
+ </nav>
81
+ <div class="search hide-on-mobiles">
82
+ <input type="text" id="docsearch-input" placeholder="Search the docs…">
83
+
84
+ </div>
85
+ <div class="meta hide-on-mobiles">
86
+ <ul>
87
+ <li>
88
+ <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
89
+ </li>
90
+ <li>
91
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
92
+ </li>
93
+ </ul>
94
+ </div>
95
+ </div>
96
+ <nav class="mobile-nav show-on-mobiles">
97
+ <ul>
98
+
99
+ <li>
100
+ <a href="/">Home</a>
101
+ </li>
102
+
103
+ <li class="current">
104
+ <a href="/docs/">Docs</a>
105
+ </li>
106
+
107
+ <li>
108
+ <a href="/resources/">Resources</a>
109
+ </li>
110
+
111
+
112
+ <li>
113
+ <a href="/news/">News</a>
114
+ </li>
115
+
116
+ <li>
117
+ <a href="https://github.com/jekyll/jekyll">GitHub</a>
118
+ </li>
119
+ </ul>
120
+
121
+ </nav>
122
+ </header>
123
+
124
+
125
+ <section class="docs">
126
+ <div class="grid">
127
+
128
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
129
+ <select onchange="if (this.value) window.location.href=this.value">
130
+ <option value="">Navigate the docs…</option>
131
+
132
+ <optgroup label="Getting Started">
133
+
134
+
135
+ <option value="/docs/">
136
+ Quickstart
137
+ </option>
138
+
139
+
140
+ <option value="/docs/ruby-101/">
141
+ Ruby 101
142
+ </option>
143
+
144
+
145
+ <option value="/docs/installation/">
146
+ Installation
147
+ </option>
148
+
149
+
150
+ <option value="/docs/community/">
151
+ Community
152
+ </option>
153
+
154
+
155
+ <option value="/docs/step-by-step/01-setup/">
156
+ Step by Step Tutorial
157
+ </option>
158
+
159
+ </optgroup>
160
+
161
+ <optgroup label="Build">
162
+
163
+
164
+ <option value="/docs/usage/">
165
+ Command Line Usage
166
+ </option>
167
+
168
+
169
+ <option value="/docs/configuration/">
170
+ Configuration
171
+ </option>
172
+
173
+ </optgroup>
174
+
175
+ <optgroup label="Content">
176
+
177
+
178
+ <option value="/docs/pages/">
179
+ Pages
180
+ </option>
181
+
182
+
183
+ <option value="/docs/posts/">
184
+ Posts
185
+ </option>
186
+
187
+
188
+ <option value="/docs/front-matter/">
189
+ Front Matter
190
+ </option>
191
+
192
+
193
+ <option value="/docs/collections/">
194
+ Collections
195
+ </option>
196
+
197
+
198
+ <option value="/docs/datafiles/">
199
+ Data Files
200
+ </option>
201
+
202
+
203
+ <option value="/docs/assets/">
204
+ Assets
205
+ </option>
206
+
207
+
208
+ <option value="/docs/static-files/">
209
+ Static Files
210
+ </option>
211
+
212
+ </optgroup>
213
+
214
+ <optgroup label="Site Structure">
215
+
216
+
217
+ <option value="/docs/structure/">
218
+ Directory Structure
219
+ </option>
220
+
221
+
222
+ <option value="/docs/liquid/">
223
+ Liquid
224
+ </option>
225
+
226
+
227
+ <option value="/docs/variables/">
228
+ Variables
229
+ </option>
230
+
231
+
232
+ <option value="/docs/includes/">
233
+ Includes
234
+ </option>
235
+
236
+
237
+ <option value="/docs/layouts/">
238
+ Layouts
239
+ </option>
240
+
241
+
242
+ <option value="/docs/permalinks/">
243
+ Permalinks
244
+ </option>
245
+
246
+
247
+ <option value="/docs/themes/">
248
+ Themes
249
+ </option>
250
+
251
+
252
+ <option value="/docs/pagination/">
253
+ Pagination
254
+ </option>
255
+
256
+ </optgroup>
257
+
258
+ <optgroup label="Guides">
259
+
260
+
261
+ <option value="/docs/plugins/">
262
+ Plugins
263
+ </option>
264
+
265
+
266
+ <option value="/docs/migrations/">
267
+ Blog Migrations
268
+ </option>
269
+
270
+
271
+ <option value="/docs/upgrading/">
272
+ Upgrading
273
+ </option>
274
+
275
+
276
+ <option value="/docs/deployment/">
277
+ Deployment
278
+ </option>
279
+
280
+ </optgroup>
281
+
282
+ </select>
283
+ </div>
284
+
285
+
286
+ <div class="unit four-fifths">
287
+ <article>
288
+ <div class="improve right hide-on-mobiles">
289
+ <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/step-by-step/01-setup.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
290
+ </div>
291
+ <h1>Step by Step Tutorial</h1>
292
+ <h2>1. Setup</h2>
293
+ <p>Welcome to Jekyll’s step-by-step tutorial. The goal of this tutorial is to take
294
+ you from having some front end web development experience to building your
295
+ first Jekyll site from scratch — not relying on the default gem-based theme.
296
+ Let’s get into it!</p>
297
+
298
+ <h2 id="installation">Installation</h2>
299
+
300
+ <p>Jekyll is a Ruby program so you need to install Ruby on your machine to begin
301
+ with. Head over to the <a href="/docs/installation/">install guide</a> and follow the
302
+ instructions for your operating system.</p>
303
+
304
+ <p>With Ruby setup you can install Jekyll by running the following in your
305
+ terminal:</p>
306
+
307
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem install jekyll bundler
308
+ </code></pre></div></div>
309
+
310
+ <p>To create a new <code class="highlighter-rouge">Gemfile</code> to list your project’s dependencies run:</p>
311
+
312
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bundle init
313
+ </code></pre></div></div>
314
+
315
+ <p>Now edit the <code class="highlighter-rouge">Gemfile</code>and add jekyll as a dependency:</p>
316
+
317
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>gem "jekyll"
318
+ </code></pre></div></div>
319
+
320
+ <p>Finally run <code class="highlighter-rouge">bundle</code> to install jekyll for your project.</p>
321
+
322
+ <p>You can now prefix all jekyll commands listed in this tutorial with <code class="highlighter-rouge">bundle exec</code>
323
+ to make sure you use the jekyll version defined in your <code class="highlighter-rouge">Gemfile</code>.</p>
324
+
325
+ <h2 id="create-a-site">Create a site</h2>
326
+
327
+ <p>It’s time to create a site! Create a new directory for your site, you can name
328
+ it whatever you’d like. Through the rest of this tutorial we’ll refer to this
329
+ directory as “root”.</p>
330
+
331
+ <p>If you’re feeling adventurous, you can also initialize a Git repository here.
332
+ One of the great things about Jekyll is there’s no database. All content and
333
+ site structure are files which a Git repository can version. Using a repository
334
+ is completely optional but it’s a great habit to get into. You can learn more
335
+ about using Git by reading through the
336
+ <a href="https://guides.github.com/introduction/git-handbook/">Git Handbook</a>.</p>
337
+
338
+ <p>Let’s add your first file. Create <code class="highlighter-rouge">index.html</code> in the root with the following
339
+ content:</p>
340
+
341
+ <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;!doctype html&gt;</span>
342
+ <span class="nt">&lt;html&gt;</span>
343
+ <span class="nt">&lt;head&gt;</span>
344
+ <span class="nt">&lt;meta</span> <span class="na">charset=</span><span class="s">"utf-8"</span><span class="nt">&gt;</span>
345
+ <span class="nt">&lt;title&gt;</span>Home<span class="nt">&lt;/title&gt;</span>
346
+ <span class="nt">&lt;/head&gt;</span>
347
+ <span class="nt">&lt;body&gt;</span>
348
+ <span class="nt">&lt;h1&gt;</span>Hello World!<span class="nt">&lt;/h1&gt;</span>
349
+ <span class="nt">&lt;/body&gt;</span>
350
+ <span class="nt">&lt;/html&gt;</span>
351
+ </code></pre></div></div>
352
+
353
+ <h2 id="build">Build</h2>
354
+
355
+ <p>Jekyll is a static site generator so we need Jekyll to build the site
356
+ before we can view it. There are two commands you can run in the root of your site
357
+ to build it:</p>
358
+
359
+ <ul>
360
+ <li><code class="highlighter-rouge">jekyll build</code> - Builds the site and outputs a static site to a directory
361
+ called <code class="highlighter-rouge">_site</code>.</li>
362
+ <li><code class="highlighter-rouge">jekyll serve</code> - Does the same thing except it rebuilds any time you make
363
+ a change and runs a local web server at <code class="highlighter-rouge">http://localhost:4000</code>.</li>
364
+ </ul>
365
+
366
+ <p>When you’re developing a site you’ll use <code class="highlighter-rouge">jekyll serve</code> as it updates with any
367
+ changes you make.</p>
368
+
369
+ <p>Run <code class="highlighter-rouge">jekyll serve</code> and go to
370
+ <a href="http://localhost:4000" target="_blank" data-proofer-ignore="">http://localhost:4000</a> in
371
+ your browser. You should see “Hello World!”.</p>
372
+
373
+ <p>Well, you might be thinking what’s the point in this? Jekyll just copied an
374
+ HTML file from one place to another. Well patience young grasshopper, there’s
375
+ still much to learn!</p>
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ <div class="section-nav">
385
+ <div class="left align-right">
386
+
387
+ <span class="prev disabled">Back</span>
388
+
389
+ </div>
390
+ <div class="right align-left">
391
+
392
+
393
+ <a href="/docs/step-by-step/02-liquid/" class="next">Next</a>
394
+
395
+ </div>
396
+ </div>
397
+ <div class="clear"></div>
398
+
399
+
400
+ <ol class="step-nav">
401
+
402
+ <li class="current">
403
+ <a href="/docs/step-by-step/01-setup/">
404
+ Setup
405
+ </a>
406
+ </li>
407
+
408
+ <li >
409
+ <a href="/docs/step-by-step/02-liquid/">
410
+ Liquid
411
+ </a>
412
+ </li>
413
+
414
+ <li >
415
+ <a href="/docs/step-by-step/03-front-matter/">
416
+ Front Matter
417
+ </a>
418
+ </li>
419
+
420
+ <li >
421
+ <a href="/docs/step-by-step/04-layouts/">
422
+ Layouts
423
+ </a>
424
+ </li>
425
+
426
+ <li >
427
+ <a href="/docs/step-by-step/05-includes/">
428
+ Includes
429
+ </a>
430
+ </li>
431
+
432
+ <li >
433
+ <a href="/docs/step-by-step/06-data-files/">
434
+ Data Files
435
+ </a>
436
+ </li>
437
+
438
+ <li >
439
+ <a href="/docs/step-by-step/07-assets/">
440
+ Assets
441
+ </a>
442
+ </li>
443
+
444
+ <li >
445
+ <a href="/docs/step-by-step/08-blogging/">
446
+ Blogging
447
+ </a>
448
+ </li>
449
+
450
+ <li >
451
+ <a href="/docs/step-by-step/09-collections/">
452
+ Collections
453
+ </a>
454
+ </li>
455
+
456
+ <li >
457
+ <a href="/docs/step-by-step/10-deployment/">
458
+ Deployment
459
+ </a>
460
+ </li>
461
+
462
+ </ol>
463
+
464
+ </article>
465
+ </div>
466
+
467
+ <div class="unit one-fifth hide-on-mobiles">
468
+ <aside>
469
+
470
+ <h4>Getting Started</h4>
471
+ <ul>
472
+
473
+
474
+ <li>
475
+ <a href="/docs/">
476
+ Quickstart
477
+ </a>
478
+ </li>
479
+
480
+
481
+ <li>
482
+ <a href="/docs/ruby-101/">
483
+ Ruby 101
484
+ </a>
485
+ </li>
486
+
487
+
488
+ <li>
489
+ <a href="/docs/installation/">
490
+ Installation
491
+ </a>
492
+ </li>
493
+
494
+
495
+ <li>
496
+ <a href="/docs/community/">
497
+ Community
498
+ </a>
499
+ </li>
500
+
501
+
502
+ <li class="current">
503
+ <a href="/docs/step-by-step/01-setup/">
504
+ Step by Step Tutorial
505
+ </a>
506
+ </li>
507
+
508
+ </ul>
509
+
510
+ <h4>Build</h4>
511
+ <ul>
512
+
513
+
514
+ <li>
515
+ <a href="/docs/usage/">
516
+ Command Line Usage
517
+ </a>
518
+ </li>
519
+
520
+
521
+ <li>
522
+ <a href="/docs/configuration/">
523
+ Configuration
524
+ </a>
525
+ </li>
526
+
527
+ </ul>
528
+
529
+ <h4>Content</h4>
530
+ <ul>
531
+
532
+
533
+ <li>
534
+ <a href="/docs/pages/">
535
+ Pages
536
+ </a>
537
+ </li>
538
+
539
+
540
+ <li>
541
+ <a href="/docs/posts/">
542
+ Posts
543
+ </a>
544
+ </li>
545
+
546
+
547
+ <li>
548
+ <a href="/docs/front-matter/">
549
+ Front Matter
550
+ </a>
551
+ </li>
552
+
553
+
554
+ <li>
555
+ <a href="/docs/collections/">
556
+ Collections
557
+ </a>
558
+ </li>
559
+
560
+
561
+ <li>
562
+ <a href="/docs/datafiles/">
563
+ Data Files
564
+ </a>
565
+ </li>
566
+
567
+
568
+ <li>
569
+ <a href="/docs/assets/">
570
+ Assets
571
+ </a>
572
+ </li>
573
+
574
+
575
+ <li>
576
+ <a href="/docs/static-files/">
577
+ Static Files
578
+ </a>
579
+ </li>
580
+
581
+ </ul>
582
+
583
+ <h4>Site Structure</h4>
584
+ <ul>
585
+
586
+
587
+ <li>
588
+ <a href="/docs/structure/">
589
+ Directory Structure
590
+ </a>
591
+ </li>
592
+
593
+
594
+ <li>
595
+ <a href="/docs/liquid/">
596
+ Liquid
597
+ </a>
598
+ </li>
599
+
600
+
601
+ <li>
602
+ <a href="/docs/variables/">
603
+ Variables
604
+ </a>
605
+ </li>
606
+
607
+
608
+ <li>
609
+ <a href="/docs/includes/">
610
+ Includes
611
+ </a>
612
+ </li>
613
+
614
+
615
+ <li>
616
+ <a href="/docs/layouts/">
617
+ Layouts
618
+ </a>
619
+ </li>
620
+
621
+
622
+ <li>
623
+ <a href="/docs/permalinks/">
624
+ Permalinks
625
+ </a>
626
+ </li>
627
+
628
+
629
+ <li>
630
+ <a href="/docs/themes/">
631
+ Themes
632
+ </a>
633
+ </li>
634
+
635
+
636
+ <li>
637
+ <a href="/docs/pagination/">
638
+ Pagination
639
+ </a>
640
+ </li>
641
+
642
+ </ul>
643
+
644
+ <h4>Guides</h4>
645
+ <ul>
646
+
647
+
648
+ <li>
649
+ <a href="/docs/plugins/">
650
+ Plugins
651
+ </a>
652
+ </li>
653
+
654
+
655
+ <li>
656
+ <a href="/docs/migrations/">
657
+ Blog Migrations
658
+ </a>
659
+ </li>
660
+
661
+
662
+ <li>
663
+ <a href="/docs/upgrading/">
664
+ Upgrading
665
+ </a>
666
+ </li>
667
+
668
+
669
+ <li>
670
+ <a href="/docs/deployment/">
671
+ Deployment
672
+ </a>
673
+ </li>
674
+
675
+ </ul>
676
+
677
+ </aside>
678
+ </div>
679
+
680
+
681
+ <div class="clear"></div>
682
+
683
+ </div>
684
+ </section>
685
+
686
+
687
+ <footer>
688
+ <div class="grid">
689
+ <div class="unit one-third center-on-mobiles">
690
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
691
+ <p>The contents of this website are <br />&copy;&nbsp;2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
692
+ </div>
693
+ <div class="unit two-thirds align-right center-on-mobiles">
694
+ <p>
695
+ Proudly hosted by
696
+ <a href="https://github.com">
697
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
698
+ </a>
699
+ </p>
700
+ </div>
701
+ <div class="unit two-thirds align-right center-on-mobiles">
702
+ <p>
703
+ Jekyll is funded thanks to its
704
+ <a href="https://github.com/jekyll/jekyll#sponsors">
705
+ sponsors!
706
+ </a>
707
+ </p>
708
+ </div>
709
+ </div>
710
+ </footer>
711
+
712
+ <script>
713
+ var anchorForId = function (id) {
714
+ var anchor = document.createElement("a");
715
+ anchor.className = "header-link";
716
+ anchor.href = "#" + id;
717
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
718
+ anchor.title = "Permalink";
719
+ return anchor;
720
+ };
721
+
722
+ var linkifyAnchors = function (level, containingElement) {
723
+ var headers = containingElement.getElementsByTagName("h" + level);
724
+ for (var h = 0; h < headers.length; h++) {
725
+ var header = headers[h];
726
+
727
+ if (typeof header.id !== "undefined" && header.id !== "") {
728
+ header.appendChild(anchorForId(header.id));
729
+ }
730
+ }
731
+ };
732
+
733
+ document.onreadystatechange = function () {
734
+ if (this.readyState === "complete") {
735
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
736
+ if (!contentBlock) {
737
+ return;
738
+ }
739
+ for (var level = 1; level <= 6; level++) {
740
+ linkifyAnchors(level, contentBlock);
741
+ }
742
+ }
743
+ };
744
+ </script>
745
+
746
+
747
+ <!-- Google Analytics (https://www.google.com/analytics) -->
748
+ <script>
749
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
750
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
751
+ L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
752
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
753
+
754
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
755
+ ga('send', 'pageview');
756
+
757
+ </script>
758
+
759
+
760
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
761
+ <script type="text/javascript"> docsearch({
762
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
763
+ indexName: 'jekyllrb',
764
+ inputSelector: '#docsearch-input',
765
+ enhancedSearchInput: true,
766
+ debug: false // Set debug to true if you want to inspect the dropdown
767
+ });
768
+ </script>
769
+
770
+ </body>
771
+ </html>