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,842 @@
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>Deployment | Jekyll • Simple, blog-aware, static sites</title>
17
+ <meta name="generator" content="Jekyll v4.0.0" />
18
+ <meta property="og:title" content="Deployment" />
19
+ <meta property="og:locale" content="en_US" />
20
+ <meta name="description" content="In this final step we’ll get the site ready for production." />
21
+ <meta property="og:description" content="In this final step we’ll get the site ready for production." />
22
+ <link rel="canonical" href="https://jekyllrb.com/docs/step-by-step/10-deployment/" />
23
+ <meta property="og:url" content="https://jekyllrb.com/docs/step-by-step/10-deployment/" />
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="Deployment" />
31
+ <meta name="twitter:site" content="@jekyllrb" />
32
+ <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
33
+ <script type="application/ld+json">
34
+ {"description":"In this final step we’ll get the site ready for production.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/step-by-step/10-deployment/"},"headline":"Deployment","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/step-by-step/10-deployment/","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/10-deployment.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
290
+ </div>
291
+ <h1>Step by Step Tutorial</h1>
292
+ <h2>10. Deployment</h2>
293
+ <p>In this final step we’ll get the site ready for production.</p>
294
+
295
+ <h2 id="gemfile">Gemfile</h2>
296
+
297
+ <p>It’s good practice to have a <a href="/docs/ruby-101/#gemfile">Gemfile</a> for your site.
298
+ This ensures the version of Jekyll and other gems remains consistent across
299
+ different environments.</p>
300
+
301
+ <p>Create <code class="highlighter-rouge">Gemfile</code> in the root with the following:</p>
302
+
303
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>source 'https://rubygems.org'
304
+
305
+ gem 'jekyll'
306
+ </code></pre></div></div>
307
+
308
+ <p>Then run <code class="highlighter-rouge">bundle install</code> in your terminal. This installs the gems and
309
+ creates <code class="highlighter-rouge">Gemfile.lock</code> which locks the current gem versions for a future
310
+ <code class="highlighter-rouge">bundle install</code>. If you ever want to update your gem versions you can run
311
+ <code class="highlighter-rouge">bundle update</code>.</p>
312
+
313
+ <p>When using a <code class="highlighter-rouge">Gemfile</code>, you’ll run commands like <code class="highlighter-rouge">jekyll serve</code> with
314
+ <code class="highlighter-rouge">bundle exec</code> prefixed. So the full command is:</p>
315
+
316
+ <div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>bundle <span class="nb">exec </span>jekyll serve
317
+ </code></pre></div></div>
318
+
319
+ <p>This restricts your Ruby environment to only use gems set in your <code class="highlighter-rouge">Gemfile</code>.</p>
320
+
321
+ <h2 id="plugins">Plugins</h2>
322
+
323
+ <p>Jekyll plugins allow you to create custom generated content specific to your
324
+ site. There’s many <a href="/docs/plugins/">plugins</a> available or you can even
325
+ write your own.</p>
326
+
327
+ <p>There’s three official plugins which are useful on almost any Jekyll site:</p>
328
+
329
+ <ul>
330
+ <li><a href="https://github.com/jekyll/jekyll-sitemap">jekyll-sitemap</a> - Creates a sitemap
331
+ file to help search engines index content</li>
332
+ <li><a href="https://github.com/jekyll/jekyll-feed">jekyll-feed</a> - Creates an RSS feed for
333
+ your posts</li>
334
+ <li><a href="https://github.com/jekyll/jekyll-seo-tag">jekyll-seo-tag</a> - Adds meta tags to help
335
+ with SEO</li>
336
+ </ul>
337
+
338
+ <p>To use these first you need to add them to your <code class="highlighter-rouge">Gemfile</code>. If you put them
339
+ in a <code class="highlighter-rouge">jekyll_plugins</code> group they’ll automatically be required into Jekyll:</p>
340
+
341
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>source 'https://rubygems.org'
342
+
343
+ gem 'jekyll'
344
+
345
+ group :jekyll_plugins do
346
+ gem 'jekyll-sitemap'
347
+ gem 'jekyll-feed'
348
+ gem 'jekyll-seo-tag'
349
+ end
350
+ </code></pre></div></div>
351
+
352
+ <p>Then add these lines to your <code class="highlighter-rouge">_config.yml</code>:</p>
353
+
354
+ <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>plugins:
355
+ - jekyll-feed
356
+ - jekyll-sitemap
357
+ - jekyll-seo-tag
358
+ </code></pre></div></div>
359
+
360
+ <p>Now install them by running a <code class="highlighter-rouge">bundle update</code>.</p>
361
+
362
+ <p><code class="highlighter-rouge">jekyll-sitemap</code> doesn’t need any setup, it will create your sitemap on build.</p>
363
+
364
+ <p>For <code class="highlighter-rouge">jekyll-feed</code> and <code class="highlighter-rouge">jekyll-seo-tag</code> you need to add tags to
365
+ <code class="highlighter-rouge">_layouts/default.html</code>:</p>
366
+
367
+ <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>&lt;!doctype html&gt;
368
+ &lt;html&gt;
369
+ &lt;head&gt;
370
+ &lt;meta charset="utf-8"&gt;
371
+ &lt;title&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span>&lt;/title&gt;
372
+ &lt;link rel="stylesheet" href="/assets/css/styles.css"&gt;
373
+ <span class="p">{%</span><span class="w"> </span><span class="nt">feed_meta</span><span class="w"> </span><span class="p">%}</span>
374
+ <span class="p">{%</span><span class="w"> </span><span class="nt">seo</span><span class="w"> </span><span class="p">%}</span>
375
+ &lt;/head&gt;
376
+ &lt;body&gt;
377
+ <span class="p">{%</span><span class="w"> </span><span class="nt">include</span><span class="w"> </span><span class="na">navigation</span><span class="p">.</span><span class="na">html</span><span class="w"> </span><span class="p">%}</span>
378
+ <span class="p">{{</span><span class="w"> </span><span class="nv">content</span><span class="w"> </span><span class="p">}}</span>
379
+ &lt;/body&gt;
380
+ &lt;/html&gt;
381
+ </code></pre></div></div>
382
+
383
+ <p>Restart your Jekyll server and check these tags are added to the <code class="highlighter-rouge">&lt;head&gt;</code>.</p>
384
+
385
+ <h2 id="environments">Environments</h2>
386
+
387
+ <p>Sometimes you might want to output something in production but not
388
+ in development. Analytics scripts are the most common example of this.</p>
389
+
390
+ <p>To do this you can use <a href="/docs/configuration/environments/">environments</a>. You
391
+ can set the environment by using the <code class="highlighter-rouge">JEKYLL_ENV</code> environment variable when
392
+ running a command. For example:</p>
393
+
394
+ <div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">JEKYLL_ENV</span><span class="o">=</span>production bundle <span class="nb">exec </span>jekyll build
395
+ </code></pre></div></div>
396
+
397
+ <p>By default <code class="highlighter-rouge">JEKYLL_ENV</code> is development. The <code class="highlighter-rouge">JEKYLL_ENV</code> is available to you
398
+ in liquid using <code class="highlighter-rouge">jekyll.environment</code>. So to only output the analytics script
399
+ on production you would do the following:</p>
400
+
401
+ <div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">jekyll</span><span class="p">.</span><span class="nv">environment</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s2">"production"</span><span class="w"> </span><span class="p">%}</span>
402
+ &lt;script src="my-analytics-script.js"&gt;&lt;/script&gt;
403
+ <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
404
+ </code></pre></div></div>
405
+
406
+ <h2 id="deployment">Deployment</h2>
407
+
408
+ <p>The final step is to get the site onto a production server. The most basic way
409
+ to do this is to run a production build:</p>
410
+
411
+ <div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">JEKYLL_ENV</span><span class="o">=</span>production bundle <span class="nb">exec </span>jekyll build
412
+ </code></pre></div></div>
413
+
414
+ <p>And copy the contents of <code class="highlighter-rouge">_site</code> to your server.</p>
415
+
416
+ <p>A better way is to automate this process using a <a href="/docs/deployment/automated/">CI</a>
417
+ or <a href="/docs/deployment/third-party/">3rd party</a>.</p>
418
+
419
+ <h2 id="wrap-up">Wrap up</h2>
420
+
421
+ <p>That brings us to the end of this step-by-step tutorial and the beginning of
422
+ your Jekyll journey!</p>
423
+
424
+ <ul>
425
+ <li>Come say hi to the <a href="https://talk.jekyllrb.com">community forums</a></li>
426
+ <li>Help us make Jekyll better by <a href="/docs/contributing/">contributing</a></li>
427
+ <li>Keep building Jekyll sites!</li>
428
+ </ul>
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
+ <div class="section-nav">
456
+ <div class="left align-right">
457
+
458
+
459
+ <a href="/docs/step-by-step/09-collections/" class="prev">Back</a>
460
+
461
+ </div>
462
+ <div class="right align-left">
463
+
464
+ <span class="next disabled">Next</span>
465
+
466
+ </div>
467
+ </div>
468
+ <div class="clear"></div>
469
+
470
+
471
+ <ol class="step-nav">
472
+
473
+ <li >
474
+ <a href="/docs/step-by-step/01-setup/">
475
+ Setup
476
+ </a>
477
+ </li>
478
+
479
+ <li >
480
+ <a href="/docs/step-by-step/02-liquid/">
481
+ Liquid
482
+ </a>
483
+ </li>
484
+
485
+ <li >
486
+ <a href="/docs/step-by-step/03-front-matter/">
487
+ Front Matter
488
+ </a>
489
+ </li>
490
+
491
+ <li >
492
+ <a href="/docs/step-by-step/04-layouts/">
493
+ Layouts
494
+ </a>
495
+ </li>
496
+
497
+ <li >
498
+ <a href="/docs/step-by-step/05-includes/">
499
+ Includes
500
+ </a>
501
+ </li>
502
+
503
+ <li >
504
+ <a href="/docs/step-by-step/06-data-files/">
505
+ Data Files
506
+ </a>
507
+ </li>
508
+
509
+ <li >
510
+ <a href="/docs/step-by-step/07-assets/">
511
+ Assets
512
+ </a>
513
+ </li>
514
+
515
+ <li >
516
+ <a href="/docs/step-by-step/08-blogging/">
517
+ Blogging
518
+ </a>
519
+ </li>
520
+
521
+ <li >
522
+ <a href="/docs/step-by-step/09-collections/">
523
+ Collections
524
+ </a>
525
+ </li>
526
+
527
+ <li class="current">
528
+ <a href="/docs/step-by-step/10-deployment/">
529
+ Deployment
530
+ </a>
531
+ </li>
532
+
533
+ </ol>
534
+
535
+ </article>
536
+ </div>
537
+
538
+ <div class="unit one-fifth hide-on-mobiles">
539
+ <aside>
540
+
541
+ <h4>Getting Started</h4>
542
+ <ul>
543
+
544
+
545
+ <li>
546
+ <a href="/docs/">
547
+ Quickstart
548
+ </a>
549
+ </li>
550
+
551
+
552
+ <li>
553
+ <a href="/docs/ruby-101/">
554
+ Ruby 101
555
+ </a>
556
+ </li>
557
+
558
+
559
+ <li>
560
+ <a href="/docs/installation/">
561
+ Installation
562
+ </a>
563
+ </li>
564
+
565
+
566
+ <li>
567
+ <a href="/docs/community/">
568
+ Community
569
+ </a>
570
+ </li>
571
+
572
+
573
+ <li>
574
+ <a href="/docs/step-by-step/01-setup/">
575
+ Step by Step Tutorial
576
+ </a>
577
+ </li>
578
+
579
+ </ul>
580
+
581
+ <h4>Build</h4>
582
+ <ul>
583
+
584
+
585
+ <li>
586
+ <a href="/docs/usage/">
587
+ Command Line Usage
588
+ </a>
589
+ </li>
590
+
591
+
592
+ <li>
593
+ <a href="/docs/configuration/">
594
+ Configuration
595
+ </a>
596
+ </li>
597
+
598
+ </ul>
599
+
600
+ <h4>Content</h4>
601
+ <ul>
602
+
603
+
604
+ <li>
605
+ <a href="/docs/pages/">
606
+ Pages
607
+ </a>
608
+ </li>
609
+
610
+
611
+ <li>
612
+ <a href="/docs/posts/">
613
+ Posts
614
+ </a>
615
+ </li>
616
+
617
+
618
+ <li>
619
+ <a href="/docs/front-matter/">
620
+ Front Matter
621
+ </a>
622
+ </li>
623
+
624
+
625
+ <li>
626
+ <a href="/docs/collections/">
627
+ Collections
628
+ </a>
629
+ </li>
630
+
631
+
632
+ <li>
633
+ <a href="/docs/datafiles/">
634
+ Data Files
635
+ </a>
636
+ </li>
637
+
638
+
639
+ <li>
640
+ <a href="/docs/assets/">
641
+ Assets
642
+ </a>
643
+ </li>
644
+
645
+
646
+ <li>
647
+ <a href="/docs/static-files/">
648
+ Static Files
649
+ </a>
650
+ </li>
651
+
652
+ </ul>
653
+
654
+ <h4>Site Structure</h4>
655
+ <ul>
656
+
657
+
658
+ <li>
659
+ <a href="/docs/structure/">
660
+ Directory Structure
661
+ </a>
662
+ </li>
663
+
664
+
665
+ <li>
666
+ <a href="/docs/liquid/">
667
+ Liquid
668
+ </a>
669
+ </li>
670
+
671
+
672
+ <li>
673
+ <a href="/docs/variables/">
674
+ Variables
675
+ </a>
676
+ </li>
677
+
678
+
679
+ <li>
680
+ <a href="/docs/includes/">
681
+ Includes
682
+ </a>
683
+ </li>
684
+
685
+
686
+ <li>
687
+ <a href="/docs/layouts/">
688
+ Layouts
689
+ </a>
690
+ </li>
691
+
692
+
693
+ <li>
694
+ <a href="/docs/permalinks/">
695
+ Permalinks
696
+ </a>
697
+ </li>
698
+
699
+
700
+ <li>
701
+ <a href="/docs/themes/">
702
+ Themes
703
+ </a>
704
+ </li>
705
+
706
+
707
+ <li>
708
+ <a href="/docs/pagination/">
709
+ Pagination
710
+ </a>
711
+ </li>
712
+
713
+ </ul>
714
+
715
+ <h4>Guides</h4>
716
+ <ul>
717
+
718
+
719
+ <li>
720
+ <a href="/docs/plugins/">
721
+ Plugins
722
+ </a>
723
+ </li>
724
+
725
+
726
+ <li>
727
+ <a href="/docs/migrations/">
728
+ Blog Migrations
729
+ </a>
730
+ </li>
731
+
732
+
733
+ <li>
734
+ <a href="/docs/upgrading/">
735
+ Upgrading
736
+ </a>
737
+ </li>
738
+
739
+
740
+ <li>
741
+ <a href="/docs/deployment/">
742
+ Deployment
743
+ </a>
744
+ </li>
745
+
746
+ </ul>
747
+
748
+ </aside>
749
+ </div>
750
+
751
+
752
+ <div class="clear"></div>
753
+
754
+ </div>
755
+ </section>
756
+
757
+
758
+ <footer>
759
+ <div class="grid">
760
+ <div class="unit one-third center-on-mobiles">
761
+ <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
762
+ <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>
763
+ </div>
764
+ <div class="unit two-thirds align-right center-on-mobiles">
765
+ <p>
766
+ Proudly hosted by
767
+ <a href="https://github.com">
768
+ <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
769
+ </a>
770
+ </p>
771
+ </div>
772
+ <div class="unit two-thirds align-right center-on-mobiles">
773
+ <p>
774
+ Jekyll is funded thanks to its
775
+ <a href="https://github.com/jekyll/jekyll#sponsors">
776
+ sponsors!
777
+ </a>
778
+ </p>
779
+ </div>
780
+ </div>
781
+ </footer>
782
+
783
+ <script>
784
+ var anchorForId = function (id) {
785
+ var anchor = document.createElement("a");
786
+ anchor.className = "header-link";
787
+ anchor.href = "#" + id;
788
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
789
+ anchor.title = "Permalink";
790
+ return anchor;
791
+ };
792
+
793
+ var linkifyAnchors = function (level, containingElement) {
794
+ var headers = containingElement.getElementsByTagName("h" + level);
795
+ for (var h = 0; h < headers.length; h++) {
796
+ var header = headers[h];
797
+
798
+ if (typeof header.id !== "undefined" && header.id !== "") {
799
+ header.appendChild(anchorForId(header.id));
800
+ }
801
+ }
802
+ };
803
+
804
+ document.onreadystatechange = function () {
805
+ if (this.readyState === "complete") {
806
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
807
+ if (!contentBlock) {
808
+ return;
809
+ }
810
+ for (var level = 1; level <= 6; level++) {
811
+ linkifyAnchors(level, contentBlock);
812
+ }
813
+ }
814
+ };
815
+ </script>
816
+
817
+
818
+ <!-- Google Analytics (https://www.google.com/analytics) -->
819
+ <script>
820
+ !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
821
+ (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
822
+ L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
823
+ L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
824
+
825
+ ga('create', 'UA-50755011-1', 'jekyllrb.com');
826
+ ga('send', 'pageview');
827
+
828
+ </script>
829
+
830
+
831
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
832
+ <script type="text/javascript"> docsearch({
833
+ apiKey: '50fe39c839958dfad797000f33e2ec17',
834
+ indexName: 'jekyllrb',
835
+ inputSelector: '#docsearch-input',
836
+ enhancedSearchInput: true,
837
+ debug: false // Set debug to true if you want to inspect the dropdown
838
+ });
839
+ </script>
840
+
841
+ </body>
842
+ </html>