jekyll-docs 3.6.1.0 → 3.6.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/jekyll.rb +195 -0
- data/lib/jekyll/cleaner.rb +110 -0
- data/lib/jekyll/collection.rb +230 -0
- data/lib/jekyll/command.rb +78 -0
- data/lib/jekyll/commands/build.rb +102 -0
- data/lib/jekyll/commands/clean.rb +43 -0
- data/lib/jekyll/commands/doctor.rb +153 -0
- data/lib/jekyll/commands/help.rb +34 -0
- data/lib/jekyll/commands/new.rb +156 -0
- data/lib/jekyll/commands/new_theme.rb +40 -0
- data/lib/jekyll/commands/serve.rb +245 -0
- data/lib/jekyll/commands/serve/servlet.rb +62 -0
- data/lib/jekyll/configuration.rb +410 -0
- data/lib/jekyll/converter.rb +54 -0
- data/lib/jekyll/converters/identity.rb +23 -0
- data/lib/jekyll/converters/markdown.rb +104 -0
- data/lib/jekyll/converters/markdown/kramdown_parser.rb +123 -0
- data/lib/jekyll/converters/markdown/rdiscount_parser.rb +35 -0
- data/lib/jekyll/converters/markdown/redcarpet_parser.rb +108 -0
- data/lib/jekyll/converters/smartypants.rb +36 -0
- data/lib/jekyll/convertible.rb +251 -0
- data/lib/jekyll/deprecator.rb +52 -0
- data/lib/jekyll/document.rb +507 -0
- data/lib/jekyll/drops/collection_drop.rb +22 -0
- data/lib/jekyll/drops/document_drop.rb +69 -0
- data/lib/jekyll/drops/drop.rb +214 -0
- data/lib/jekyll/drops/excerpt_drop.rb +15 -0
- data/lib/jekyll/drops/jekyll_drop.rb +33 -0
- data/lib/jekyll/drops/site_drop.rb +47 -0
- data/lib/jekyll/drops/static_file_drop.rb +13 -0
- data/lib/jekyll/drops/unified_payload_drop.rb +25 -0
- data/lib/jekyll/drops/url_drop.rb +88 -0
- data/lib/jekyll/entry_filter.rb +123 -0
- data/lib/jekyll/errors.rb +20 -0
- data/lib/jekyll/excerpt.rb +126 -0
- data/lib/jekyll/external.rb +74 -0
- data/lib/jekyll/filters.rb +430 -0
- data/lib/jekyll/filters/grouping_filters.rb +65 -0
- data/lib/jekyll/filters/url_filters.rb +60 -0
- data/lib/jekyll/frontmatter_defaults.rb +197 -0
- data/lib/jekyll/generator.rb +5 -0
- data/lib/jekyll/hooks.rb +104 -0
- data/lib/jekyll/layout.rb +62 -0
- data/lib/jekyll/liquid_extensions.rb +24 -0
- data/lib/jekyll/liquid_renderer.rb +49 -0
- data/lib/jekyll/liquid_renderer/file.rb +56 -0
- data/lib/jekyll/liquid_renderer/table.rb +96 -0
- data/lib/jekyll/log_adapter.rb +147 -0
- data/lib/jekyll/mime.types +825 -0
- data/lib/jekyll/page.rb +187 -0
- data/lib/jekyll/plugin.rb +98 -0
- data/lib/jekyll/plugin_manager.rb +113 -0
- data/lib/jekyll/publisher.rb +23 -0
- data/lib/jekyll/reader.rb +134 -0
- data/lib/jekyll/readers/collection_reader.rb +22 -0
- data/lib/jekyll/readers/data_reader.rb +77 -0
- data/lib/jekyll/readers/layout_reader.rb +71 -0
- data/lib/jekyll/readers/page_reader.rb +25 -0
- data/lib/jekyll/readers/post_reader.rb +72 -0
- data/lib/jekyll/readers/static_file_reader.rb +25 -0
- data/lib/jekyll/readers/theme_assets_reader.rb +49 -0
- data/lib/jekyll/regenerator.rb +201 -0
- data/lib/jekyll/related_posts.rb +52 -0
- data/lib/jekyll/renderer.rb +269 -0
- data/lib/jekyll/site.rb +472 -0
- data/lib/jekyll/static_file.rb +162 -0
- data/lib/jekyll/stevenson.rb +61 -0
- data/lib/jekyll/tags/highlight.rb +141 -0
- data/lib/jekyll/tags/include.rb +215 -0
- data/lib/jekyll/tags/link.rb +37 -0
- data/lib/jekyll/tags/post_url.rb +103 -0
- data/lib/jekyll/theme.rb +68 -0
- data/lib/jekyll/theme_builder.rb +119 -0
- data/lib/jekyll/url.rb +161 -0
- data/lib/jekyll/utils.rb +340 -0
- data/lib/jekyll/utils/ansi.rb +59 -0
- data/lib/jekyll/utils/exec.rb +27 -0
- data/lib/jekyll/utils/platforms.rb +82 -0
- data/lib/jekyll/utils/rouge.rb +21 -0
- data/lib/jekyll/utils/win_tz.rb +75 -0
- data/lib/jekyll/version.rb +5 -0
- data/lib/site_template/404.html +24 -0
- data/lib/site_template/_config.yml +43 -0
- data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +25 -0
- data/lib/site_template/about.md +18 -0
- data/lib/site_template/index.md +6 -0
- data/lib/theme_template/CODE_OF_CONDUCT.md.erb +74 -0
- data/lib/theme_template/Gemfile +4 -0
- data/lib/theme_template/LICENSE.txt.erb +21 -0
- data/lib/theme_template/README.md.erb +52 -0
- data/lib/theme_template/_layouts/default.html +1 -0
- data/lib/theme_template/_layouts/page.html +5 -0
- data/lib/theme_template/_layouts/post.html +5 -0
- data/lib/theme_template/example/_config.yml.erb +1 -0
- data/lib/theme_template/example/_post.md +12 -0
- data/lib/theme_template/example/index.html +14 -0
- data/lib/theme_template/example/style.scss +7 -0
- data/lib/theme_template/gitignore.erb +5 -0
- data/lib/theme_template/theme.gemspec.erb +19 -0
- metadata +103 -156
- data/lib/jekyll-docs.rb +0 -31
- data/site/404.html +0 -153
- data/site/CNAME +0 -1
- data/site/community/index.html +0 -299
- data/site/conduct/index.html +0 -10
- data/site/css/screen.css +0 -1
- data/site/docs/assets/index.html +0 -724
- data/site/docs/code_of_conduct/index.html +0 -730
- data/site/docs/collections/index.html +0 -1097
- data/site/docs/conduct/index.html +0 -744
- data/site/docs/configuration/index.html +0 -1403
- data/site/docs/continuous-integration/buddyworks/index.html +0 -726
- data/site/docs/continuous-integration/circleci/index.html +0 -757
- data/site/docs/continuous-integration/index.html +0 -681
- data/site/docs/continuous-integration/travis-ci/index.html +0 -891
- data/site/docs/contributing/index.html +0 -863
- data/site/docs/datafiles/index.html +0 -780
- data/site/docs/deployment-methods/index.html +0 -875
- data/site/docs/drafts/index.html +0 -636
- data/site/docs/extras/index.html +0 -689
- data/site/docs/frontmatter/index.html +0 -821
- data/site/docs/github-pages/index.html +0 -819
- data/site/docs/history/index.html +0 -3955
- data/site/docs/home/index.html +0 -644
- data/site/docs/includes/index.html +0 -800
- data/site/docs/index.html +0 -10
- data/site/docs/installation/index.html +0 -732
- data/site/docs/maintaining/affinity-team-captain/index.html +0 -706
- data/site/docs/maintaining/avoiding-burnout/index.html +0 -709
- data/site/docs/maintaining/becoming-a-maintainer/index.html +0 -717
- data/site/docs/maintaining/index.html +0 -713
- data/site/docs/maintaining/merging-a-pull-request/index.html +0 -747
- data/site/docs/maintaining/reviewing-a-pull-request/index.html +0 -725
- data/site/docs/maintaining/special-labels/index.html +0 -705
- data/site/docs/maintaining/triaging-an-issue/index.html +0 -735
- data/site/docs/migrations/index.html +0 -647
- data/site/docs/pages/index.html +0 -695
- data/site/docs/pagination/index.html +0 -870
- data/site/docs/permalinks/index.html +0 -1035
- data/site/docs/plugins/index.html +0 -1800
- data/site/docs/posts/index.html +0 -858
- data/site/docs/quickstart/index.html +0 -650
- data/site/docs/resources/index.html +0 -769
- data/site/docs/sites/index.html +0 -702
- data/site/docs/static-files/index.html +0 -720
- data/site/docs/structure/index.html +0 -822
- data/site/docs/templates/index.html +0 -1208
- data/site/docs/themes/index.html +0 -935
- data/site/docs/troubleshooting/index.html +0 -916
- data/site/docs/upgrading/0-to-2/index.html +0 -826
- data/site/docs/upgrading/2-to-3/index.html +0 -824
- data/site/docs/upgrading/index.html +0 -693
- data/site/docs/usage/index.html +0 -705
- data/site/docs/variables/index.html +0 -1048
- data/site/docs/windows/index.html +0 -799
- data/site/favicon.ico +0 -0
- data/site/feed.xml +0 -372
- data/site/fonts/FontAwesome.eot +0 -0
- data/site/fonts/FontAwesome.svg +0 -12
- data/site/fonts/FontAwesome.ttf +0 -0
- data/site/fonts/FontAwesome.woff +0 -0
- data/site/github.html +0 -10
- data/site/help/index.html +0 -244
- data/site/icomoon-selection.json +0 -96
- data/site/img/article-footer.png +0 -0
- data/site/img/footer-arrow.png +0 -0
- data/site/img/footer-logo.png +0 -0
- data/site/img/jekyll-sticker.jpg +0 -0
- data/site/img/jekylllayoutconcept.png +0 -0
- data/site/img/logo-2x.png +0 -0
- data/site/img/logo-rss.png +0 -0
- data/site/img/octojekyll.png +0 -0
- data/site/index.html +0 -267
- data/site/issues.html +0 -10
- data/site/js/html5shiv.min.js +0 -4
- data/site/js/respond.min.js +0 -5
- data/site/latest_version.txt +0 -1
- data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +0 -570
- data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +0 -570
- data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +0 -571
- data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +0 -568
- data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +0 -570
- data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +0 -569
- data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +0 -565
- data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +0 -565
- data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +0 -572
- data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +0 -566
- data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +0 -564
- data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +0 -599
- data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +0 -568
- data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +0 -583
- data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +0 -565
- data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +0 -564
- data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +0 -573
- data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +0 -564
- data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +0 -569
- data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +0 -585
- data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +0 -565
- data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +0 -567
- data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +0 -582
- data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +0 -579
- data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +0 -568
- data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +0 -588
- data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +0 -574
- data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +0 -597
- data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +0 -575
- data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +0 -565
- data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +0 -572
- data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +0 -567
- data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +0 -568
- data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +0 -588
- data/site/news/2015/02/26/introducing-jekyll-talk/index.html +0 -563
- data/site/news/2015/10/26/jekyll-3-0-released/index.html +0 -592
- data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +0 -576
- data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +0 -566
- data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +0 -599
- data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +0 -583
- data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +0 -578
- data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +0 -569
- data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +0 -565
- data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +0 -571
- data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +0 -566
- data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +0 -572
- data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +0 -576
- data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +0 -564
- data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +0 -566
- data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +0 -567
- data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +0 -676
- data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +0 -571
- data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +0 -566
- data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +0 -645
- data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +0 -569
- data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +0 -592
- data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +0 -649
- data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +0 -598
- data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +0 -594
- data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +0 -589
- data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +0 -569
- data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +0 -573
- data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +0 -565
- data/site/news/index.html +0 -3609
- data/site/news/releases/index.html +0 -3344
- data/site/philosophy.html +0 -46
- data/site/readme.md +0 -23
- data/site/robots.txt +0 -1
- data/site/sitemap.xml +0 -485
- data/site/tutorials/convert-site-to-jekyll/index.html +0 -793
- data/site/tutorials/custom-404-page/index.html +0 -358
- data/site/tutorials/home/index.html +0 -323
- data/site/tutorials/index.html +0 -10
- data/site/tutorials/navigation/index.html +0 -872
- data/site/tutorials/orderofinterpretation/index.html +0 -441
data/site/docs/usage/index.html
DELETED
@@ -1,705 +0,0 @@
|
|
1
|
-
<!DOCTYPE HTML>
|
2
|
-
<html lang="en-US">
|
3
|
-
<head>
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
5
|
-
<meta charset="UTF-8">
|
6
|
-
<meta name="viewport" content="width=device-width,initial-scale=1">
|
7
|
-
<meta name="generator" content="Jekyll v3.6.1">
|
8
|
-
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
9
|
-
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
10
|
-
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
11
|
-
<link rel="stylesheet" href="/css/screen.css">
|
12
|
-
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
13
|
-
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
14
|
-
<title>Basic Usage | Jekyll • Simple, blog-aware, static sites</title>
|
15
|
-
<meta property="og:title" content="Basic Usage">
|
16
|
-
<meta property="og:locale" content="en_US">
|
17
|
-
<meta name="description" content="The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:">
|
18
|
-
<meta property="og:description" content="The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:">
|
19
|
-
<link rel="canonical" href="https://jekyllrb.com/docs/usage/">
|
20
|
-
<meta property="og:url" content="https://jekyllrb.com/docs/usage/">
|
21
|
-
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites">
|
22
|
-
<meta property="og:type" content="article">
|
23
|
-
<meta property="article:published_time" content="2017-10-24T09:09:24-07:00">
|
24
|
-
<meta name="twitter:card" content="summary">
|
25
|
-
<meta name="twitter:site" content="@jekyllrb">
|
26
|
-
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY">
|
27
|
-
<script type="application/ld+json">
|
28
|
-
{"name":null,"description":"The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:","url":"https://jekyllrb.com/docs/usage/","headline":"Basic Usage","dateModified":"2017-10-24T09:09:24-07:00","datePublished":"2017-10-24T09:09:24-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/usage/"},"@context":"http://schema.org"}</script>
|
29
|
-
<!-- End Jekyll SEO tag -->
|
30
|
-
|
31
|
-
<!--[if lt IE 9]>
|
32
|
-
<script src="/js/html5shiv.min.js"></script>
|
33
|
-
<script src="/js/respond.min.js"></script>
|
34
|
-
<![endif]-->
|
35
|
-
</head>
|
36
|
-
|
37
|
-
|
38
|
-
<body class="wrap">
|
39
|
-
<header>
|
40
|
-
<nav class="mobile-nav show-on-mobiles">
|
41
|
-
<ul>
|
42
|
-
<li class="">
|
43
|
-
<a href="/">Home</a>
|
44
|
-
</li>
|
45
|
-
<li class="current">
|
46
|
-
<a href="/docs/home/">Docs</a>
|
47
|
-
</li>
|
48
|
-
<li class="">
|
49
|
-
<a href="/news/">News</a>
|
50
|
-
</li>
|
51
|
-
<li class="">
|
52
|
-
<a href="/community/">Community</a>
|
53
|
-
</li>
|
54
|
-
<li class="">
|
55
|
-
<a href="/help/">Help</a>
|
56
|
-
</li>
|
57
|
-
<li>
|
58
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
59
|
-
</li>
|
60
|
-
</ul>
|
61
|
-
|
62
|
-
</nav>
|
63
|
-
<div class="grid">
|
64
|
-
<div class="unit one-third center-on-mobiles">
|
65
|
-
<h1>
|
66
|
-
<a href="/">
|
67
|
-
<span class="sr-only">Jekyll</span>
|
68
|
-
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
69
|
-
</a>
|
70
|
-
</h1>
|
71
|
-
</div>
|
72
|
-
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
73
|
-
<ul>
|
74
|
-
<li class="">
|
75
|
-
<a href="/">Home</a>
|
76
|
-
</li>
|
77
|
-
<li class="current">
|
78
|
-
<a href="/docs/home/">Docs</a>
|
79
|
-
</li>
|
80
|
-
<li class="">
|
81
|
-
<a href="/news/">News</a>
|
82
|
-
</li>
|
83
|
-
<li class="">
|
84
|
-
<a href="/community/">Community</a>
|
85
|
-
</li>
|
86
|
-
<li class="">
|
87
|
-
<a href="/help/">Help</a>
|
88
|
-
</li>
|
89
|
-
<li>
|
90
|
-
<a href="https://github.com/jekyll/jekyll">GitHub</a>
|
91
|
-
</li>
|
92
|
-
</ul>
|
93
|
-
|
94
|
-
</nav>
|
95
|
-
</div>
|
96
|
-
</header>
|
97
|
-
|
98
|
-
|
99
|
-
<section class="docs">
|
100
|
-
<div class="grid">
|
101
|
-
|
102
|
-
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
103
|
-
<select onchange="if (this.value) window.location.href=this.value">
|
104
|
-
<option value="">Navigate the docs…</option>
|
105
|
-
|
106
|
-
<optgroup label="Getting Started">
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
<option value="/docs/home/">Welcome</option>
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
<option value="/docs/quickstart/">Quick-start guide</option>
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
<option value="/docs/installation/">Installation</option>
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
<option value="/docs/windows/">Jekyll on Windows</option>
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
<option value="/docs/usage/">Basic Usage</option>
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
<option value="/docs/structure/">Directory structure</option>
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
<option value="/docs/configuration/">Configuration</option>
|
135
|
-
|
136
|
-
|
137
|
-
</optgroup>
|
138
|
-
|
139
|
-
<optgroup label="Your Content">
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
<option value="/docs/frontmatter/">Front Matter</option>
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
<option value="/docs/posts/">Writing posts</option>
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
<option value="/docs/drafts/">Working with drafts</option>
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
<option value="/docs/pages/">Creating pages</option>
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
<option value="/docs/static-files/">Static Files</option>
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
<option value="/docs/variables/">Variables</option>
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
<option value="/docs/collections/">Collections</option>
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
<option value="/docs/datafiles/">Data Files</option>
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
<option value="/docs/assets/">Assets</option>
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
<option value="/docs/migrations/">Blog migrations</option>
|
180
|
-
|
181
|
-
|
182
|
-
</optgroup>
|
183
|
-
|
184
|
-
<optgroup label="Customization">
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
<option value="/docs/templates/">Templates</option>
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
<option value="/docs/includes/">Includes</option>
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
<option value="/docs/permalinks/">Permalinks</option>
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
<option value="/docs/pagination/">Pagination</option>
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
<option value="/docs/plugins/">Plugins</option>
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
<option value="/docs/themes/">Themes</option>
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
<option value="/docs/extras/">Extras</option>
|
213
|
-
|
214
|
-
|
215
|
-
</optgroup>
|
216
|
-
|
217
|
-
<optgroup label="Deployment">
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
<option value="/docs/github-pages/">GitHub Pages</option>
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
<option value="/docs/deployment-methods/">Deployment methods</option>
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
<option value="/docs/continuous-integration/">Continuous Integration</option>
|
230
|
-
|
231
|
-
|
232
|
-
</optgroup>
|
233
|
-
|
234
|
-
<optgroup label="Miscellaneous">
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
<option value="/docs/troubleshooting/">Troubleshooting</option>
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
<option value="/docs/sites/">Sites using Jekyll</option>
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
<option value="/docs/resources/">Resources</option>
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
<option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
<option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>
|
255
|
-
|
256
|
-
|
257
|
-
</optgroup>
|
258
|
-
|
259
|
-
<optgroup label="Meta">
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
<option value="/docs/contributing/">Contributing</option>
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
<option value="/docs/maintaining/">Maintaining Jekyll</option>
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
<option value="/docs/conduct/">Code of Conduct</option>
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
<option value="/docs/history/">History</option>
|
276
|
-
|
277
|
-
|
278
|
-
</optgroup>
|
279
|
-
|
280
|
-
</select>
|
281
|
-
</div>
|
282
|
-
|
283
|
-
|
284
|
-
<div class="unit four-fifths">
|
285
|
-
<article>
|
286
|
-
<div class="improve right hide-on-mobiles">
|
287
|
-
<a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/usage.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
288
|
-
</div>
|
289
|
-
<h1>Basic Usage</h1>
|
290
|
-
<p>The Jekyll gem makes a <code class="highlighter-rouge">jekyll</code> executable available to you in your Terminal
|
291
|
-
window. You can use this command in a number of ways:</p>
|
292
|
-
|
293
|
-
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll build
|
294
|
-
<span class="c"># => The current folder will be generated into ./_site</span>
|
295
|
-
|
296
|
-
<span class="nv">$ </span>jekyll build <span class="nt">--destination</span> <destination>
|
297
|
-
<span class="c"># => The current folder will be generated into <destination></span>
|
298
|
-
|
299
|
-
<span class="nv">$ </span>jekyll build <span class="nt">--source</span> <<span class="nb">source</span><span class="o">></span> <span class="nt">--destination</span> <destination>
|
300
|
-
<span class="c"># => The <source> folder will be generated into <destination></span>
|
301
|
-
|
302
|
-
<span class="nv">$ </span>jekyll build <span class="nt">--watch</span>
|
303
|
-
<span class="c"># => The current folder will be generated into ./_site,</span>
|
304
|
-
<span class="c"># watched for changes, and regenerated automatically.</span>
|
305
|
-
</code></pre></div></div>
|
306
|
-
|
307
|
-
<div class="note info">
|
308
|
-
<h5>Changes to _config.yml are not included during automatic regeneration.</h5>
|
309
|
-
<p>
|
310
|
-
The <code>_config.yml</code> master configuration file contains global configurations
|
311
|
-
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
|
312
|
-
during automatic regeneration are not loaded until the next execution.
|
313
|
-
</p>
|
314
|
-
<p>
|
315
|
-
Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
|
316
|
-
</p>
|
317
|
-
</div>
|
318
|
-
|
319
|
-
<div class="note warning">
|
320
|
-
<h5>Destination folders are cleaned on site builds</h5>
|
321
|
-
<p>
|
322
|
-
The contents of <code><destination></code> are automatically
|
323
|
-
cleaned, by default, when the site is built. Files or folders that are not
|
324
|
-
created by your site will be removed. Files and folders you wish to retain
|
325
|
-
in <code><destination></code> may be specified within the <code><keep_files></code>
|
326
|
-
configuration directive.
|
327
|
-
</p>
|
328
|
-
<p>
|
329
|
-
Do not use an important location for <code><destination></code>;
|
330
|
-
instead, use it as a staging area and copy files from there to your web server.
|
331
|
-
</p>
|
332
|
-
</div>
|
333
|
-
|
334
|
-
<p>Jekyll also comes with a built-in development server that will allow you to
|
335
|
-
preview what the generated site will look like in your browser locally.</p>
|
336
|
-
|
337
|
-
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll serve
|
338
|
-
<span class="c"># => A development server will run at http://localhost:4000/</span>
|
339
|
-
<span class="c"># Auto-regeneration: enabled. Use `--no-watch` to disable.</span>
|
340
|
-
|
341
|
-
<span class="nv">$ </span>jekyll serve <span class="nt">--detach</span>
|
342
|
-
<span class="c"># => Same as `jekyll serve` but will detach from the current terminal.</span>
|
343
|
-
<span class="c"># If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.</span>
|
344
|
-
<span class="c"># If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.</span>
|
345
|
-
</code></pre></div></div>
|
346
|
-
|
347
|
-
<div class="note info">
|
348
|
-
<h5>Be aware of default behavior</h5>
|
349
|
-
<p>
|
350
|
-
As of version 2.4, the <code>serve</code> command will watch for changes automatically. To disable this, you can use <code>jekyll serve --no-watch</code>, which preserves the old behavior.
|
351
|
-
</p>
|
352
|
-
</div>
|
353
|
-
|
354
|
-
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll serve <span class="nt">--no-watch</span>
|
355
|
-
<span class="c"># => Same as `jekyll serve` but will not watch for changes.</span>
|
356
|
-
</code></pre></div></div>
|
357
|
-
|
358
|
-
<p>These are just a few of the available <a href="../configuration/">configuration options</a>.
|
359
|
-
Many configuration options can either be specified as flags on the command line,
|
360
|
-
or alternatively (and more commonly) they can be specified in a <code class="highlighter-rouge">_config.yml</code>
|
361
|
-
file at the root of the source directory. Jekyll will automatically use the
|
362
|
-
options from this file when run. For example, if you place the following lines
|
363
|
-
in your <code class="highlighter-rouge">_config.yml</code> file:</p>
|
364
|
-
|
365
|
-
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">source</span><span class="pi">:</span> <span class="s">_source</span>
|
366
|
-
<span class="na">destination</span><span class="pi">:</span> <span class="s">_deploy</span>
|
367
|
-
</code></pre></div></div>
|
368
|
-
|
369
|
-
<p>Then the following two commands will be equivalent:</p>
|
370
|
-
|
371
|
-
<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll build
|
372
|
-
<span class="nv">$ </span>jekyll build <span class="nt">--source</span> _source <span class="nt">--destination</span> _deploy
|
373
|
-
</code></pre></div></div>
|
374
|
-
|
375
|
-
<p>For more about the possible configuration options, see the
|
376
|
-
<a href="../configuration/">configuration</a> page.</p>
|
377
|
-
|
378
|
-
<div class="note info">
|
379
|
-
<h5>Call for help</h5>
|
380
|
-
<p>
|
381
|
-
The <code>help</code> command is always here to remind you of all available options and usage, and also works with the <code>build</code>, <code>serve</code> and <code>new</code> subcommands, e.g <code>jekyll help new</code> or <code>jekyll help build</code>.
|
382
|
-
</p>
|
383
|
-
</div>
|
384
|
-
|
385
|
-
<p>If you’re interested in browsing these docs on-the-go, install the
|
386
|
-
<code class="highlighter-rouge">jekyll-docs</code> gem and run <code class="highlighter-rouge">jekyll docs</code> in your terminal.</p>
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
<div class="section-nav">
|
409
|
-
<div class="left align-right">
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
<a href="/docs/windows/" class="prev">Back</a>
|
414
|
-
|
415
|
-
</div>
|
416
|
-
<div class="right align-left">
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
<a href="/docs/structure/" class="next">Next</a>
|
421
|
-
|
422
|
-
</div>
|
423
|
-
</div>
|
424
|
-
<div class="clear"></div>
|
425
|
-
|
426
|
-
</article>
|
427
|
-
</div>
|
428
|
-
|
429
|
-
<div class="unit one-fifth hide-on-mobiles">
|
430
|
-
<aside>
|
431
|
-
|
432
|
-
<h4>Getting Started</h4>
|
433
|
-
<ul>
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
<li class=""><a href="/docs/home/">Welcome</a></li>
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
<li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
<li class=""><a href="/docs/installation/">Installation</a></li>
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
<li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
<li class="current"><a href="/docs/usage/">Basic Usage</a></li>
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
<li class=""><a href="/docs/structure/">Directory structure</a></li>
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
<li class=""><a href="/docs/configuration/">Configuration</a></li>
|
462
|
-
|
463
|
-
</ul>
|
464
|
-
|
465
|
-
|
466
|
-
<h4>Your Content</h4>
|
467
|
-
<ul>
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
<li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
<li class=""><a href="/docs/posts/">Writing posts</a></li>
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
<li class=""><a href="/docs/drafts/">Working with drafts</a></li>
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
<li class=""><a href="/docs/pages/">Creating pages</a></li>
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
<li class=""><a href="/docs/static-files/">Static Files</a></li>
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
<li class=""><a href="/docs/variables/">Variables</a></li>
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
<li class=""><a href="/docs/collections/">Collections</a></li>
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
<li class=""><a href="/docs/datafiles/">Data Files</a></li>
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
<li class=""><a href="/docs/assets/">Assets</a></li>
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
<li class=""><a href="/docs/migrations/">Blog migrations</a></li>
|
508
|
-
|
509
|
-
</ul>
|
510
|
-
|
511
|
-
|
512
|
-
<h4>Customization</h4>
|
513
|
-
<ul>
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
<li class=""><a href="/docs/templates/">Templates</a></li>
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
<li class=""><a href="/docs/includes/">Includes</a></li>
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
<li class=""><a href="/docs/pagination/">Pagination</a></li>
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
<li class=""><a href="/docs/plugins/">Plugins</a></li>
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
<li class=""><a href="/docs/themes/">Themes</a></li>
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
<li class=""><a href="/docs/extras/">Extras</a></li>
|
542
|
-
|
543
|
-
</ul>
|
544
|
-
|
545
|
-
|
546
|
-
<h4>Deployment</h4>
|
547
|
-
<ul>
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
<li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
<li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
<li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
|
560
|
-
|
561
|
-
</ul>
|
562
|
-
|
563
|
-
|
564
|
-
<h4>Miscellaneous</h4>
|
565
|
-
<ul>
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
<li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
<li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
<li class=""><a href="/docs/resources/">Resources</a></li>
|
578
|
-
|
579
|
-
|
580
|
-
|
581
|
-
<li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
<li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
|
586
|
-
|
587
|
-
</ul>
|
588
|
-
|
589
|
-
|
590
|
-
<h4>Meta</h4>
|
591
|
-
<ul>
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
<li class=""><a href="/docs/contributing/">Contributing</a></li>
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
<li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
<li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
<li class=""><a href="/docs/history/">History</a></li>
|
608
|
-
|
609
|
-
</ul>
|
610
|
-
|
611
|
-
|
612
|
-
</aside>
|
613
|
-
</div>
|
614
|
-
|
615
|
-
|
616
|
-
<div class="clear"></div>
|
617
|
-
|
618
|
-
</div>
|
619
|
-
</section>
|
620
|
-
|
621
|
-
|
622
|
-
<footer>
|
623
|
-
<div class="grid">
|
624
|
-
<div class="unit one-third center-on-mobiles">
|
625
|
-
<p>The contents of this website are <br>© 2017 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT License</a>.</p>
|
626
|
-
</div>
|
627
|
-
<div class="unit two-thirds align-right center-on-mobiles">
|
628
|
-
<p>
|
629
|
-
Proudly hosted by
|
630
|
-
<a href="https://github.com">
|
631
|
-
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
632
|
-
</a>
|
633
|
-
</p>
|
634
|
-
</div>
|
635
|
-
</div>
|
636
|
-
</footer>
|
637
|
-
|
638
|
-
<script>
|
639
|
-
var anchorForId = function (id) {
|
640
|
-
var anchor = document.createElement("a");
|
641
|
-
anchor.className = "header-link";
|
642
|
-
anchor.href = "#" + id;
|
643
|
-
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
644
|
-
anchor.title = "Permalink";
|
645
|
-
return anchor;
|
646
|
-
};
|
647
|
-
|
648
|
-
var linkifyAnchors = function (level, containingElement) {
|
649
|
-
var headers = containingElement.getElementsByTagName("h" + level);
|
650
|
-
for (var h = 0; h < headers.length; h++) {
|
651
|
-
var header = headers[h];
|
652
|
-
|
653
|
-
if (typeof header.id !== "undefined" && header.id !== "") {
|
654
|
-
header.appendChild(anchorForId(header.id));
|
655
|
-
}
|
656
|
-
}
|
657
|
-
};
|
658
|
-
|
659
|
-
document.onreadystatechange = function () {
|
660
|
-
if (this.readyState === "complete") {
|
661
|
-
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
662
|
-
if (!contentBlock) {
|
663
|
-
return;
|
664
|
-
}
|
665
|
-
for (var level = 1; level <= 6; level++) {
|
666
|
-
linkifyAnchors(level, contentBlock);
|
667
|
-
}
|
668
|
-
}
|
669
|
-
};
|
670
|
-
</script>
|
671
|
-
|
672
|
-
|
673
|
-
<!-- Gauges (http://get.gaug.es/) -->
|
674
|
-
<script>
|
675
|
-
var _gauges = _gauges || [];
|
676
|
-
(function() {
|
677
|
-
var t = document.createElement('script');
|
678
|
-
t.type = 'text/javascript';
|
679
|
-
t.async = true;
|
680
|
-
t.id = 'gauges-tracker';
|
681
|
-
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
682
|
-
t.src = '//secure.gaug.es/track.js';
|
683
|
-
var s = document.getElementsByTagName('script')[0];
|
684
|
-
s.parentNode.insertBefore(t, s);
|
685
|
-
})();
|
686
|
-
</script>
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
<!-- Google Analytics (https://www.google.com/analytics) -->
|
691
|
-
<script>
|
692
|
-
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
693
|
-
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
694
|
-
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
695
|
-
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
696
|
-
|
697
|
-
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
698
|
-
ga('send', 'pageview');
|
699
|
-
|
700
|
-
</script>
|
701
|
-
|
702
|
-
|
703
|
-
|
704
|
-
</body>
|
705
|
-
</html>
|