jekyll 2.2.0 → 2.3.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of jekyll might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/README.markdown +1 -1
- data/lib/jekyll.rb +0 -1
- data/lib/jekyll/collection.rb +18 -3
- data/lib/jekyll/command.rb +0 -25
- data/lib/jekyll/commands/build.rb +7 -2
- data/lib/jekyll/commands/help.rb +33 -0
- data/lib/jekyll/configuration.rb +36 -28
- data/lib/jekyll/converters/markdown/kramdown_parser.rb +1 -1
- data/lib/jekyll/convertible.rb +43 -20
- data/lib/jekyll/deprecator.rb +15 -8
- data/lib/jekyll/document.rb +21 -4
- data/lib/jekyll/filters.rb +27 -1
- data/lib/jekyll/frontmatter_defaults.rb +46 -12
- data/lib/jekyll/plugin.rb +10 -1
- data/lib/jekyll/post.rb +6 -13
- data/lib/jekyll/related_posts.rb +2 -2
- data/lib/jekyll/renderer.rb +7 -2
- data/lib/jekyll/site.rb +5 -7
- data/lib/jekyll/static_file.rb +24 -4
- data/lib/jekyll/tags/include.rb +3 -1
- data/lib/jekyll/tags/post_url.rb +2 -2
- data/lib/jekyll/utils.rb +88 -69
- data/lib/jekyll/version.rb +1 -1
- data/lib/site_template/_config.yml +6 -4
- data/lib/site_template/_includes/footer.html +43 -49
- data/lib/site_template/_includes/head.html +3 -4
- data/lib/site_template/_includes/header.html +9 -10
- data/lib/site_template/_layouts/default.html +6 -5
- data/lib/site_template/_layouts/page.html +3 -3
- data/lib/site_template/_layouts/post.html +4 -4
- data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +6 -5
- data/lib/site_template/_sass/_base.scss +203 -0
- data/lib/site_template/_sass/_layout.scss +236 -0
- data/lib/site_template/_sass/_syntax-highlighting.scss +67 -0
- data/lib/site_template/css/main.scss +49 -0
- data/lib/site_template/feed.xml +1 -1
- data/lib/site_template/index.html +7 -4
- metadata +24 -431
- data/.gitignore +0 -15
- data/.travis.yml +0 -27
- data/CONTRIBUTING.markdown +0 -91
- data/Gemfile +0 -2
- data/History.markdown +0 -1310
- data/Rakefile +0 -268
- data/cucumber.yml +0 -3
- data/docs/jp/CONTRIBUTING.jp.markdown +0 -93
- data/docs/jp/README.jp.markdown +0 -68
- data/features/collections.feature +0 -145
- data/features/create_sites.feature +0 -158
- data/features/data.feature +0 -105
- data/features/drafts.feature +0 -46
- data/features/embed_filters.feature +0 -107
- data/features/frontmatter_defaults.feature +0 -136
- data/features/include_tag.feature +0 -68
- data/features/markdown.feature +0 -67
- data/features/pagination.feature +0 -82
- data/features/permalinks.feature +0 -85
- data/features/post_data.feature +0 -261
- data/features/post_excerpts.feature +0 -50
- data/features/rendering.feature +0 -34
- data/features/site_configuration.feature +0 -283
- data/features/site_data.feature +0 -107
- data/features/step_definitions/jekyll_steps.rb +0 -201
- data/features/support/env.rb +0 -65
- data/jekyll.gemspec +0 -66
- data/lib/site_template/css/main.css +0 -410
- data/script/bootstrap +0 -4
- data/script/branding +0 -11
- data/script/cibuild +0 -7
- data/script/console +0 -38
- data/script/proof +0 -22
- data/script/rebund +0 -140
- data/script/test +0 -17
- data/site/.gitignore +0 -4
- data/site/CNAME +0 -1
- data/site/README +0 -1
- data/site/_config.yml +0 -9
- data/site/_data/docs.yml +0 -46
- data/site/_includes/analytics.html +0 -30
- data/site/_includes/anchor_links.html +0 -32
- data/site/_includes/css/font-awesome.css +0 -44
- data/site/_includes/css/gridism.css +0 -110
- data/site/_includes/css/normalize.css +0 -1
- data/site/_includes/css/pygments.css +0 -72
- data/site/_includes/css/style.css +0 -1045
- data/site/_includes/docs_contents.html +0 -8
- data/site/_includes/docs_contents_mobile.html +0 -10
- data/site/_includes/docs_option.html +0 -11
- data/site/_includes/docs_ul.html +0 -20
- data/site/_includes/footer.html +0 -15
- data/site/_includes/header.html +0 -18
- data/site/_includes/news_contents.html +0 -33
- data/site/_includes/news_contents_mobile.html +0 -11
- data/site/_includes/news_item.html +0 -24
- data/site/_includes/primary-nav-items.html +0 -17
- data/site/_includes/section_nav.html +0 -22
- data/site/_includes/top.html +0 -17
- data/site/_layouts/default.html +0 -13
- data/site/_layouts/docs.html +0 -23
- data/site/_layouts/news.html +0 -19
- data/site/_layouts/news_item.html +0 -27
- data/site/_posts/2013-05-06-jekyll-1-0-0-released.markdown +0 -23
- data/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown +0 -27
- data/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown +0 -28
- data/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown +0 -25
- data/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown +0 -27
- data/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown +0 -31
- data/site/_posts/2013-07-25-jekyll-1-0-4-released.markdown +0 -20
- data/site/_posts/2013-07-25-jekyll-1-1-2-released.markdown +0 -20
- data/site/_posts/2013-09-06-jekyll-1-2-0-released.markdown +0 -23
- data/site/_posts/2013-09-14-jekyll-1-2-1-released.markdown +0 -19
- data/site/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown +0 -19
- data/site/_posts/2013-11-04-jekyll-1-3-0-released.markdown +0 -43
- data/site/_posts/2013-11-26-jekyll-1-3-1-released.markdown +0 -21
- data/site/_posts/2013-12-07-jekyll-1-4-0-released.markdown +0 -30
- data/site/_posts/2013-12-09-jekyll-1-4-1-released.markdown +0 -20
- data/site/_posts/2013-12-16-jekyll-1-4-2-released.markdown +0 -18
- data/site/_posts/2014-01-13-jekyll-1-4-3-released.markdown +0 -26
- data/site/_posts/2014-03-24-jekyll-1-5-0-released.markdown +0 -19
- data/site/_posts/2014-03-27-jekyll-1-5-1-released.markdown +0 -26
- data/site/_posts/2014-05-06-jekyll-turns-2-0-0.markdown +0 -31
- data/site/_posts/2014-05-08-jekyll-2-0-3-released.markdown +0 -18
- data/site/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown +0 -19
- data/site/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown +0 -31
- data/site/_posts/2014-07-01-jekyll-2-1-1-released.markdown +0 -30
- data/site/_posts/2014-07-29-jekyll-2-2-0-released.markdown +0 -19
- data/site/css/screen.css +0 -31
- data/site/docs/assets.md +0 -66
- data/site/docs/collections.md +0 -259
- data/site/docs/configuration.md +0 -536
- data/site/docs/continuous-integration.md +0 -177
- data/site/docs/contributing.md +0 -133
- data/site/docs/datafiles.md +0 -108
- data/site/docs/deployment-methods.md +0 -127
- data/site/docs/drafts.md +0 -21
- data/site/docs/extras.md +0 -18
- data/site/docs/frontmatter.md +0 -191
- data/site/docs/github-pages.md +0 -91
- data/site/docs/history.md +0 -1514
- data/site/docs/index.md +0 -58
- data/site/docs/installation.md +0 -106
- data/site/docs/migrations.md +0 -11
- data/site/docs/pages.md +0 -86
- data/site/docs/pagination.md +0 -212
- data/site/docs/permalinks.md +0 -188
- data/site/docs/plugins.md +0 -561
- data/site/docs/posts.md +0 -211
- data/site/docs/quickstart.md +0 -26
- data/site/docs/resources.md +0 -43
- data/site/docs/sites.md +0 -29
- data/site/docs/structure.md +0 -190
- data/site/docs/templates.md +0 -376
- data/site/docs/troubleshooting.md +0 -147
- data/site/docs/upgrading.md +0 -146
- data/site/docs/usage.md +0 -74
- data/site/docs/variables.md +0 -382
- data/site/docs/windows.md +0 -44
- data/site/favicon.ico +0 -0
- data/site/feed.xml +0 -48
- data/site/fonts/FontAwesome.otf +0 -0
- data/site/fonts/fontawesome-webfont.eot +0 -0
- data/site/fonts/fontawesome-webfont.svg +0 -504
- data/site/fonts/fontawesome-webfont.ttf +0 -0
- data/site/fonts/fontawesome-webfont.woff +0 -0
- data/site/freenode.txt +0 -1
- 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/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 -90
- data/site/js/html5shiv.min.js +0 -4
- data/site/js/respond.min.js +0 -5
- data/site/news/index.html +0 -10
- data/site/news/releases/index.html +0 -10
- data/test/fixtures/broken_front_matter1.erb +0 -5
- data/test/fixtures/broken_front_matter2.erb +0 -4
- data/test/fixtures/broken_front_matter3.erb +0 -7
- data/test/fixtures/exploit_front_matter.erb +0 -4
- data/test/fixtures/front_matter.erb +0 -4
- data/test/helper.rb +0 -80
- data/test/source/+/%# +.md +0 -6
- data/test/source/+/foo.md +0 -7
- data/test/source/.htaccess +0 -8
- data/test/source/_config.dev.toml +0 -2
- data/test/source/_data/categories/dairy.yaml +0 -6
- data/test/source/_data/languages.yml +0 -2
- data/test/source/_data/members.json +0 -12
- data/test/source/_data/members.yaml +0 -7
- data/test/source/_data/products.yml +0 -4
- data/test/source/_drafts/draft-properties.text +0 -11
- data/test/source/_includes/include.html +0 -1
- data/test/source/_includes/params.html +0 -7
- data/test/source/_includes/sig.markdown +0 -3
- data/test/source/_layouts/default.html +0 -27
- data/test/source/_layouts/post/simple.html +0 -1
- data/test/source/_layouts/simple.html +0 -1
- data/test/source/_methods/_do_not_read_me.md +0 -5
- data/test/source/_methods/configuration.md +0 -8
- data/test/source/_methods/sanitized_path.md +0 -5
- data/test/source/_methods/site/_dont_include_me_either.md +0 -5
- data/test/source/_methods/site/generate.md +0 -6
- data/test/source/_methods/site/initialize.md +0 -4
- data/test/source/_methods/um_hi.md +0 -6
- data/test/source/_plugins/dummy.rb +0 -8
- data/test/source/_posts/2008-02-02-not-published.textile +0 -8
- data/test/source/_posts/2008-02-02-published.textile +0 -8
- data/test/source/_posts/2008-10-18-foo-bar.textile +0 -8
- data/test/source/_posts/2008-11-21-complex.textile +0 -8
- data/test/source/_posts/2008-12-03-permalinked-post.textile +0 -9
- data/test/source/_posts/2008-12-13-include.markdown +0 -8
- data/test/source/_posts/2009-01-27-array-categories.textile +0 -10
- data/test/source/_posts/2009-01-27-categories.textile +0 -7
- data/test/source/_posts/2009-01-27-category.textile +0 -7
- data/test/source/_posts/2009-01-27-empty-categories.textile +0 -7
- data/test/source/_posts/2009-01-27-empty-category.textile +0 -7
- data/test/source/_posts/2009-01-27-no-category.textile +0 -6
- data/test/source/_posts/2009-03-12-hash-#1.markdown +0 -6
- data/test/source/_posts/2009-05-18-empty-tag.textile +0 -6
- data/test/source/_posts/2009-05-18-empty-tags.textile +0 -6
- data/test/source/_posts/2009-05-18-tag.textile +0 -6
- data/test/source/_posts/2009-05-18-tags.textile +0 -9
- data/test/source/_posts/2009-06-22-empty-yaml.textile +0 -3
- data/test/source/_posts/2009-06-22-no-yaml.textile +0 -1
- data/test/source/_posts/2010-01-08-triple-dash.markdown +0 -5
- data/test/source/_posts/2010-01-09-date-override.textile +0 -7
- data/test/source/_posts/2010-01-09-time-override.textile +0 -7
- data/test/source/_posts/2010-01-09-timezone-override.textile +0 -7
- data/test/source/_posts/2010-01-16-override-data.textile +0 -4
- data/test/source/_posts/2011-04-12-md-extension.md +0 -7
- data/test/source/_posts/2011-04-12-text-extension.text +0 -0
- data/test/source/_posts/2013-01-02-post-excerpt.markdown +0 -14
- data/test/source/_posts/2013-01-12-nil-layout.textile +0 -6
- data/test/source/_posts/2013-01-12-no-layout.textile +0 -5
- data/test/source/_posts/2013-03-19-not-a-post.markdown/.gitkeep +0 -0
- data/test/source/_posts/2013-04-11-custom-excerpt.markdown +0 -10
- data/test/source/_posts/2013-05-10-number-category.textile +0 -7
- data/test/source/_posts/2013-07-22-post-excerpt-with-layout.markdown +0 -23
- data/test/source/_posts/2013-08-01-mkdn-extension.mkdn +0 -0
- data/test/source/_posts/2013-12-17-include-variable-filters.markdown +0 -21
- data/test/source/_posts/2013-12-20-properties.text +0 -11
- data/test/source/_posts/2014-01-06-permalink-traversal.md +0 -5
- data/test/source/_posts/2014-03-03-yaml-with-dots.md +0 -5
- data/test/source/_posts/2014-03-22-escape-+ %20[].markdown +0 -6
- data/test/source/_posts/es/2008-11-21-nested.textile +0 -8
- data/test/source/_sass/_grid.scss +0 -1
- data/test/source/_slides/example-slide-1.html +0 -4
- data/test/source/_slides/example-slide-2.html +0 -7
- data/test/source/_slides/example-slide-3.html +0 -5
- data/test/source/_with.dots/all.dots/2.4.0.md +0 -5
- data/test/source/_with.dots/file.with.dots.md +0 -0
- data/test/source/about.html +0 -6
- data/test/source/category/_posts/2008-9-23-categories.textile +0 -6
- data/test/source/contacts.html +0 -5
- data/test/source/contacts/bar.html +0 -5
- data/test/source/contacts/index.html +0 -5
- data/test/source/css/main.scss +0 -4
- data/test/source/css/screen.css +0 -76
- data/test/source/deal.with.dots.html +0 -7
- data/test/source/environment.html +0 -5
- data/test/source/exploit.md +0 -5
- data/test/source/foo/_posts/bar/2008-12-12-topical-post.textile +0 -8
- data/test/source/index.html +0 -22
- data/test/source/js/coffeescript.coffee +0 -10
- data/test/source/pgp.key +0 -2
- data/test/source/products.yml +0 -4
- data/test/source/properties.html +0 -8
- data/test/source/sitemap.xml +0 -32
- data/test/source/static_files.html +0 -4
- data/test/source/symlink-test/symlinked-file +0 -22
- data/test/source/unpublished.html +0 -7
- data/test/source/win/_posts/2009-05-24-yaml-linebreak.markdown +0 -7
- data/test/source/z_category/_posts/2008-9-23-categories.textile +0 -6
- data/test/suite.rb +0 -11
- data/test/test_cleaner.rb +0 -77
- data/test/test_coffeescript.rb +0 -49
- data/test/test_collections.rb +0 -224
- data/test/test_command.rb +0 -53
- data/test/test_configuration.rb +0 -201
- data/test/test_convertible.rb +0 -49
- data/test/test_document.rb +0 -193
- data/test/test_draft.rb +0 -56
- data/test/test_entry_filter.rb +0 -124
- data/test/test_excerpt.rb +0 -131
- data/test/test_filters.rb +0 -207
- data/test/test_generated_site.rb +0 -97
- data/test/test_kramdown.rb +0 -62
- data/test/test_layout_reader.rb +0 -34
- data/test/test_liquid_extensions.rb +0 -31
- data/test/test_log_adapter.rb +0 -59
- data/test/test_new_command.rb +0 -104
- data/test/test_page.rb +0 -254
- data/test/test_path_sanitization.rb +0 -18
- data/test/test_post.rb +0 -741
- data/test/test_rdiscount.rb +0 -22
- data/test/test_redcarpet.rb +0 -77
- data/test/test_redcloth.rb +0 -86
- data/test/test_related_posts.rb +0 -47
- data/test/test_sass.rb +0 -26
- data/test/test_site.rb +0 -452
- data/test/test_tags.rb +0 -509
- data/test/test_url.rb +0 -28
- data/test/test_utils.rb +0 -67
data/site/docs/index.md
DELETED
@@ -1,58 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: docs
|
3
|
-
title: Welcome
|
4
|
-
next_section: quickstart
|
5
|
-
permalink: /docs/home/
|
6
|
-
---
|
7
|
-
|
8
|
-
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
9
|
-
as getting your site up and running, creating and managing your content,
|
10
|
-
customizing the way your site works and looks, deploying to various
|
11
|
-
environments, and give you some advice on participating in the future
|
12
|
-
development of Jekyll itself.
|
13
|
-
|
14
|
-
## So what is Jekyll, exactly?
|
15
|
-
|
16
|
-
Jekyll is a simple, blog-aware, static site generator. It takes a template
|
17
|
-
directory containing raw text files in various formats, runs it through
|
18
|
-
[Markdown](http://daringfireball.net/projects/markdown/) (or
|
19
|
-
[Textile](http://redcloth.org/textile)) and
|
20
|
-
[Liquid](http://wiki.shopify.com/Liquid)
|
21
|
-
converters, and spits out a complete, ready-to-publish static website suitable
|
22
|
-
for serving with your favorite web server. Jekyll also happens to be the engine
|
23
|
-
behind [GitHub Pages](http://pages.github.com), which means you can use Jekyll
|
24
|
-
to host your project’s page, blog, or website from GitHub’s servers **for
|
25
|
-
free**.
|
26
|
-
|
27
|
-
## Helpful Hints
|
28
|
-
|
29
|
-
Throughout this guide there are a number of small-but-handy pieces of
|
30
|
-
information that can make using Jekyll easier, more interesting, and less
|
31
|
-
hazardous. Here’s what to look out for.
|
32
|
-
|
33
|
-
<div class="note">
|
34
|
-
<h5>ProTips™ help you get more from Jekyll</h5>
|
35
|
-
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
|
36
|
-
</div>
|
37
|
-
|
38
|
-
<div class="note info">
|
39
|
-
<h5>Notes are handy pieces of information</h5>
|
40
|
-
<p>These are for the extra tidbits sometimes necessary to understand
|
41
|
-
Jekyll.</p>
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<div class="note warning">
|
45
|
-
<h5>Warnings help you not blow things up</h5>
|
46
|
-
<p>Be aware of these messages if you wish to avoid certain death.</p>
|
47
|
-
</div>
|
48
|
-
|
49
|
-
<div class="note unreleased">
|
50
|
-
<h5>You'll see this by a feature that hasn't been released</h5>
|
51
|
-
<p>Some pieces of this website are for future versions of Jekyll that
|
52
|
-
are not yet released.</p>
|
53
|
-
</div>
|
54
|
-
|
55
|
-
If you come across anything along the way that we haven’t covered, or if you
|
56
|
-
know of a tip you think others would find handy, please [file an
|
57
|
-
issue]({{ site.repository }}/issues/new) and we’ll see about
|
58
|
-
including it in this guide.
|
data/site/docs/installation.md
DELETED
@@ -1,106 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: docs
|
3
|
-
title: Installation
|
4
|
-
prev_section: quickstart
|
5
|
-
next_section: usage
|
6
|
-
permalink: /docs/installation/
|
7
|
-
---
|
8
|
-
|
9
|
-
Getting Jekyll installed and ready-to-go should only take a few minutes. If it
|
10
|
-
ever becomes a pain in the ass, please [file an
|
11
|
-
issue]({{ site.repository }}/issues/new) (or submit a pull request)
|
12
|
-
describing the issue you encountered and how we might make the process easier.
|
13
|
-
|
14
|
-
### Requirements
|
15
|
-
|
16
|
-
Installing Jekyll is easy and straight-forward, but there are a few requirements
|
17
|
-
you’ll need to make sure your system has before you start.
|
18
|
-
|
19
|
-
- [Ruby](http://www.ruby-lang.org/en/downloads/)
|
20
|
-
- [RubyGems](http://rubygems.org/pages/download)
|
21
|
-
- Linux, Unix, or Mac OS X
|
22
|
-
- [NodeJS](http://nodejs.org), or another JavaScript runtime (for
|
23
|
-
CoffeeScript support).
|
24
|
-
|
25
|
-
<div class="note info">
|
26
|
-
<h5>Running Jekyll on Windows</h5>
|
27
|
-
<p>
|
28
|
-
While Windows is not officially supported, it is possible to get it running
|
29
|
-
on Windows. Special instructions can be found on our
|
30
|
-
<a href="../windows/#installation">Windows-specific docs page</a>.
|
31
|
-
</p>
|
32
|
-
</div>
|
33
|
-
|
34
|
-
## Install with RubyGems
|
35
|
-
|
36
|
-
The best way to install Jekyll is via
|
37
|
-
[RubyGems](http://rubygems.org/pages/download). At the terminal prompt,
|
38
|
-
simply run the following command to install Jekyll:
|
39
|
-
|
40
|
-
{% highlight bash %}
|
41
|
-
$ gem install jekyll
|
42
|
-
{% endhighlight %}
|
43
|
-
|
44
|
-
All of Jekyll’s gem dependencies are automatically installed by the above
|
45
|
-
command, so you won’t have to worry about them at all. If you have problems
|
46
|
-
installing Jekyll, check out the [troubleshooting](../troubleshooting/) page or
|
47
|
-
[report an issue]({{ site.repository }}/issues/new) so the Jekyll
|
48
|
-
community can improve the experience for everyone.
|
49
|
-
|
50
|
-
<div class="note info">
|
51
|
-
<h5>Installing Xcode Command-Line Tools</h5>
|
52
|
-
<p>
|
53
|
-
If you run into issues installing Jekyll's dependencies which make use of
|
54
|
-
native extensions and are using Mac OS X, you will need to install Xcode
|
55
|
-
and the Command-Line Tools it ships with. Download in
|
56
|
-
<code>Preferences → Downloads → Components</code>.
|
57
|
-
</p>
|
58
|
-
</div>
|
59
|
-
|
60
|
-
## Pre-releases
|
61
|
-
|
62
|
-
In order to install a pre-release, make sure you have all the requirements
|
63
|
-
installed properly and run:
|
64
|
-
|
65
|
-
{% highlight bash %}
|
66
|
-
gem install jekyll --pre
|
67
|
-
{% endhighlight %}
|
68
|
-
|
69
|
-
This will install the latest pre-release. If you want a particular pre-release,
|
70
|
-
use the `-v` switch to indicate the version you'd like to install:
|
71
|
-
|
72
|
-
{% highlight bash %}
|
73
|
-
gem install jekyll -v '2.0.0.alpha.1'
|
74
|
-
{% endhighlight %}
|
75
|
-
|
76
|
-
If you'd like to install a development version of Jekyll, the process is a bit
|
77
|
-
more involved. This gives you the advantage of having the latest and greatest,
|
78
|
-
but may be unstable.
|
79
|
-
|
80
|
-
{% highlight bash %}
|
81
|
-
$ git clone git://github.com/jekyll/jekyll.git
|
82
|
-
$ cd jekyll
|
83
|
-
$ script/bootstrap
|
84
|
-
$ bundle exec rake build
|
85
|
-
$ ls pkg/*.gem | head -n 1 | xargs gem install -l
|
86
|
-
{% endhighlight %}
|
87
|
-
|
88
|
-
## Optional Extras
|
89
|
-
|
90
|
-
There are a number of (optional) extra features that Jekyll supports that you
|
91
|
-
may want to install, depending on how you plan to use Jekyll. These extras
|
92
|
-
include LaTeX support, and the use of alternative content rendering engines.
|
93
|
-
Check out [the extras page](../extras/) for more information.
|
94
|
-
|
95
|
-
<div class="note">
|
96
|
-
<h5>ProTip™: Enable Syntax Highlighting</h5>
|
97
|
-
<p>
|
98
|
-
If you’re the kind of person who is using Jekyll, then chances are you’ll
|
99
|
-
want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
|
100
|
-
or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
|
101
|
-
<a href="../templates/#code-snippet-highlighting">check out how to
|
102
|
-
do that</a> before you go any farther.
|
103
|
-
</p>
|
104
|
-
</div>
|
105
|
-
|
106
|
-
Now that you’ve got everything installed, let’s get to work!
|
data/site/docs/migrations.md
DELETED
@@ -1,11 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: docs
|
3
|
-
title: Blog migrations
|
4
|
-
prev_section: assets
|
5
|
-
next_section: templates
|
6
|
-
permalink: /docs/migrations/
|
7
|
-
---
|
8
|
-
|
9
|
-
If you’re switching to Jekyll from another blogging system, Jekyll’s importers
|
10
|
-
can help you with the move. To learn more about importing your site to Jekyll,
|
11
|
-
visit our [`jekyll-import` docs site](http://import.jekyllrb.com/docs/home/).
|
data/site/docs/pages.md
DELETED
@@ -1,86 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: docs
|
3
|
-
title: Creating pages
|
4
|
-
prev_section: drafts
|
5
|
-
next_section: variables
|
6
|
-
permalink: /docs/pages/
|
7
|
-
---
|
8
|
-
|
9
|
-
In addition to [writing posts](../posts/), another thing you may want to do with
|
10
|
-
your Jekyll site is create static pages. By taking advantage of the way Jekyll
|
11
|
-
copies files and directories, this is easy to do.
|
12
|
-
|
13
|
-
## Homepage
|
14
|
-
|
15
|
-
Just about every web server configuration you come across will look for an HTML
|
16
|
-
file called `index.html` (by convention) in the site's root folder and display
|
17
|
-
that as the homepage. Unless the web server you’re using is configured to look
|
18
|
-
for some different filename as the default, this file will turn into the
|
19
|
-
homepage of your Jekyll-generated site.
|
20
|
-
|
21
|
-
<div class="note">
|
22
|
-
<h5>ProTip™: Use layouts on your homepage</h5>
|
23
|
-
<p>
|
24
|
-
Any HTML file on your site can use layouts and/or includes, even the
|
25
|
-
homepage. Common content, like headers and footers, make excellent
|
26
|
-
candidates for extraction into a layout.
|
27
|
-
</p>
|
28
|
-
</div>
|
29
|
-
|
30
|
-
## Where additional pages live
|
31
|
-
|
32
|
-
Where you put HTML files for pages depends on how you want the pages to work.
|
33
|
-
There are two main ways of creating pages:
|
34
|
-
|
35
|
-
- Place named HTML files for each page in your site's root folder.
|
36
|
-
- Create a folder in the site's root for each page, and place an index.html file
|
37
|
-
in each page folder.
|
38
|
-
|
39
|
-
Both methods work fine (and can be used in conjunction with each other),
|
40
|
-
with the only real difference being the resulting URLs.
|
41
|
-
|
42
|
-
### Named HTML files
|
43
|
-
|
44
|
-
The simplest way of adding a page is just to add an HTML file in the root
|
45
|
-
directory with a suitable name for the page you want to create. For a site with
|
46
|
-
a homepage, an about page, and a contact page, here’s what the root directory
|
47
|
-
and associated URLs might look like:
|
48
|
-
|
49
|
-
{% highlight bash %}
|
50
|
-
.
|
51
|
-
|-- _config.yml
|
52
|
-
|-- _includes/
|
53
|
-
|-- _layouts/
|
54
|
-
|-- _posts/
|
55
|
-
|-- _site/
|
56
|
-
|-- about.html # => http://example.com/about.html
|
57
|
-
|-- index.html # => http://example.com/
|
58
|
-
└── contact.html # => http://example.com/contact.html
|
59
|
-
{% endhighlight %}
|
60
|
-
|
61
|
-
### Named folders containing index HTML files
|
62
|
-
|
63
|
-
There is nothing wrong with the above method, however some people like to keep
|
64
|
-
their URLs free from things like filename extensions. To achieve clean URLs for
|
65
|
-
pages using Jekyll, you simply need to create a folder for each top-level page
|
66
|
-
you want, and then place an `index.html` file in each page’s folder. This way
|
67
|
-
the page URL ends up being the folder name, and the web server will serve up the
|
68
|
-
respective `index.html` file. Here's an example of what this structure might
|
69
|
-
look like:
|
70
|
-
|
71
|
-
{% highlight bash %}
|
72
|
-
.
|
73
|
-
├── _config.yml
|
74
|
-
├── _includes/
|
75
|
-
├── _layouts/
|
76
|
-
├── _posts/
|
77
|
-
├── _site/
|
78
|
-
├── about/
|
79
|
-
| └── index.html # => http://example.com/about/
|
80
|
-
├── contact/
|
81
|
-
| └── index.html # => http://example.com/contact/
|
82
|
-
└── index.html # => http://example.com/
|
83
|
-
{% endhighlight %}
|
84
|
-
|
85
|
-
This approach may not suit everyone, but for people who like clean URLs it’s
|
86
|
-
simple and it works. In the end the decision is yours!
|
data/site/docs/pagination.md
DELETED
@@ -1,212 +0,0 @@
|
|
1
|
-
---
|
2
|
-
layout: docs
|
3
|
-
title: Pagination
|
4
|
-
prev_section: permalinks
|
5
|
-
next_section: plugins
|
6
|
-
permalink: /docs/pagination/
|
7
|
-
---
|
8
|
-
|
9
|
-
With many websites—especially blogs—it’s very common to break the main listing
|
10
|
-
of posts up into smaller lists and display them over multiple pages. Jekyll has
|
11
|
-
pagination built-in, so you can automatically generate the appropriate files and
|
12
|
-
folders you need for paginated listings.
|
13
|
-
|
14
|
-
<div class="note info">
|
15
|
-
<h5>Pagination only works within HTML files</h5>
|
16
|
-
<p>
|
17
|
-
Pagination does not work with Markdown or Textile files in your Jekyll site.
|
18
|
-
It will only work when used within HTML files. Since you’ll likely be using
|
19
|
-
this for the list of Posts, this shouldn’t be an issue.
|
20
|
-
</p>
|
21
|
-
</div>
|
22
|
-
|
23
|
-
## Enable pagination
|
24
|
-
|
25
|
-
To enable pagination for your blog, add a line to the `_config.yml` file that
|
26
|
-
specifies how many items should be displayed per page:
|
27
|
-
|
28
|
-
{% highlight yaml %}
|
29
|
-
paginate: 5
|
30
|
-
{% endhighlight %}
|
31
|
-
|
32
|
-
The number should be the maximum number of Posts you’d like to be displayed per-
|
33
|
-
page in the generated site.
|
34
|
-
|
35
|
-
You may also specify where the destination of the pagination pages:
|
36
|
-
|
37
|
-
{% highlight yaml %}
|
38
|
-
paginate_path: "blog/page:num"
|
39
|
-
{% endhighlight %}
|
40
|
-
|
41
|
-
This will read in `blog/index.html`, send it each pagination page in Liquid as `paginator`
|
42
|
-
and write the output to `blog/page:num`, where `:num` is the pagination page number,
|
43
|
-
starting with `2`. If a site has 12 posts and specifies `paginate: 5`, Jekyll will write
|
44
|
-
`blog/index.html` with the first 5 posts, `blog/page2/index.html` with the next 5 posts
|
45
|
-
and `blog/page3/index.html` with the last 2 posts into the destination directory.
|
46
|
-
|
47
|
-
## Liquid Attributes Available
|
48
|
-
|
49
|
-
The pagination plugin exposes the `paginator` liquid object with the following
|
50
|
-
attributes:
|
51
|
-
|
52
|
-
<div class="mobile-side-scroller">
|
53
|
-
<table>
|
54
|
-
<thead>
|
55
|
-
<tr>
|
56
|
-
<th>Attribute</th>
|
57
|
-
<th>Description</th>
|
58
|
-
</tr>
|
59
|
-
</thead>
|
60
|
-
<tbody>
|
61
|
-
<tr>
|
62
|
-
<td><p><code>page</code></p></td>
|
63
|
-
<td><p>current page number</p></td>
|
64
|
-
</tr>
|
65
|
-
<tr>
|
66
|
-
<td><p><code>per_page</code></p></td>
|
67
|
-
<td><p>number of posts per page</p></td>
|
68
|
-
</tr>
|
69
|
-
<tr>
|
70
|
-
<td><p><code>posts</code></p></td>
|
71
|
-
<td><p>a list of posts for the current page</p></td>
|
72
|
-
</tr>
|
73
|
-
<tr>
|
74
|
-
<td><p><code>total_posts</code></p></td>
|
75
|
-
<td><p>total number of posts in the site</p></td>
|
76
|
-
</tr>
|
77
|
-
<tr>
|
78
|
-
<td><p><code>total_pages</code></p></td>
|
79
|
-
<td><p>number of pagination pages</p></td>
|
80
|
-
</tr>
|
81
|
-
<tr>
|
82
|
-
<td><p><code>previous_page</code></p></td>
|
83
|
-
<td>
|
84
|
-
<p>
|
85
|
-
page number of the previous pagination page,
|
86
|
-
or <code>nil</code> if no previous page exists
|
87
|
-
</p>
|
88
|
-
</td>
|
89
|
-
</tr>
|
90
|
-
<tr>
|
91
|
-
<td><p><code>previous_page_path</code></p></td>
|
92
|
-
<td>
|
93
|
-
<p>
|
94
|
-
path of previous pagination page,
|
95
|
-
or <code>nil</code> if no previous page exists
|
96
|
-
</p>
|
97
|
-
</td>
|
98
|
-
</tr>
|
99
|
-
<tr>
|
100
|
-
<td><p><code>next_page</code></p></td>
|
101
|
-
<td>
|
102
|
-
<p>
|
103
|
-
page number of the next pagination page,
|
104
|
-
or <code>nil</code> if no subsequent page exists
|
105
|
-
</p>
|
106
|
-
</td>
|
107
|
-
</tr>
|
108
|
-
<tr>
|
109
|
-
<td><p><code>next_page_path</code></p></td>
|
110
|
-
<td>
|
111
|
-
<p>
|
112
|
-
path of next pagination page,
|
113
|
-
or <code>nil</code> if no subsequent page exists
|
114
|
-
</p>
|
115
|
-
</td>
|
116
|
-
</tr>
|
117
|
-
</tbody>
|
118
|
-
</table>
|
119
|
-
</div>
|
120
|
-
|
121
|
-
<div class="note info">
|
122
|
-
<h5>Pagination does not support tags or categories</h5>
|
123
|
-
<p>Pagination pages through every post in the <code>posts</code>
|
124
|
-
variable regardless of variables defined in the YAML Front Matter of
|
125
|
-
each. It does not currently allow paging over groups of posts linked
|
126
|
-
by a common tag or category. It cannot include any collection of
|
127
|
-
documents because it is restricted to posts.</p>
|
128
|
-
</div>
|
129
|
-
|
130
|
-
## Render the paginated Posts
|
131
|
-
|
132
|
-
The next thing you need to do is to actually display your posts in a list using
|
133
|
-
the `paginator` variable that will now be available to you. You’ll probably want
|
134
|
-
to do this in one of the main pages of your site. Here’s one example of a simple
|
135
|
-
way of rendering paginated Posts in a HTML file:
|
136
|
-
|
137
|
-
{% highlight html %}
|
138
|
-
{% raw %}
|
139
|
-
---
|
140
|
-
layout: default
|
141
|
-
title: My Blog
|
142
|
-
---
|
143
|
-
|
144
|
-
<!-- This loops through the paginated posts -->
|
145
|
-
{% for post in paginator.posts %}
|
146
|
-
<h1><a href="{{ post.url }}">{{ post.title }}</a></h1>
|
147
|
-
<p class="author">
|
148
|
-
<span class="date">{{ post.date }}</span>
|
149
|
-
</p>
|
150
|
-
<div class="content">
|
151
|
-
{{ post.content }}
|
152
|
-
</div>
|
153
|
-
{% endfor %}
|
154
|
-
|
155
|
-
<!-- Pagination links -->
|
156
|
-
<div class="pagination">
|
157
|
-
{% if paginator.previous_page %}
|
158
|
-
<a href="/page{{ paginator.previous_page }}" class="previous">Previous</a>
|
159
|
-
{% else %}
|
160
|
-
<span class="previous">Previous</span>
|
161
|
-
{% endif %}
|
162
|
-
<span class="page_number ">Page: {{ paginator.page }} of {{ paginator.total_pages }}</span>
|
163
|
-
{% if paginator.next_page %}
|
164
|
-
<a href="/page{{ paginator.next_page }}" class="next">Next</a>
|
165
|
-
{% else %}
|
166
|
-
<span class="next ">Next</span>
|
167
|
-
{% endif %}
|
168
|
-
</div>
|
169
|
-
{% endraw %}
|
170
|
-
{% endhighlight %}
|
171
|
-
|
172
|
-
<div class="note warning">
|
173
|
-
<h5>Beware the page one edge-case</h5>
|
174
|
-
<p>
|
175
|
-
Jekyll does not generate a ‘page1’ folder, so the above code will not work
|
176
|
-
when a <code>/page1</code> link is produced. See below for a way to handle
|
177
|
-
this if it’s a problem for you.
|
178
|
-
</p>
|
179
|
-
</div>
|
180
|
-
|
181
|
-
The following HTML snippet should handle page one, and render a list of each
|
182
|
-
page with links to all but the current page.
|
183
|
-
|
184
|
-
{% highlight html %}
|
185
|
-
{% raw %}
|
186
|
-
{% if paginator.total_pages > 1 %}
|
187
|
-
<div class="pagination">
|
188
|
-
{% if paginator.previous_page %}
|
189
|
-
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">« Prev</a>
|
190
|
-
{% else %}
|
191
|
-
<span>« Prev</span>
|
192
|
-
{% endif %}
|
193
|
-
|
194
|
-
{% for page in (1..paginator.total_pages) %}
|
195
|
-
{% if page == paginator.page %}
|
196
|
-
<em>{{ page }}</em>
|
197
|
-
{% elsif page == 1 %}
|
198
|
-
<a href="{{ '/index.html' | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
|
199
|
-
{% else %}
|
200
|
-
<a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
|
201
|
-
{% endif %}
|
202
|
-
{% endfor %}
|
203
|
-
|
204
|
-
{% if paginator.next_page %}
|
205
|
-
<a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next »</a>
|
206
|
-
{% else %}
|
207
|
-
<span>Next »</span>
|
208
|
-
{% endif %}
|
209
|
-
</div>
|
210
|
-
{% endif %}
|
211
|
-
{% endraw %}
|
212
|
-
{% endhighlight %}
|