jekyll-docs 3.6.0 → 3.6.1
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 +471 -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 +337 -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 -807
- 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 -1027
- 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 -893
- 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
|
@@ -1,1800 +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.0">
|
|
8
|
-
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites">
|
|
9
|
-
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
|
|
10
|
-
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
|
11
|
-
<link rel="stylesheet" href="/css/screen.css">
|
|
12
|
-
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
|
13
|
-
<!-- Begin Jekyll SEO tag v2.3.0 -->
|
|
14
|
-
<title>Plugins | Jekyll • Simple, blog-aware, static sites</title>
|
|
15
|
-
<meta property="og:title" content="Plugins">
|
|
16
|
-
<meta property="og:locale" content="en_US">
|
|
17
|
-
<meta name="description" content="Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.">
|
|
18
|
-
<meta property="og:description" content="Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.">
|
|
19
|
-
<link rel="canonical" href="https://jekyllrb.com/docs/plugins/">
|
|
20
|
-
<meta property="og:url" content="https://jekyllrb.com/docs/plugins/">
|
|
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-24T08:07:43-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":"Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.","url":"https://jekyllrb.com/docs/plugins/","headline":"Plugins","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-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/plugins/"},"@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/plugins.md"><i class="fa fa-pencil"></i> Improve this page</a>
|
|
288
|
-
</div>
|
|
289
|
-
<h1>Plugins</h1>
|
|
290
|
-
<p>Jekyll has a plugin system with hooks that allow you to create custom generated
|
|
291
|
-
content specific to your site. You can run custom code for your site without
|
|
292
|
-
having to modify the Jekyll source itself.</p>
|
|
293
|
-
|
|
294
|
-
<div class="note info">
|
|
295
|
-
<h5>Plugins on GitHub Pages</h5>
|
|
296
|
-
<p>
|
|
297
|
-
<a href="https://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
|
|
298
|
-
However, all Pages sites are generated using the <code>--safe</code> option
|
|
299
|
-
to disable custom plugins for security reasons. Unfortunately, this means
|
|
300
|
-
your plugins won’t work if you’re deploying to GitHub Pages.<br><br>
|
|
301
|
-
You can still use GitHub Pages to publish your site, but you’ll need to
|
|
302
|
-
convert the site locally and push the generated static files to your GitHub
|
|
303
|
-
repository instead of the Jekyll source files.
|
|
304
|
-
</p>
|
|
305
|
-
</div>
|
|
306
|
-
|
|
307
|
-
<h2 id="installing-a-plugin">Installing a plugin</h2>
|
|
308
|
-
|
|
309
|
-
<p>You have 3 options for installing plugins:</p>
|
|
310
|
-
|
|
311
|
-
<ol>
|
|
312
|
-
<li>In your site source root, make a <code class="highlighter-rouge">_plugins</code> directory. Place your plugins
|
|
313
|
-
here. Any file ending in <code class="highlighter-rouge">*.rb</code> inside this directory will be loaded before
|
|
314
|
-
Jekyll generates your site.</li>
|
|
315
|
-
<li>
|
|
316
|
-
<p>In your <code class="highlighter-rouge">_config.yml</code> file, add a new array with the key <code class="highlighter-rouge">plugins</code> and the
|
|
317
|
-
values of the gem names of the plugins you’d like to use. An example:</p>
|
|
318
|
-
|
|
319
|
-
<div class="highlighter-rouge">
|
|
320
|
-
<div class="highlight"><pre class="highlight"><code> plugins:
|
|
321
|
-
- jekyll-gist
|
|
322
|
-
- jekyll-coffeescript
|
|
323
|
-
- jekyll-assets
|
|
324
|
-
- another-jekyll-plugin
|
|
325
|
-
# This will require each of these plugins automatically.
|
|
326
|
-
</code></pre></div> </div>
|
|
327
|
-
|
|
328
|
-
<p>Then install your plugins using <code class="highlighter-rouge">gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin</code></p>
|
|
329
|
-
</li>
|
|
330
|
-
<li>
|
|
331
|
-
<p>Add the relevant plugins to a Bundler group in your <code class="highlighter-rouge">Gemfile</code>. An
|
|
332
|
-
example:</p>
|
|
333
|
-
|
|
334
|
-
<div class="highlighter-rouge">
|
|
335
|
-
<div class="highlight"><pre class="highlight"><code> group :jekyll_plugins do
|
|
336
|
-
gem "jekyll-gist"
|
|
337
|
-
gem "jekyll-coffeescript"
|
|
338
|
-
gem "jekyll-assets"
|
|
339
|
-
gem "another-jekyll-plugin"
|
|
340
|
-
end
|
|
341
|
-
</code></pre></div> </div>
|
|
342
|
-
|
|
343
|
-
<p>Now you need to install all plugins from your Bundler group by running single command <code class="highlighter-rouge">bundle install</code>.</p>
|
|
344
|
-
</li>
|
|
345
|
-
</ol>
|
|
346
|
-
|
|
347
|
-
<div class="note info">
|
|
348
|
-
<h5>
|
|
349
|
-
<code>_plugins</code>, <code>_config.yml</code> and <code>Gemfile</code>
|
|
350
|
-
can be used simultaneously
|
|
351
|
-
</h5>
|
|
352
|
-
<p>
|
|
353
|
-
You may use any of the aforementioned plugin options simultaneously in the
|
|
354
|
-
same site if you so choose. Use of one does not restrict the use of the
|
|
355
|
-
others.
|
|
356
|
-
</p>
|
|
357
|
-
</div>
|
|
358
|
-
|
|
359
|
-
<p>In general, plugins you make will fall broadly into one of five categories:</p>
|
|
360
|
-
|
|
361
|
-
<ol>
|
|
362
|
-
<li><a href="#generators">Generators</a></li>
|
|
363
|
-
<li><a href="#converters">Converters</a></li>
|
|
364
|
-
<li><a href="#commands">Commands</a></li>
|
|
365
|
-
<li><a href="#tags">Tags</a></li>
|
|
366
|
-
<li><a href="#hooks">Hooks</a></li>
|
|
367
|
-
</ol>
|
|
368
|
-
|
|
369
|
-
<p>See the bottom of the page for a <a href="#available-plugins">list of available plugins</a></p>
|
|
370
|
-
|
|
371
|
-
<h2 id="generators">Generators</h2>
|
|
372
|
-
|
|
373
|
-
<p>You can create a generator when you need Jekyll to create additional content
|
|
374
|
-
based on your own rules.</p>
|
|
375
|
-
|
|
376
|
-
<p>A generator is a subclass of <code class="highlighter-rouge">Jekyll::Generator</code> that defines a <code class="highlighter-rouge">generate</code>
|
|
377
|
-
method, which receives an instance of
|
|
378
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="highlighter-rouge">Jekyll::Site</code></a>. The
|
|
379
|
-
return value of <code class="highlighter-rouge">generate</code> is ignored.</p>
|
|
380
|
-
|
|
381
|
-
<p>Generators run after Jekyll has made an inventory of the existing content, and
|
|
382
|
-
before the site is generated. Pages with YAML Front Matters are stored as
|
|
383
|
-
instances of
|
|
384
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/page.rb"><code class="highlighter-rouge">Jekyll::Page</code></a>
|
|
385
|
-
and are available via <code class="highlighter-rouge">site.pages</code>. Static files become instances of
|
|
386
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/static_file.rb"><code class="highlighter-rouge">Jekyll::StaticFile</code></a>
|
|
387
|
-
and are available via <code class="highlighter-rouge">site.static_files</code>. See
|
|
388
|
-
<a href="/docs/variables/">the Variables documentation page</a> and
|
|
389
|
-
<a href="https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb"><code class="highlighter-rouge">Jekyll::Site</code></a>
|
|
390
|
-
for more details.</p>
|
|
391
|
-
|
|
392
|
-
<p>For instance, a generator can inject values computed at build time for template
|
|
393
|
-
variables. In the following example the template <code class="highlighter-rouge">reading.html</code> has two
|
|
394
|
-
variables <code class="highlighter-rouge">ongoing</code> and <code class="highlighter-rouge">done</code> that we fill in the generator:</p>
|
|
395
|
-
|
|
396
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Reading</span>
|
|
397
|
-
<span class="k">class</span> <span class="nc">Generator</span> <span class="o"><</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Generator</span>
|
|
398
|
-
<span class="k">def</span> <span class="nf">generate</span><span class="p">(</span><span class="n">site</span><span class="p">)</span>
|
|
399
|
-
<span class="n">ongoing</span><span class="p">,</span> <span class="n">done</span> <span class="o">=</span> <span class="no">Book</span><span class="p">.</span><span class="nf">all</span><span class="p">.</span><span class="nf">partition</span><span class="p">(</span><span class="o">&</span><span class="ss">:ongoing?</span><span class="p">)</span>
|
|
400
|
-
|
|
401
|
-
<span class="n">reading</span> <span class="o">=</span> <span class="n">site</span><span class="p">.</span><span class="nf">pages</span><span class="p">.</span><span class="nf">detect</span> <span class="p">{</span><span class="o">|</span><span class="n">page</span><span class="o">|</span> <span class="n">page</span><span class="p">.</span><span class="nf">name</span> <span class="o">==</span> <span class="s1">'reading.html'</span><span class="p">}</span>
|
|
402
|
-
<span class="n">reading</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'ongoing'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ongoing</span>
|
|
403
|
-
<span class="n">reading</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'done'</span><span class="p">]</span> <span class="o">=</span> <span class="n">done</span>
|
|
404
|
-
<span class="k">end</span>
|
|
405
|
-
<span class="k">end</span>
|
|
406
|
-
<span class="k">end</span>
|
|
407
|
-
</code></pre></div></div>
|
|
408
|
-
|
|
409
|
-
<p>This is a more complex generator that generates new pages:</p>
|
|
410
|
-
|
|
411
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
|
412
|
-
|
|
413
|
-
<span class="k">class</span> <span class="nc">CategoryPage</span> <span class="o"><</span> <span class="no">Page</span>
|
|
414
|
-
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">site</span><span class="p">,</span> <span class="n">base</span><span class="p">,</span> <span class="n">dir</span><span class="p">,</span> <span class="n">category</span><span class="p">)</span>
|
|
415
|
-
<span class="vi">@site</span> <span class="o">=</span> <span class="n">site</span>
|
|
416
|
-
<span class="vi">@base</span> <span class="o">=</span> <span class="n">base</span>
|
|
417
|
-
<span class="vi">@dir</span> <span class="o">=</span> <span class="n">dir</span>
|
|
418
|
-
<span class="vi">@name</span> <span class="o">=</span> <span class="s1">'index.html'</span>
|
|
419
|
-
|
|
420
|
-
<span class="nb">self</span><span class="p">.</span><span class="nf">process</span><span class="p">(</span><span class="vi">@name</span><span class="p">)</span>
|
|
421
|
-
<span class="nb">self</span><span class="p">.</span><span class="nf">read_yaml</span><span class="p">(</span><span class="no">File</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s1">'_layouts'</span><span class="p">),</span> <span class="s1">'category_index.html'</span><span class="p">)</span>
|
|
422
|
-
<span class="nb">self</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'category'</span><span class="p">]</span> <span class="o">=</span> <span class="n">category</span>
|
|
423
|
-
|
|
424
|
-
<span class="n">category_title_prefix</span> <span class="o">=</span> <span class="n">site</span><span class="p">.</span><span class="nf">config</span><span class="p">[</span><span class="s1">'category_title_prefix'</span><span class="p">]</span> <span class="o">||</span> <span class="s1">'Category: '</span>
|
|
425
|
-
<span class="nb">self</span><span class="p">.</span><span class="nf">data</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"</span><span class="si">#{</span><span class="n">category_title_prefix</span><span class="si">}#{</span><span class="n">category</span><span class="si">}</span><span class="s2">"</span>
|
|
426
|
-
<span class="k">end</span>
|
|
427
|
-
<span class="k">end</span>
|
|
428
|
-
|
|
429
|
-
<span class="k">class</span> <span class="nc">CategoryPageGenerator</span> <span class="o"><</span> <span class="no">Generator</span>
|
|
430
|
-
<span class="n">safe</span> <span class="kp">true</span>
|
|
431
|
-
|
|
432
|
-
<span class="k">def</span> <span class="nf">generate</span><span class="p">(</span><span class="n">site</span><span class="p">)</span>
|
|
433
|
-
<span class="k">if</span> <span class="n">site</span><span class="p">.</span><span class="nf">layouts</span><span class="p">.</span><span class="nf">key?</span> <span class="s1">'category_index'</span>
|
|
434
|
-
<span class="n">dir</span> <span class="o">=</span> <span class="n">site</span><span class="p">.</span><span class="nf">config</span><span class="p">[</span><span class="s1">'category_dir'</span><span class="p">]</span> <span class="o">||</span> <span class="s1">'categories'</span>
|
|
435
|
-
<span class="n">site</span><span class="p">.</span><span class="nf">categories</span><span class="p">.</span><span class="nf">each_key</span> <span class="k">do</span> <span class="o">|</span><span class="n">category</span><span class="o">|</span>
|
|
436
|
-
<span class="n">site</span><span class="p">.</span><span class="nf">pages</span> <span class="o"><<</span> <span class="no">CategoryPage</span><span class="p">.</span><span class="nf">new</span><span class="p">(</span><span class="n">site</span><span class="p">,</span> <span class="n">site</span><span class="p">.</span><span class="nf">source</span><span class="p">,</span> <span class="no">File</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="n">dir</span><span class="p">,</span> <span class="n">category</span><span class="p">),</span> <span class="n">category</span><span class="p">)</span>
|
|
437
|
-
<span class="k">end</span>
|
|
438
|
-
<span class="k">end</span>
|
|
439
|
-
<span class="k">end</span>
|
|
440
|
-
<span class="k">end</span>
|
|
441
|
-
|
|
442
|
-
<span class="k">end</span>
|
|
443
|
-
</code></pre></div></div>
|
|
444
|
-
|
|
445
|
-
<p>In this example, our generator will create a series of files under the
|
|
446
|
-
<code class="highlighter-rouge">categories</code> directory for each category, listing the posts in each category
|
|
447
|
-
using the <code class="highlighter-rouge">category_index.html</code> layout.</p>
|
|
448
|
-
|
|
449
|
-
<p>Generators are only required to implement one method:</p>
|
|
450
|
-
|
|
451
|
-
<div class="mobile-side-scroller">
|
|
452
|
-
<table>
|
|
453
|
-
<thead>
|
|
454
|
-
<tr>
|
|
455
|
-
<th>Method</th>
|
|
456
|
-
<th>Description</th>
|
|
457
|
-
</tr>
|
|
458
|
-
</thead>
|
|
459
|
-
<tbody>
|
|
460
|
-
<tr>
|
|
461
|
-
<td>
|
|
462
|
-
<p><code>generate</code></p>
|
|
463
|
-
</td>
|
|
464
|
-
<td>
|
|
465
|
-
<p>Generates content as a side-effect.</p>
|
|
466
|
-
</td>
|
|
467
|
-
</tr>
|
|
468
|
-
</tbody>
|
|
469
|
-
</table>
|
|
470
|
-
</div>
|
|
471
|
-
|
|
472
|
-
<h2 id="converters">Converters</h2>
|
|
473
|
-
|
|
474
|
-
<p>If you have a new markup language you’d like to use with your site, you can
|
|
475
|
-
include it by implementing your own converter. Both the Markdown and
|
|
476
|
-
<a href="https://github.com/jekyll/jekyll-textile-converter">Textile</a> markup
|
|
477
|
-
languages are implemented using this method.</p>
|
|
478
|
-
|
|
479
|
-
<div class="note info">
|
|
480
|
-
<h5>Remember your YAML Front Matter</h5>
|
|
481
|
-
<p>
|
|
482
|
-
Jekyll will only convert files that have a YAML header at the top, even for
|
|
483
|
-
converters you add using a plugin.
|
|
484
|
-
</p>
|
|
485
|
-
</div>
|
|
486
|
-
|
|
487
|
-
<p>Below is a converter that will take all posts ending in <code class="highlighter-rouge">.upcase</code> and process
|
|
488
|
-
them using the <code class="highlighter-rouge">UpcaseConverter</code>:</p>
|
|
489
|
-
|
|
490
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
|
491
|
-
<span class="k">class</span> <span class="nc">UpcaseConverter</span> <span class="o"><</span> <span class="no">Converter</span>
|
|
492
|
-
<span class="n">safe</span> <span class="kp">true</span>
|
|
493
|
-
<span class="n">priority</span> <span class="ss">:low</span>
|
|
494
|
-
|
|
495
|
-
<span class="k">def</span> <span class="nf">matches</span><span class="p">(</span><span class="n">ext</span><span class="p">)</span>
|
|
496
|
-
<span class="n">ext</span> <span class="o">=~</span> <span class="sr">/^\.upcase$/i</span>
|
|
497
|
-
<span class="k">end</span>
|
|
498
|
-
|
|
499
|
-
<span class="k">def</span> <span class="nf">output_ext</span><span class="p">(</span><span class="n">ext</span><span class="p">)</span>
|
|
500
|
-
<span class="s2">".html"</span>
|
|
501
|
-
<span class="k">end</span>
|
|
502
|
-
|
|
503
|
-
<span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>
|
|
504
|
-
<span class="n">content</span><span class="p">.</span><span class="nf">upcase</span>
|
|
505
|
-
<span class="k">end</span>
|
|
506
|
-
<span class="k">end</span>
|
|
507
|
-
<span class="k">end</span>
|
|
508
|
-
</code></pre></div></div>
|
|
509
|
-
|
|
510
|
-
<p>Converters should implement at a minimum 3 methods:</p>
|
|
511
|
-
|
|
512
|
-
<div class="mobile-side-scroller">
|
|
513
|
-
<table>
|
|
514
|
-
<thead>
|
|
515
|
-
<tr>
|
|
516
|
-
<th>Method</th>
|
|
517
|
-
<th>Description</th>
|
|
518
|
-
</tr>
|
|
519
|
-
</thead>
|
|
520
|
-
<tbody>
|
|
521
|
-
<tr>
|
|
522
|
-
<td>
|
|
523
|
-
<p><code>matches</code></p>
|
|
524
|
-
</td>
|
|
525
|
-
<td><p>
|
|
526
|
-
Does the given extension match this converter’s list of acceptable
|
|
527
|
-
extensions? Takes one argument: the file’s extension (including the
|
|
528
|
-
dot). Must return <code>true</code> if it matches, <code>false</code>
|
|
529
|
-
otherwise.
|
|
530
|
-
</p></td>
|
|
531
|
-
</tr>
|
|
532
|
-
<tr>
|
|
533
|
-
<td>
|
|
534
|
-
<p><code>output_ext</code></p>
|
|
535
|
-
</td>
|
|
536
|
-
<td><p>
|
|
537
|
-
The extension to be given to the output file (including the dot).
|
|
538
|
-
Usually this will be <code>".html"</code>.
|
|
539
|
-
</p></td>
|
|
540
|
-
</tr>
|
|
541
|
-
<tr>
|
|
542
|
-
<td>
|
|
543
|
-
<p><code>convert</code></p>
|
|
544
|
-
</td>
|
|
545
|
-
<td><p>
|
|
546
|
-
Logic to do the content conversion. Takes one argument: the raw content
|
|
547
|
-
of the file (without YAML Front Matter). Must return a String.
|
|
548
|
-
</p></td>
|
|
549
|
-
</tr>
|
|
550
|
-
</tbody>
|
|
551
|
-
</table>
|
|
552
|
-
</div>
|
|
553
|
-
|
|
554
|
-
<p>In our example, <code class="highlighter-rouge">UpcaseConverter#matches</code> checks if our filename extension is
|
|
555
|
-
<code class="highlighter-rouge">.upcase</code>, and will render using the converter if it is. It will call
|
|
556
|
-
<code class="highlighter-rouge">UpcaseConverter#convert</code> to process the content. In our simple converter we’re
|
|
557
|
-
simply uppercasing the entire content string. Finally, when it saves the page,
|
|
558
|
-
it will do so with a <code class="highlighter-rouge">.html</code> extension.</p>
|
|
559
|
-
|
|
560
|
-
<h2 id="commands">Commands</h2>
|
|
561
|
-
|
|
562
|
-
<p>As of version 2.5.0, Jekyll can be extended with plugins which provide
|
|
563
|
-
subcommands for the <code class="highlighter-rouge">jekyll</code> executable. This is possible by including the
|
|
564
|
-
relevant plugins in a <code class="highlighter-rouge">Gemfile</code> group called <code class="highlighter-rouge">:jekyll_plugins</code>:</p>
|
|
565
|
-
|
|
566
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">group</span> <span class="ss">:jekyll_plugins</span> <span class="k">do</span>
|
|
567
|
-
<span class="n">gem</span> <span class="s2">"my_fancy_jekyll_plugin"</span>
|
|
568
|
-
<span class="k">end</span>
|
|
569
|
-
</code></pre></div></div>
|
|
570
|
-
|
|
571
|
-
<p>Each <code class="highlighter-rouge">Command</code> must be a subclass of the <code class="highlighter-rouge">Jekyll::Command</code> class and must
|
|
572
|
-
contain one class method: <code class="highlighter-rouge">init_with_program</code>. An example:</p>
|
|
573
|
-
|
|
574
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">MyNewCommand</span> <span class="o"><</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">Command</span>
|
|
575
|
-
<span class="k">class</span> <span class="o"><<</span> <span class="nb">self</span>
|
|
576
|
-
<span class="k">def</span> <span class="nf">init_with_program</span><span class="p">(</span><span class="n">prog</span><span class="p">)</span>
|
|
577
|
-
<span class="n">prog</span><span class="p">.</span><span class="nf">command</span><span class="p">(</span><span class="ss">:new</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
|
|
578
|
-
<span class="n">c</span><span class="p">.</span><span class="nf">syntax</span> <span class="s2">"new [options]"</span>
|
|
579
|
-
<span class="n">c</span><span class="p">.</span><span class="nf">description</span> <span class="s1">'Create a new Jekyll site.'</span>
|
|
580
|
-
|
|
581
|
-
<span class="n">c</span><span class="p">.</span><span class="nf">option</span> <span class="s1">'dest'</span><span class="p">,</span> <span class="s1">'-d DEST'</span><span class="p">,</span> <span class="s1">'Where the site should go.'</span>
|
|
582
|
-
|
|
583
|
-
<span class="n">c</span><span class="p">.</span><span class="nf">action</span> <span class="k">do</span> <span class="o">|</span><span class="n">args</span><span class="p">,</span> <span class="n">options</span><span class="o">|</span>
|
|
584
|
-
<span class="no">Jekyll</span><span class="o">::</span><span class="no">Site</span><span class="p">.</span><span class="nf">new_site_at</span><span class="p">(</span><span class="n">options</span><span class="p">[</span><span class="s1">'dest'</span><span class="p">])</span>
|
|
585
|
-
<span class="k">end</span>
|
|
586
|
-
<span class="k">end</span>
|
|
587
|
-
<span class="k">end</span>
|
|
588
|
-
<span class="k">end</span>
|
|
589
|
-
<span class="k">end</span>
|
|
590
|
-
</code></pre></div></div>
|
|
591
|
-
|
|
592
|
-
<p>Commands should implement this single class method:</p>
|
|
593
|
-
|
|
594
|
-
<div class="mobile-side-scroller">
|
|
595
|
-
<table>
|
|
596
|
-
<thead>
|
|
597
|
-
<tr>
|
|
598
|
-
<th>Method</th>
|
|
599
|
-
<th>Description</th>
|
|
600
|
-
</tr>
|
|
601
|
-
</thead>
|
|
602
|
-
<tbody>
|
|
603
|
-
<tr>
|
|
604
|
-
<td>
|
|
605
|
-
<p><code>init_with_program</code></p>
|
|
606
|
-
</td>
|
|
607
|
-
<td><p>
|
|
608
|
-
This method accepts one parameter, the
|
|
609
|
-
<code><a href="https://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
|
|
610
|
-
instance, which is the Jekyll program itself. Upon the program,
|
|
611
|
-
commands may be created using the above syntax. For more details,
|
|
612
|
-
visit the Mercenary repository on GitHub.com.
|
|
613
|
-
</p></td>
|
|
614
|
-
</tr>
|
|
615
|
-
</tbody>
|
|
616
|
-
</table>
|
|
617
|
-
</div>
|
|
618
|
-
|
|
619
|
-
<h2 id="tags">Tags</h2>
|
|
620
|
-
|
|
621
|
-
<p>If you’d like to include custom liquid tags in your site, you can do so by
|
|
622
|
-
hooking into the tagging system. Built-in examples added by Jekyll include the
|
|
623
|
-
<code class="highlighter-rouge">highlight</code> and <code class="highlighter-rouge">include</code> tags. Below is an example of a custom liquid tag that
|
|
624
|
-
will output the time the page was rendered:</p>
|
|
625
|
-
|
|
626
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
|
627
|
-
<span class="k">class</span> <span class="nc">RenderTimeTag</span> <span class="o"><</span> <span class="no">Liquid</span><span class="o">::</span><span class="no">Tag</span>
|
|
628
|
-
|
|
629
|
-
<span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">tag_name</span><span class="p">,</span> <span class="n">text</span><span class="p">,</span> <span class="n">tokens</span><span class="p">)</span>
|
|
630
|
-
<span class="k">super</span>
|
|
631
|
-
<span class="vi">@text</span> <span class="o">=</span> <span class="n">text</span>
|
|
632
|
-
<span class="k">end</span>
|
|
633
|
-
|
|
634
|
-
<span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="n">context</span><span class="p">)</span>
|
|
635
|
-
<span class="s2">"</span><span class="si">#{</span><span class="vi">@text</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="no">Time</span><span class="p">.</span><span class="nf">now</span><span class="si">}</span><span class="s2">"</span>
|
|
636
|
-
<span class="k">end</span>
|
|
637
|
-
<span class="k">end</span>
|
|
638
|
-
<span class="k">end</span>
|
|
639
|
-
|
|
640
|
-
<span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTag</span><span class="p">)</span>
|
|
641
|
-
</code></pre></div></div>
|
|
642
|
-
|
|
643
|
-
<p>At a minimum, liquid tags must implement:</p>
|
|
644
|
-
|
|
645
|
-
<div class="mobile-side-scroller">
|
|
646
|
-
<table>
|
|
647
|
-
<thead>
|
|
648
|
-
<tr>
|
|
649
|
-
<th>Method</th>
|
|
650
|
-
<th>Description</th>
|
|
651
|
-
</tr>
|
|
652
|
-
</thead>
|
|
653
|
-
<tbody>
|
|
654
|
-
<tr>
|
|
655
|
-
<td>
|
|
656
|
-
<p><code>render</code></p>
|
|
657
|
-
</td>
|
|
658
|
-
<td>
|
|
659
|
-
<p>Outputs the content of the tag.</p>
|
|
660
|
-
</td>
|
|
661
|
-
</tr>
|
|
662
|
-
</tbody>
|
|
663
|
-
</table>
|
|
664
|
-
</div>
|
|
665
|
-
|
|
666
|
-
<p>You must also register the custom tag with the Liquid template engine as
|
|
667
|
-
follows:</p>
|
|
668
|
-
|
|
669
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_tag</span><span class="p">(</span><span class="s1">'render_time'</span><span class="p">,</span> <span class="no">Jekyll</span><span class="o">::</span><span class="no">RenderTimeTag</span><span class="p">)</span>
|
|
670
|
-
</code></pre></div></div>
|
|
671
|
-
|
|
672
|
-
<p>In the example above, we can place the following tag anywhere in one of our
|
|
673
|
-
pages:</p>
|
|
674
|
-
|
|
675
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
|
|
676
|
-
<span class="o"><</span><span class="nb">p</span><span class="o">></span><span class="p">{</span><span class="sx">% render_time </span><span class="n">page</span> <span class="n">rendered</span> <span class="ss">at: </span><span class="sx">%}</p>
|
|
677
|
-
|
|
678
|
-
</span></code></pre></div></div>
|
|
679
|
-
|
|
680
|
-
<p>And we would get something like this on the page:</p>
|
|
681
|
-
|
|
682
|
-
<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><p></span>page rendered at: Tue June 22 23:38:47 –0500 2010<span class="nt"></p></span>
|
|
683
|
-
</code></pre></div></div>
|
|
684
|
-
|
|
685
|
-
<h3 id="liquid-filters">Liquid filters</h3>
|
|
686
|
-
|
|
687
|
-
<p>You can add your own filters to the Liquid template system much like you can
|
|
688
|
-
add tags above. Filters are simply modules that export their methods to liquid.
|
|
689
|
-
All methods will have to take at least one parameter which represents the input
|
|
690
|
-
of the filter. The return value will be the output of the filter.</p>
|
|
691
|
-
|
|
692
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
|
693
|
-
<span class="k">module</span> <span class="nn">AssetFilter</span>
|
|
694
|
-
<span class="k">def</span> <span class="nf">asset_url</span><span class="p">(</span><span class="n">input</span><span class="p">)</span>
|
|
695
|
-
<span class="s2">"http://www.example.com/</span><span class="si">#{</span><span class="n">input</span><span class="si">}</span><span class="s2">?</span><span class="si">#{</span><span class="no">Time</span><span class="p">.</span><span class="nf">now</span><span class="p">.</span><span class="nf">to_i</span><span class="si">}</span><span class="s2">"</span>
|
|
696
|
-
<span class="k">end</span>
|
|
697
|
-
<span class="k">end</span>
|
|
698
|
-
<span class="k">end</span>
|
|
699
|
-
|
|
700
|
-
<span class="no">Liquid</span><span class="o">::</span><span class="no">Template</span><span class="p">.</span><span class="nf">register_filter</span><span class="p">(</span><span class="no">Jekyll</span><span class="o">::</span><span class="no">AssetFilter</span><span class="p">)</span>
|
|
701
|
-
</code></pre></div></div>
|
|
702
|
-
|
|
703
|
-
<div class="note">
|
|
704
|
-
<h5>ProTip™: Access the site object using Liquid</h5>
|
|
705
|
-
<p>
|
|
706
|
-
Jekyll lets you access the <code>site</code> object through the
|
|
707
|
-
<code>context.registers</code> feature of Liquid at <code>context.registers[:site]</code>. For example, you can
|
|
708
|
-
access the global configuration file <code>_config.yml</code> using
|
|
709
|
-
<code>context.registers[:site].config</code>.
|
|
710
|
-
</p>
|
|
711
|
-
</div>
|
|
712
|
-
|
|
713
|
-
<h3 id="flags">Flags</h3>
|
|
714
|
-
|
|
715
|
-
<p>There are two flags to be aware of when writing a plugin:</p>
|
|
716
|
-
|
|
717
|
-
<div class="mobile-side-scroller">
|
|
718
|
-
<table>
|
|
719
|
-
<thead>
|
|
720
|
-
<tr>
|
|
721
|
-
<th>Flag</th>
|
|
722
|
-
<th>Description</th>
|
|
723
|
-
</tr>
|
|
724
|
-
</thead>
|
|
725
|
-
<tbody>
|
|
726
|
-
<tr>
|
|
727
|
-
<td>
|
|
728
|
-
<p><code>safe</code></p>
|
|
729
|
-
</td>
|
|
730
|
-
<td>
|
|
731
|
-
<p>
|
|
732
|
-
A boolean flag that informs Jekyll whether this plugin may be safely
|
|
733
|
-
executed in an environment where arbitrary code execution is not
|
|
734
|
-
allowed. This is used by GitHub Pages to determine which core plugins
|
|
735
|
-
may be used, and which are unsafe to run. If your plugin does not
|
|
736
|
-
allow for arbitrary code execution, set this to <code>true</code>.
|
|
737
|
-
GitHub Pages still won’t load your plugin, but if you submit it for
|
|
738
|
-
inclusion in core, it’s best for this to be correct!
|
|
739
|
-
</p>
|
|
740
|
-
</td>
|
|
741
|
-
</tr>
|
|
742
|
-
<tr>
|
|
743
|
-
<td>
|
|
744
|
-
<p><code>priority</code></p>
|
|
745
|
-
</td>
|
|
746
|
-
<td>
|
|
747
|
-
<p>
|
|
748
|
-
This flag determines what order the plugin is loaded in. Valid values
|
|
749
|
-
are: <code>:lowest</code>, <code>:low</code>, <code>:normal</code>,
|
|
750
|
-
<code>:high</code>, and <code>:highest</code>. Highest priority
|
|
751
|
-
matches are applied first, lowest priority are applied last.
|
|
752
|
-
</p>
|
|
753
|
-
</td>
|
|
754
|
-
</tr>
|
|
755
|
-
</tbody>
|
|
756
|
-
</table>
|
|
757
|
-
</div>
|
|
758
|
-
|
|
759
|
-
<p>To use one of the example plugins above as an illustration, here is how you’d
|
|
760
|
-
specify these two flags:</p>
|
|
761
|
-
|
|
762
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
|
|
763
|
-
<span class="k">class</span> <span class="nc">UpcaseConverter</span> <span class="o"><</span> <span class="no">Converter</span>
|
|
764
|
-
<span class="n">safe</span> <span class="kp">true</span>
|
|
765
|
-
<span class="n">priority</span> <span class="ss">:low</span>
|
|
766
|
-
<span class="o">...</span>
|
|
767
|
-
<span class="k">end</span>
|
|
768
|
-
<span class="k">end</span>
|
|
769
|
-
</code></pre></div></div>
|
|
770
|
-
|
|
771
|
-
<h2 id="hooks">Hooks</h2>
|
|
772
|
-
|
|
773
|
-
<p>Using hooks, your plugin can exercise fine-grained control over various aspects
|
|
774
|
-
of the build process. If your plugin defines any hooks, Jekyll will call them
|
|
775
|
-
at pre-defined points.</p>
|
|
776
|
-
|
|
777
|
-
<p>Hooks are registered to a container and an event name. To register one, you
|
|
778
|
-
call Jekyll::Hooks.register, and pass the container, event name, and code to
|
|
779
|
-
call whenever the hook is triggered. For example, if you want to execute some
|
|
780
|
-
custom functionality every time Jekyll renders a post, you could register a
|
|
781
|
-
hook like this:</p>
|
|
782
|
-
|
|
783
|
-
<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="no">Jekyll</span><span class="o">::</span><span class="no">Hooks</span><span class="p">.</span><span class="nf">register</span> <span class="ss">:posts</span><span class="p">,</span> <span class="ss">:post_render</span> <span class="k">do</span> <span class="o">|</span><span class="n">post</span><span class="o">|</span>
|
|
784
|
-
<span class="c1"># code to call after Jekyll renders a post</span>
|
|
785
|
-
<span class="k">end</span>
|
|
786
|
-
</code></pre></div></div>
|
|
787
|
-
|
|
788
|
-
<p>Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
|
|
789
|
-
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
|
|
790
|
-
your hooks with the container object as the first callback parameter. However,
|
|
791
|
-
all <code class="highlighter-rouge">:pre_render</code> hooks and the<code class="highlighter-rouge">:site, :post_render</code> hook will also provide a
|
|
792
|
-
payload hash as a second parameter. In the case of <code class="highlighter-rouge">:pre_render</code>, the payload
|
|
793
|
-
gives you full control over the variables that are available while rendering.
|
|
794
|
-
In the case of <code class="highlighter-rouge">:site, :post_render</code>, the payload contains final values after
|
|
795
|
-
rendering all the site (useful for sitemaps, feeds, etc).</p>
|
|
796
|
-
|
|
797
|
-
<p>The complete list of available hooks is below:</p>
|
|
798
|
-
|
|
799
|
-
<div class="mobile-side-scroller">
|
|
800
|
-
<table>
|
|
801
|
-
<thead>
|
|
802
|
-
<tr>
|
|
803
|
-
<th>Container</th>
|
|
804
|
-
<th>Event</th>
|
|
805
|
-
<th>Called</th>
|
|
806
|
-
</tr>
|
|
807
|
-
</thead>
|
|
808
|
-
<tbody>
|
|
809
|
-
<tr>
|
|
810
|
-
<td>
|
|
811
|
-
<p><code>:site</code></p>
|
|
812
|
-
</td>
|
|
813
|
-
<td>
|
|
814
|
-
<p><code>:after_init</code></p>
|
|
815
|
-
</td>
|
|
816
|
-
<td>
|
|
817
|
-
<p>Just after the site initializes, but before setup & render. Good
|
|
818
|
-
for modifying the configuration of the site.</p>
|
|
819
|
-
</td>
|
|
820
|
-
</tr>
|
|
821
|
-
<tr>
|
|
822
|
-
<td>
|
|
823
|
-
<p><code>:site</code></p>
|
|
824
|
-
</td>
|
|
825
|
-
<td>
|
|
826
|
-
<p><code>:after_reset</code></p>
|
|
827
|
-
</td>
|
|
828
|
-
<td>
|
|
829
|
-
<p>Just after site reset</p>
|
|
830
|
-
</td>
|
|
831
|
-
</tr>
|
|
832
|
-
<tr>
|
|
833
|
-
<td>
|
|
834
|
-
<p><code>:site</code></p>
|
|
835
|
-
</td>
|
|
836
|
-
<td>
|
|
837
|
-
<p><code>:post_read</code></p>
|
|
838
|
-
</td>
|
|
839
|
-
<td>
|
|
840
|
-
<p>After site data has been read and loaded from disk</p>
|
|
841
|
-
</td>
|
|
842
|
-
</tr>
|
|
843
|
-
<tr>
|
|
844
|
-
<td>
|
|
845
|
-
<p><code>:site</code></p>
|
|
846
|
-
</td>
|
|
847
|
-
<td>
|
|
848
|
-
<p><code>:pre_render</code></p>
|
|
849
|
-
</td>
|
|
850
|
-
<td>
|
|
851
|
-
<p>Just before rendering the whole site</p>
|
|
852
|
-
</td>
|
|
853
|
-
</tr>
|
|
854
|
-
<tr>
|
|
855
|
-
<td>
|
|
856
|
-
<p><code>:site</code></p>
|
|
857
|
-
</td>
|
|
858
|
-
<td>
|
|
859
|
-
<p><code>:post_render</code></p>
|
|
860
|
-
</td>
|
|
861
|
-
<td>
|
|
862
|
-
<p>After rendering the whole site, but before writing any files</p>
|
|
863
|
-
</td>
|
|
864
|
-
</tr>
|
|
865
|
-
<tr>
|
|
866
|
-
<td>
|
|
867
|
-
<p><code>:site</code></p>
|
|
868
|
-
</td>
|
|
869
|
-
<td>
|
|
870
|
-
<p><code>:post_write</code></p>
|
|
871
|
-
</td>
|
|
872
|
-
<td>
|
|
873
|
-
<p>After writing the whole site to disk</p>
|
|
874
|
-
</td>
|
|
875
|
-
</tr>
|
|
876
|
-
<tr>
|
|
877
|
-
<td>
|
|
878
|
-
<p><code>:pages</code></p>
|
|
879
|
-
</td>
|
|
880
|
-
<td>
|
|
881
|
-
<p><code>:post_init</code></p>
|
|
882
|
-
</td>
|
|
883
|
-
<td>
|
|
884
|
-
<p>Whenever a page is initialized</p>
|
|
885
|
-
</td>
|
|
886
|
-
</tr>
|
|
887
|
-
<tr>
|
|
888
|
-
<td>
|
|
889
|
-
<p><code>:pages</code></p>
|
|
890
|
-
</td>
|
|
891
|
-
<td>
|
|
892
|
-
<p><code>:pre_render</code></p>
|
|
893
|
-
</td>
|
|
894
|
-
<td>
|
|
895
|
-
<p>Just before rendering a page</p>
|
|
896
|
-
</td>
|
|
897
|
-
</tr>
|
|
898
|
-
<tr>
|
|
899
|
-
<td>
|
|
900
|
-
<p><code>:pages</code></p>
|
|
901
|
-
</td>
|
|
902
|
-
<td>
|
|
903
|
-
<p><code>:post_render</code></p>
|
|
904
|
-
</td>
|
|
905
|
-
<td>
|
|
906
|
-
<p>After rendering a page, but before writing it to disk</p>
|
|
907
|
-
</td>
|
|
908
|
-
</tr>
|
|
909
|
-
<tr>
|
|
910
|
-
<td>
|
|
911
|
-
<p><code>:pages</code></p>
|
|
912
|
-
</td>
|
|
913
|
-
<td>
|
|
914
|
-
<p><code>:post_write</code></p>
|
|
915
|
-
</td>
|
|
916
|
-
<td>
|
|
917
|
-
<p>After writing a page to disk</p>
|
|
918
|
-
</td>
|
|
919
|
-
</tr>
|
|
920
|
-
<tr>
|
|
921
|
-
<td>
|
|
922
|
-
<p><code>:posts</code></p>
|
|
923
|
-
</td>
|
|
924
|
-
<td>
|
|
925
|
-
<p><code>:post_init</code></p>
|
|
926
|
-
</td>
|
|
927
|
-
<td>
|
|
928
|
-
<p>Whenever a post is initialized</p>
|
|
929
|
-
</td>
|
|
930
|
-
</tr>
|
|
931
|
-
<tr>
|
|
932
|
-
<td>
|
|
933
|
-
<p><code>:posts</code></p>
|
|
934
|
-
</td>
|
|
935
|
-
<td>
|
|
936
|
-
<p><code>:pre_render</code></p>
|
|
937
|
-
</td>
|
|
938
|
-
<td>
|
|
939
|
-
<p>Just before rendering a post</p>
|
|
940
|
-
</td>
|
|
941
|
-
</tr>
|
|
942
|
-
<tr>
|
|
943
|
-
<td>
|
|
944
|
-
<p><code>:posts</code></p>
|
|
945
|
-
</td>
|
|
946
|
-
<td>
|
|
947
|
-
<p><code>:post_render</code></p>
|
|
948
|
-
</td>
|
|
949
|
-
<td>
|
|
950
|
-
<p>After rendering a post, but before writing it to disk</p>
|
|
951
|
-
</td>
|
|
952
|
-
</tr>
|
|
953
|
-
<tr>
|
|
954
|
-
<td>
|
|
955
|
-
<p><code>:posts</code></p>
|
|
956
|
-
</td>
|
|
957
|
-
<td>
|
|
958
|
-
<p><code>:post_write</code></p>
|
|
959
|
-
</td>
|
|
960
|
-
<td>
|
|
961
|
-
<p>After writing a post to disk</p>
|
|
962
|
-
</td>
|
|
963
|
-
</tr>
|
|
964
|
-
<tr>
|
|
965
|
-
<td>
|
|
966
|
-
<p><code>:documents</code></p>
|
|
967
|
-
</td>
|
|
968
|
-
<td>
|
|
969
|
-
<p><code>:post_init</code></p>
|
|
970
|
-
</td>
|
|
971
|
-
<td>
|
|
972
|
-
<p>Whenever a document is initialized</p>
|
|
973
|
-
</td>
|
|
974
|
-
</tr>
|
|
975
|
-
<tr>
|
|
976
|
-
<td>
|
|
977
|
-
<p><code>:documents</code></p>
|
|
978
|
-
</td>
|
|
979
|
-
<td>
|
|
980
|
-
<p><code>:pre_render</code></p>
|
|
981
|
-
</td>
|
|
982
|
-
<td>
|
|
983
|
-
<p>Just before rendering a document</p>
|
|
984
|
-
</td>
|
|
985
|
-
</tr>
|
|
986
|
-
<tr>
|
|
987
|
-
<td>
|
|
988
|
-
<p><code>:documents</code></p>
|
|
989
|
-
</td>
|
|
990
|
-
<td>
|
|
991
|
-
<p><code>:post_render</code></p>
|
|
992
|
-
</td>
|
|
993
|
-
<td>
|
|
994
|
-
<p>After rendering a document, but before writing it to disk</p>
|
|
995
|
-
</td>
|
|
996
|
-
</tr>
|
|
997
|
-
<tr>
|
|
998
|
-
<td>
|
|
999
|
-
<p><code>:documents</code></p>
|
|
1000
|
-
</td>
|
|
1001
|
-
<td>
|
|
1002
|
-
<p><code>:post_write</code></p>
|
|
1003
|
-
</td>
|
|
1004
|
-
<td>
|
|
1005
|
-
<p>After writing a document to disk</p>
|
|
1006
|
-
</td>
|
|
1007
|
-
</tr>
|
|
1008
|
-
</tbody>
|
|
1009
|
-
</table>
|
|
1010
|
-
</div>
|
|
1011
|
-
|
|
1012
|
-
<h2 id="available-plugins">Available Plugins</h2>
|
|
1013
|
-
|
|
1014
|
-
<p>You can find a few useful plugins at the following locations:</p>
|
|
1015
|
-
|
|
1016
|
-
<h4 id="generators-1">Generators</h4>
|
|
1017
|
-
|
|
1018
|
-
<ul>
|
|
1019
|
-
<li>
|
|
1020
|
-
<a href="https://gist.github.com/707909">ArchiveGenerator by Ilkka Laukkanen</a>: Uses <a href="https://gist.github.com/707020">this archive page</a> to generate archives.</li>
|
|
1021
|
-
<li>
|
|
1022
|
-
<a href="https://gist.github.com/642739">LESS.js Generator by Andy Fowler</a>: Renders
|
|
1023
|
-
LESS.js files during generation.</li>
|
|
1024
|
-
<li>
|
|
1025
|
-
<a href="https://gist.github.com/449491">Version Reporter by Blake Smith</a>: Creates a version.html file containing the Jekyll version.</li>
|
|
1026
|
-
<li>
|
|
1027
|
-
<a href="https://github.com/kinnetica/jekyll-plugins">Sitemap.xml Generator by Michael Levin</a>: Generates a sitemap.xml file by traversing all of the available posts and pages.</li>
|
|
1028
|
-
<li>
|
|
1029
|
-
<a href="https://github.com/PascalW/jekyll_indextank">Full-text search by Pascal Widdershoven</a>: Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.</li>
|
|
1030
|
-
<li>
|
|
1031
|
-
<a href="https://github.com/tsmango/jekyll_alias_generator">AliasGenerator by Thomas Mango</a>: Generates redirect pages for posts when an alias is specified in the YAML Front Matter.</li>
|
|
1032
|
-
<li>
|
|
1033
|
-
<a href="https://github.com/nquinlan/jekyll-pageless-redirects">Pageless Redirect Generator by Nick Quinlan</a>: Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.</li>
|
|
1034
|
-
<li>
|
|
1035
|
-
<a href="https://github.com/agelber/jekyll-rss">RssGenerator by Assaf Gelber</a>: Automatically creates an RSS 2.0 feed from your posts.</li>
|
|
1036
|
-
<li>
|
|
1037
|
-
<a href="https://github.com/shigeya/jekyll-monthly-archive-plugin">Monthly archive generator by Shigeya Suzuki</a>: Generator and template which renders monthly archive like MovableType style, based on the work by Ilkka Laukkanen and others above.</li>
|
|
1038
|
-
<li>
|
|
1039
|
-
<a href="https://github.com/shigeya/jekyll-category-archive-plugin">Category archive generator by Shigeya Suzuki</a>: Generator and template which renders category archive like MovableType style, based on Monthly archive generator.</li>
|
|
1040
|
-
<li>
|
|
1041
|
-
<a href="https://github.com/yihangho/emoji-for-jekyll">Emoji for Jekyll</a>: Seamlessly enable emoji for all posts and pages.</li>
|
|
1042
|
-
<li>
|
|
1043
|
-
<a href="https://github.com/mscharley/jekyll-compass">Compass integration for Jekyll</a>: Easily integrate Compass and Sass with your Jekyll website.</li>
|
|
1044
|
-
<li>
|
|
1045
|
-
<a href="https://github.com/bbakersmith/jekyll-pages-directory">Pages Directory by Ben Baker-Smith</a>: Defines a <code class="highlighter-rouge">_pages</code> directory for page files which routes its output relative to the project root.</li>
|
|
1046
|
-
<li>
|
|
1047
|
-
<a href="https://github.com/jeffkole/jekyll-page-collections">Page Collections by Jeff Kolesky</a>: Generates collections of pages with functionality that resembles posts.</li>
|
|
1048
|
-
<li>
|
|
1049
|
-
<a href="https://github.com/sheehamj13/jekyll-live-tiles">Windows 8.1 Live Tile Generation by Matt Sheehan</a>: Generates Internet Explorer 11 config.xml file and Tile Templates for pinning your site to Windows 8.1.</li>
|
|
1050
|
-
<li>
|
|
1051
|
-
<a href="https://github.com/sheehamj13/jekyll_ts">Typescript Generator by Matt Sheehan</a>: Generate Javascript on build from your Typescript.</li>
|
|
1052
|
-
<li>
|
|
1053
|
-
<a href="https://github.com/ivantsepp/jekyll-autolink_email">Jekyll::AutolinkEmail by Ivan Tse</a>: Autolink your emails.</li>
|
|
1054
|
-
<li>
|
|
1055
|
-
<a href="https://github.com/ivantsepp/jekyll-git_metadata">Jekyll::GitMetadata by Ivan Tse</a>: Expose Git metadata for your templates.</li>
|
|
1056
|
-
<li>
|
|
1057
|
-
<a href="https://gist.github.com/snrbrnjna/422a4b7e017192c284b3">Jekyll Http Basic Auth Plugin</a>: Plugin to manage http basic auth for jekyll generated pages and directories.</li>
|
|
1058
|
-
<li>
|
|
1059
|
-
<a href="https://github.com/merlos/jekyll-auto-image">Jekyll Auto Image by Merlos</a>: Gets the first image of a post. Useful to list your posts with images or to add <a href="https://dev.twitter.com/cards/overview">twitter cards</a> to your site.</li>
|
|
1060
|
-
<li>
|
|
1061
|
-
<a href="https://github.com/codeinpink/jekyll-portfolio-generator">Jekyll Portfolio Generator by Shannon Babincsak</a>: Generates project pages and computes related projects out of project data files.</li>
|
|
1062
|
-
<li>
|
|
1063
|
-
<a href="https://github.com/webchef/jekyll-umlauts">Jekyll-Umlauts by Arne Gockeln</a>: This generator replaces all german umlauts (äöüß) case sensitive with html.</li>
|
|
1064
|
-
<li>
|
|
1065
|
-
<a href="https://github.com/lawmurray/indii-jekyll-flickr">Jekyll Flickr Plugin</a> by <a href="http://www.indii.org">Lawrence Murray</a>: Generates posts for photos uploaded to a Flickr photostream.</li>
|
|
1066
|
-
<li>
|
|
1067
|
-
<a href="https://github.com/midnightSuyama/jekyll-paginate-category">Jekyll::Paginate::Category</a>: Pagination Generator for Jekyll Category.</li>
|
|
1068
|
-
<li>
|
|
1069
|
-
<a href="https://github.com/juusaw/amp-jekyll">AMP-Jekyll by Juuso Mikkonen</a>: Generate <a href="https://www.ampproject.org">Accelerated Mobile Pages</a> of Jekyll posts.</li>
|
|
1070
|
-
<li>
|
|
1071
|
-
<a href="https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin">Jekyll Art Gallery plugin</a>: An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.</li>
|
|
1072
|
-
<li>
|
|
1073
|
-
<a href="https://github.com/developmentseed/jekyll-ga">jekyll-ga</a>: A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists “most popular” content. <a href="https://developmentseed.org/blog/google-analytics-jekyll-plugin/">Read the introduction</a> post on the developmentSEED blog.</li>
|
|
1074
|
-
<li>
|
|
1075
|
-
<a href="https://github.com/fadhilnapis/jekyll-multi-paginate">jekyll-multi-paginate</a>: Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.</li>
|
|
1076
|
-
</ul>
|
|
1077
|
-
|
|
1078
|
-
<h4 id="converters-1">Converters</h4>
|
|
1079
|
-
|
|
1080
|
-
<ul>
|
|
1081
|
-
<li>
|
|
1082
|
-
<a href="https://github.com/DougBeney/jekyll-pug">Pug plugin by Doug Beney</a>: Pug (previously Jade) converter for Jekyll.</li>
|
|
1083
|
-
<li>
|
|
1084
|
-
<a href="https://github.com/jekyll/jekyll-textile-converter">Textile converter</a>: Convert <code class="highlighter-rouge">.textile</code> files into HTML. Also includes the <code class="highlighter-rouge">textilize</code> Liquid filter.</li>
|
|
1085
|
-
<li>
|
|
1086
|
-
<a href="https://github.com/slim-template/jekyll-slim">Slim plugin</a>: Slim converter and includes for Jekyll with support for Liquid tags.</li>
|
|
1087
|
-
<li>
|
|
1088
|
-
<a href="https://gist.github.com/517556">HAML plugin by Sam Z</a>: HAML converter for Jekyll.</li>
|
|
1089
|
-
<li>
|
|
1090
|
-
<a href="https://gist.github.com/481456">HAML-Sass Converter by Adam Pearson</a>: Simple HAML-Sass converter for Jekyll. <a href="https://gist.github.com/528642">Fork</a> by Sam X.</li>
|
|
1091
|
-
<li>
|
|
1092
|
-
<a href="https://gist.github.com/960150">Sass SCSS Converter by Mark Wolfe</a>: Sass converter which uses the new CSS compatible syntax, based Sam X’s fork above.</li>
|
|
1093
|
-
<li>
|
|
1094
|
-
<a href="https://gist.github.com/639920">LESS Converter by Jason Graham</a>: Convert LESS files to CSS.</li>
|
|
1095
|
-
<li>
|
|
1096
|
-
<a href="https://gist.github.com/760265">LESS Converter by Josh Brown</a>: Simple LESS converter.</li>
|
|
1097
|
-
<li>
|
|
1098
|
-
<a href="https://gist.github.com/449463">Upcase Converter by Blake Smith</a>: An example Jekyll converter.</li>
|
|
1099
|
-
<li>
|
|
1100
|
-
<a href="https://gist.github.com/959938">CoffeeScript Converter by phaer</a>: A <a href="http://coffeescript.org">CoffeeScript</a> to Javascript converter.</li>
|
|
1101
|
-
<li>
|
|
1102
|
-
<a href="https://github.com/olov/jekyll-references">Markdown References by Olov Lassus</a>: Keep all your markdown reference-style link definitions in one _references.md file.</li>
|
|
1103
|
-
<li>
|
|
1104
|
-
<a href="https://gist.github.com/988201">Stylus Converter</a>: Convert .styl to .css.</li>
|
|
1105
|
-
<li>
|
|
1106
|
-
<a href="https://github.com/xdissent/jekyll-rst">ReStructuredText Converter</a>: Converts ReST documents to HTML with Pygments syntax highlighting.</li>
|
|
1107
|
-
<li>
|
|
1108
|
-
<a href="https://github.com/fauno/jekyll-pandoc-multiple-formats">Jekyll-pandoc-multiple-formats</a> by <a href="https://github.com/edsl">edsl</a>: Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.</li>
|
|
1109
|
-
<li>
|
|
1110
|
-
<a href="https://gist.github.com/1472645">Transform Layouts</a>: Allows HAML layouts (you need a HAML Converter plugin for this to work).</li>
|
|
1111
|
-
<li>
|
|
1112
|
-
<a href="https://gist.github.com/abhiyerra/7377603">Org-mode Converter</a>: Org-mode converter for Jekyll.</li>
|
|
1113
|
-
<li>
|
|
1114
|
-
<a href="https://github.com/mvdbos/kramdown-with-pygments">Customized Kramdown Converter</a>: Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.</li>
|
|
1115
|
-
<li>
|
|
1116
|
-
<a href="https://github.com/TheFox/jekyll-bigfootnotes">Bigfootnotes Plugin</a>: Enables big footnotes for Kramdown.</li>
|
|
1117
|
-
<li>
|
|
1118
|
-
<a href="https://github.com/asciidoctor/jekyll-asciidoc">AsciiDoc Plugin</a>: AsciiDoc convertor for Jekyll using <a href="http://asciidoctor.org/">Asciidoctor</a>.</li>
|
|
1119
|
-
<li>
|
|
1120
|
-
<a href="https://github.com/takuti/jekyll-lazy-tweet-embedding">Lazy Tweet Embedding</a>: Automatically convert tweet urls into twitter cards.</li>
|
|
1121
|
-
<li>
|
|
1122
|
-
<a href="https://github.com/pathawks/jekyll-commonmark">jekyll-commonmark</a>: Markdown converter that uses <a href="https://github.com/jgm/CommonMark">libcmark</a>, the reference parser for CommonMark.</li>
|
|
1123
|
-
</ul>
|
|
1124
|
-
|
|
1125
|
-
<h4 id="filters">Filters</h4>
|
|
1126
|
-
|
|
1127
|
-
<ul>
|
|
1128
|
-
<li>
|
|
1129
|
-
<a href="https://github.com/MattHall/truncatehtml">Truncate HTML</a> by <a href="https://codebeef.com/">Matt Hall</a>: A Jekyll filter that truncates HTML while preserving markup structure.</li>
|
|
1130
|
-
<li>
|
|
1131
|
-
<a href="https://github.com/LawrenceWoodman/domain_name-liquid_filter">Domain Name Filter by Lawrence Woodman</a>: Filters the input text so that just the domain name is left.</li>
|
|
1132
|
-
<li>
|
|
1133
|
-
<a href="https://gist.github.com/731597">Summarize Filter by Mathieu Arnold</a>: Remove markup after a <code class="highlighter-rouge"><div id="extended"></code> tag.</li>
|
|
1134
|
-
<li>
|
|
1135
|
-
<a href="https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb">i18n_filter</a>: Liquid filter to use I18n localization.</li>
|
|
1136
|
-
<li>
|
|
1137
|
-
<a href="https://github.com/SaswatPadhi/jekyll_smilify">Smilify</a> by <a href="https://github.com/SaswatPadhi">SaswatPadhi</a>: Convert text emoticons in your content to themeable smiley pics.</li>
|
|
1138
|
-
<li>
|
|
1139
|
-
<a href="https://gist.github.com/zachleat/5792681">Read in X Minutes</a> by <a href="https://github.com/zachleat">zachleat</a>: Estimates the reading time of a string (for blog post content).</li>
|
|
1140
|
-
<li>
|
|
1141
|
-
<a href="https://github.com/markets/jekyll-timeago">Jekyll-timeago</a>: Converts a time value to the time ago in words.</li>
|
|
1142
|
-
<li>
|
|
1143
|
-
<a href="https://github.com/bdesham/pluralize">pluralize</a>: Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minute<strong>s</strong>”.</li>
|
|
1144
|
-
<li>
|
|
1145
|
-
<a href="https://github.com/bdesham/reading_time">reading_time</a>: Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.</li>
|
|
1146
|
-
<li>
|
|
1147
|
-
<a href="https://github.com/dafi/jekyll-toc-generator">Table of Content Generator</a>: Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.</li>
|
|
1148
|
-
<li>
|
|
1149
|
-
<a href="https://github.com/toshimaru/jekyll-toc">jekyll-toc</a>: A liquid filter plugin for Jekyll which generates a table of contents.</li>
|
|
1150
|
-
<li>
|
|
1151
|
-
<a href="https://github.com/23maverick23/jekyll-humanize">jekyll-humanize</a>: This is a port of the Django app humanize which adds a “human touch” to data. Each method represents a Fluid type filter that can be used in your Jekyll site templates. Given that Jekyll produces static sites, some of the original methods do not make logical sense to port (e.g. naturaltime).</li>
|
|
1152
|
-
<li>
|
|
1153
|
-
<a href="https://github.com/PatrickC8t/Jekyll-Ordinal">Jekyll-Ordinal</a>: Jekyll liquid filter to output a date ordinal such as “st”, “nd”, “rd”, or “th”.</li>
|
|
1154
|
-
<li>
|
|
1155
|
-
<a href="https://github.com/kzykbys/JekyllPlugins">Deprecated articles keeper</a> by <a href="http://blog.kazuya.co/">Kazuya Kobayashi</a>: A simple Jekyll filter which monitor how old an article is.</li>
|
|
1156
|
-
<li>
|
|
1157
|
-
<a href="https://github.com/mehdisadeghi/jekyll-jalali">Jekyll-jalali</a> by <a href="http://mehdix.ir">Mehdi Sadeghi</a>: A simple Gregorian to Jalali date converter filter.</li>
|
|
1158
|
-
<li>
|
|
1159
|
-
<a href="https://github.com/matallo/jekyll-thumbnail-filter">Jekyll Thumbnail Filter</a>: Related posts thumbnail filter.</li>
|
|
1160
|
-
<li>
|
|
1161
|
-
<a href="https://github.com/pathawks/jekyll-smartify">Jekyll-Smartify</a>: SmartyPants filter. Make "quotes" “curly”</li>
|
|
1162
|
-
<li>
|
|
1163
|
-
<a href="https://github.com/pathawks/liquid-md5">liquid-md5</a>: Returns an MD5 hash. Helpful for generating Gravatars in templates.</li>
|
|
1164
|
-
<li>
|
|
1165
|
-
<a href="https://github.com/paulrobertlloyd/jekyll-roman">jekyll-roman</a>: A liquid filter for Jekyll that converts numbers into Roman numerals.</li>
|
|
1166
|
-
<li>
|
|
1167
|
-
<a href="https://github.com/myles/jekyll-typogrify">jekyll-typogrify</a>: A Jekyll plugin that brings the functions of <a href="http://avdgaag.github.io/typogruby/">typogruby</a>.</li>
|
|
1168
|
-
<li>
|
|
1169
|
-
<a href="https://github.com/vwochnik/jekyll-email-protect">Jekyll Email Protect</a>: Email protection liquid filter for Jekyll</li>
|
|
1170
|
-
<li>
|
|
1171
|
-
<a href="https://github.com/mattg/jekyll-uglify-filter">Jekyll Uglify Filter</a>: A Liquid filter that runs your JavaScript through UglifyJS.</li>
|
|
1172
|
-
<li>
|
|
1173
|
-
<a href="https://github.com/sparanoid/match_regex">match_regex</a>: A Liquid filter to perform regex match.</li>
|
|
1174
|
-
<li>
|
|
1175
|
-
<a href="https://github.com/sparanoid/replace_regex">replace_regex</a>: A Liquid filter to perform regex replace.</li>
|
|
1176
|
-
<li>
|
|
1177
|
-
<a href="https://rubygems.org/gems/jekyll-money">Jekyll Money</a>: A Jekyll plugin for dealing with money. Because we all have to at some point.</li>
|
|
1178
|
-
</ul>
|
|
1179
|
-
|
|
1180
|
-
<h4 id="tags-1">Tags</h4>
|
|
1181
|
-
|
|
1182
|
-
<p>You can find a few useful plugins at the following locations:</p>
|
|
1183
|
-
|
|
1184
|
-
<ul>
|
|
1185
|
-
<li>
|
|
1186
|
-
<a href="https://github.com/jekyll/jekyll-gist">Jekyll-gist</a>: Use the <code class="highlighter-rouge">gist</code> tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.</li>
|
|
1187
|
-
<li>
|
|
1188
|
-
<a href="https://github.com/samrayner/jekyll-asset-path-plugin">Asset Path Tag</a> by <a href="http://www.samrayner.com/">Sam Rayner</a>: Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.</li>
|
|
1189
|
-
<li>
|
|
1190
|
-
<a href="https://github.com/christianhellsten/jekyll-plugins">Delicious Plugin by Christian Hellsten</a>: Fetches and renders bookmarks from delicious.com.</li>
|
|
1191
|
-
<li>
|
|
1192
|
-
<a href="https://gist.github.com/480380">Ultraviolet Plugin by Steve Alex</a>: Jekyll tag for the <a href="https://github.com/grosser/ultraviolet">Ultraviolet</a> code highligher.</li>
|
|
1193
|
-
<li>
|
|
1194
|
-
<a href="https://gist.github.com/710577">Tag Cloud Plugin by Ilkka Laukkanen</a>: Generate a tag cloud that links to tag pages.</li>
|
|
1195
|
-
<li>
|
|
1196
|
-
<a href="https://gist.github.com/730347">GIT Tag by Alexandre Girard</a>: Add Git activity inside a list.</li>
|
|
1197
|
-
<li>
|
|
1198
|
-
<a href="https://gist.github.com/834610">MathJax Liquid Tags by Jessy Cowan-Sharp</a>: Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.</li>
|
|
1199
|
-
<li>
|
|
1200
|
-
<a href="https://gist.github.com/1027674">Non-JS Gist Tag by Brandon Tilley</a> A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.</li>
|
|
1201
|
-
<li>
|
|
1202
|
-
<a href="https://gist.github.com/449509">Render Time Tag by Blake Smith</a>: Displays the time a Jekyll page was generated.</li>
|
|
1203
|
-
<li>
|
|
1204
|
-
<a href="https://gist.github.com/912466">Status.net/OStatus Tag by phaer</a>: Displays the notices in a given status.net/ostatus feed.</li>
|
|
1205
|
-
<li>
|
|
1206
|
-
<a href="https://github.com/robb/jekyll-embedly-client">Embed.ly client by Robert Böhnke</a>: Autogenerate embeds from URLs using oEmbed.</li>
|
|
1207
|
-
<li>
|
|
1208
|
-
<a href="https://gist.github.com/2290195">Logarithmic Tag Cloud</a>: Flexible. Logarithmic distribution. Documentation inline.</li>
|
|
1209
|
-
<li>
|
|
1210
|
-
<a href="https://gist.github.com/1455726">oEmbed Tag by Tammo van Lessen</a>: Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.</li>
|
|
1211
|
-
<li>
|
|
1212
|
-
<a href="https://github.com/tsmango/jekyll_flickr_set_tag">FlickrSetTag by Thomas Mango</a>: Generates image galleries from Flickr sets.</li>
|
|
1213
|
-
<li>
|
|
1214
|
-
<a href="https://github.com/scottwb/jekyll-tweet-tag">Tweet Tag by Scott W. Bradley</a>: Liquid tag for <a href="https://dev.twitter.com/docs/embedded-tweets">Embedded Tweets</a> using Twitter’s shortcodes.</li>
|
|
1215
|
-
<li>
|
|
1216
|
-
<a href="https://github.com/rob-murray/jekyll-twitter-plugin">Jekyll Twitter Plugin</a>: A Liquid tag plugin that renders Tweets from Twitter API. Currently supports the <a href="https://dev.twitter.com/rest/reference/get/statuses/oembed">oEmbed</a> API.</li>
|
|
1217
|
-
<li>
|
|
1218
|
-
<a href="https://github.com/rustygeldmacher/jekyll-contentblocks">Jekyll-contentblocks</a>: Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.</li>
|
|
1219
|
-
<li>
|
|
1220
|
-
<a href="https://gist.github.com/1805814">Generate YouTube Embed</a> by <a href="https://github.com/joelverhagen">joelverhagen</a>: Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.</li>
|
|
1221
|
-
<li>
|
|
1222
|
-
<a href="https://github.com/okeeblow/jekyll-beastiepress">Jekyll-beastiepress</a>: FreeBSD utility tags for Jekyll sites.</li>
|
|
1223
|
-
<li>
|
|
1224
|
-
<a href="https://gist.github.com/1895282">Jsonball</a>: Reads json files and produces maps for use in Jekyll files.</li>
|
|
1225
|
-
<li>
|
|
1226
|
-
<a href="https://github.com/pablooliveira/bibjekyll">Bibjekyll</a>: Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.</li>
|
|
1227
|
-
<li>
|
|
1228
|
-
<a href="https://github.com/archome/jekyll-citation">Jekyll-citation</a>: Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).</li>
|
|
1229
|
-
<li>
|
|
1230
|
-
<a href="https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag">Jekyll Dribbble Set Tag</a>: Builds Dribbble image galleries from any user.</li>
|
|
1231
|
-
<li>
|
|
1232
|
-
<a href="https://gist.github.com/2218470">Debbugs</a>: Allows posting links to Debian BTS easily.</li>
|
|
1233
|
-
<li>
|
|
1234
|
-
<a href="https://gist.github.com/2403522">Jekyll-devonly_tag</a>: A block tag for including markup only during development.</li>
|
|
1235
|
-
<li>
|
|
1236
|
-
<a href="https://github.com/redwallhp/JekyllGalleryTag">JekyllGalleryTag</a> by <a href="https://github.com/redwallhp">redwallhp</a>: Generates thumbnails from a directory of images and displays them in a grid.</li>
|
|
1237
|
-
<li>
|
|
1238
|
-
<a href="https://gist.github.com/Yexiaoxing/5891929">Youku and Tudou Embed</a>: Liquid plugin for embedding Youku and Tudou videos.</li>
|
|
1239
|
-
<li>
|
|
1240
|
-
<a href="https://github.com/sectore/jekyll-swfobject">Jekyll-swfobject</a>: Liquid plugin for embedding Adobe Flash files (.swf) using <a href="https://github.com/swfobject/swfobject">SWFObject</a>.</li>
|
|
1241
|
-
<li>
|
|
1242
|
-
<a href="https://github.com/robwierzbowski/jekyll-picture-tag">Jekyll Picture Tag</a>: Easy responsive images for Jekyll. Based on the proposed <a href="https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element"><code class="highlighter-rouge"><picture></code></a> element, polyfilled with Scott Jehl’s <a href="https://github.com/scottjehl/picturefill">Picturefill</a>.</li>
|
|
1243
|
-
<li>
|
|
1244
|
-
<a href="https://github.com/robwierzbowski/jekyll-image-tag">Jekyll Image Tag</a>: Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.</li>
|
|
1245
|
-
<li>
|
|
1246
|
-
<a href="https://github.com/wildlyinaccurate/jekyll-responsive-image">Jekyll Responsive Image</a>: Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (<code class="highlighter-rouge"><picture></code>, <code class="highlighter-rouge">srcset</code>, Imager.js, etc), super-flexible configuration.</li>
|
|
1247
|
-
<li>
|
|
1248
|
-
<a href="https://github.com/matze/jekyll-ditaa">Ditaa Tag</a> by <a href="https://github.com/matze">matze</a>: Renders ASCII diagram art into PNG images and inserts a figure tag.</li>
|
|
1249
|
-
<li>
|
|
1250
|
-
<a href="https://github.com/davidensinger/jekyll-suggested-tweet">Jekyll Suggested Tweet</a> by <a href="https://github.com/davidensinger/">David Ensinger</a>: A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitter’s Web Intents API.</li>
|
|
1251
|
-
<li>
|
|
1252
|
-
<a href="https://github.com/GSI/jekyll_date_chart">Jekyll Date Chart</a> by <a href="https://github.com/GSI">GSI</a>: Block that renders date line charts based on textile-formatted tables.</li>
|
|
1253
|
-
<li>
|
|
1254
|
-
<a href="https://github.com/GSI/jekyll_image_encode">Jekyll Image Encode</a> by <a href="https://github.com/GSI">GSI</a>: Tag that renders base64 codes of images fetched from the web.</li>
|
|
1255
|
-
<li>
|
|
1256
|
-
<a href="https://github.com/GSI/jekyll_quick_man">Jekyll Quick Man</a> by <a href="https://github.com/GSI">GSI</a>: Tag that renders pretty links to man page sources on the internet.</li>
|
|
1257
|
-
<li>
|
|
1258
|
-
<a href="https://gist.github.com/23maverick23/8532525">jekyll-font-awesome</a>: Quickly and easily add Font Awesome icons to your posts.</li>
|
|
1259
|
-
<li>
|
|
1260
|
-
<a href="https://gist.github.com/tobru/9171700">Lychee Gallery Tag</a> by <a href="https://github.com/tobru">tobru</a>: Include <a href="https://lychee.electerious.com/">Lychee</a> albums into a post. For an introduction, see <a href="https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/">Jekyll meets Lychee - A Liquid Tag plugin</a>
|
|
1261
|
-
</li>
|
|
1262
|
-
<li>
|
|
1263
|
-
<a href="https://github.com/callmeed/jekyll-image-set">Image Set/Gallery Tag</a> by <a href="https://github.com/callmeed">callmeed</a>: Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.</li>
|
|
1264
|
-
<li>
|
|
1265
|
-
<a href="https://github.com/lmullen/jekyll_figure">jekyll_figure</a>: Generate figures and captions with links to the figure in a variety of formats</li>
|
|
1266
|
-
<li>
|
|
1267
|
-
<a href="https://github.com/bwillis/jekyll-github-sample">Jekyll GitHub Sample Tag</a>: A liquid tag to include a sample of a github repo file in your Jekyll site.</li>
|
|
1268
|
-
<li>
|
|
1269
|
-
<a href="https://github.com/rob-murray/jekyll-version-plugin">Jekyll Project Version Tag</a>: A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.</li>
|
|
1270
|
-
<li>
|
|
1271
|
-
<a href="https://github.com/AlessandroLorenzi/piwigo_gallery">Piwigo Gallery</a> by <a href="http://blog.alorenzi.eu/">Alessandro Lorenzi</a>: Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag</li>
|
|
1272
|
-
<li>
|
|
1273
|
-
<a href="https://github.com/tmthrgd/jekyll-plugins">mathml.rb</a> by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.</li>
|
|
1274
|
-
<li>
|
|
1275
|
-
<a href="https://github.com/aarongustafson/jekyll-webmention_io">webmention_io.rb</a> by <a href="http://aaron-gustafson.com/">Aaron Gustafson</a>: A plugin to enable <a href="https://indieweb.org/webmention">webmention</a> integration using <a href="https://webmention.io/">Webmention.io</a>. Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.</li>
|
|
1276
|
-
<li>
|
|
1277
|
-
<a href="https://github.com/lkorth/jekyll-500px-embed">Jekyll 500px Embed</a> by Luke Korth. A Liquid tag plugin that embeds <a href="https://500px.com/">500px</a> photos.</li>
|
|
1278
|
-
<li>
|
|
1279
|
-
<a href="https://github.com/bdesham/inline_highlight">inline_highlight</a>: A tag for inline syntax highlighting.</li>
|
|
1280
|
-
<li>
|
|
1281
|
-
<a href="https://github.com/jasonbellamy/jekyll-mermaid">jekyll-mermaid</a>: Simplify the creation of mermaid diagrams and flowcharts in your posts and pages.</li>
|
|
1282
|
-
<li>
|
|
1283
|
-
<a href="https://github.com/Ezmyrelda/twa">twa</a>: Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.</li>
|
|
1284
|
-
<li>
|
|
1285
|
-
<a href="https://github.com/dimitri-koenig/jekyll-plugins">Fetch remote file content</a> by <a href="https://www.dimitrikoenig.net/">Dimitri König</a>: Using <code class="highlighter-rouge">remote_file_content</code> tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo’s to always have a current repo version.</li>
|
|
1286
|
-
<li>
|
|
1287
|
-
<a href="https://github.com/mnuessler/jekyll-asciinema">jekyll-asciinema</a>: A tag for embedding asciicasts recorded with <a href="https://asciinema.org">asciinema</a> in your Jekyll pages.</li>
|
|
1288
|
-
<li>
|
|
1289
|
-
<a href="https://github.com/dommmel/jekyll-youtube">Jekyll-Youtube</a> A Liquid tag that embeds Youtube videos. The default emded markup is responsive but you can also specify your own by using an include/partial.</li>
|
|
1290
|
-
<li>
|
|
1291
|
-
<a href="https://github.com/lawmurray/indii-jekyll-flickr">Jekyll Flickr Plugin</a> by <a href="http://www.indii.org">Lawrence Murray</a>: Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.</li>
|
|
1292
|
-
<li>
|
|
1293
|
-
<a href="https://github.com/paulrobertlloyd/jekyll-figure">jekyll-figure</a>: A liquid tag for Jekyll that generates <code class="highlighter-rouge"><figure></code> elements.</li>
|
|
1294
|
-
<li>
|
|
1295
|
-
<a href="https://github.com/eug/jekyll-video-embed">Jekyll Video Embed</a>: It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)</li>
|
|
1296
|
-
<li>
|
|
1297
|
-
<a href="https://github.com/KrzysiekJ/jekyll-i18n_tags">jekyll-i18n_tags</a>: Translate your templates.</li>
|
|
1298
|
-
<li>
|
|
1299
|
-
<a href="https://github.com/jekylltools/jekyll-ideal-image-slider">Jekyll Ideal Image Slider</a>: Liquid tag plugin to create image sliders using <a href="https://github.com/gilbitron/Ideal-Image-Slider">Ideal Image Slider</a>.</li>
|
|
1300
|
-
<li>
|
|
1301
|
-
<a href="https://github.com/crispgm/jekyll-tags-list-plugin">Jekyll Tags List Plugin</a>: A Liquid tag plugin that creates tags list in specific order.</li>
|
|
1302
|
-
<li>
|
|
1303
|
-
<a href="https://github.com/ayastreb/jekyll-maps">Jekyll Maps</a> by <a href="https://github.com/ayastreb">Anatoliy Yastreb</a>: A Jekyll plugin to easily embed maps with filterable locations.</li>
|
|
1304
|
-
<li>
|
|
1305
|
-
<a href="https://nhoizey.github.io/jekyll-cloudinary/">Jekyll Cloudinary</a> by <a href="https://nicolas-hoizey.com/">Nicolas Hoizey</a>: a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.</li>
|
|
1306
|
-
<li>
|
|
1307
|
-
<a href="https://github.com/tnhu/jekyll-include-absolute-plugin">jekyll-include-absolute-plugin</a> by <a href="https://github.com/tnhu">Tan Nhu</a>: A Jekyll plugin to include a file from its path relative to Jekyll’s source folder.</li>
|
|
1308
|
-
<li>
|
|
1309
|
-
<a href="https://github.com/mattg/jekyll-download-tag">Jekyll Download Tag</a>: A Liquid tag that acts like <code class="highlighter-rouge">include</code>, but for external resources.</li>
|
|
1310
|
-
<li>
|
|
1311
|
-
<a href="https://github.com/MediaComem/jekyll-brand-social-wall">Jekyll Brand Social Wall</a>: A jekyll plugin to generate a social wall with your favorite social networks</li>
|
|
1312
|
-
<li>
|
|
1313
|
-
<a href="https://github.com/k-funk/jekyll-if-file-exists">Jekyll If File Exists</a>: A Jekyll Plugin that checks if a file exists with an if/else block.</li>
|
|
1314
|
-
<li>
|
|
1315
|
-
<a href="https://github.com/rjoberon/bibsonomy-jekyll">BibSonomy</a>: Jekyll
|
|
1316
|
-
plugin to generate publication lists from <a href="https://www.bibsonomy.org/">BibSonomy</a>.</li>
|
|
1317
|
-
</ul>
|
|
1318
|
-
|
|
1319
|
-
<h4 id="collections">Collections</h4>
|
|
1320
|
-
|
|
1321
|
-
<ul>
|
|
1322
|
-
<li>
|
|
1323
|
-
<a href="https://github.com/recurser/jekyll-plugins">Jekyll Plugins by Recursive Design</a>: Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.</li>
|
|
1324
|
-
<li>
|
|
1325
|
-
<a href="https://github.com/flatterline/jekyll-plugins">Company website and blog plugins</a> by Flatterline, a Ruby on Rails development company: Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.</li>
|
|
1326
|
-
<li>
|
|
1327
|
-
<a href="https://github.com/aucor/jekyll-plugins">Jekyll plugins by Aucor</a>: Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.</li>
|
|
1328
|
-
</ul>
|
|
1329
|
-
|
|
1330
|
-
<h4 id="other">Other</h4>
|
|
1331
|
-
|
|
1332
|
-
<ul>
|
|
1333
|
-
<li>
|
|
1334
|
-
<a href="https://github.com/hendrikschneider/jekyll-analytics">Analytics for Jekyll</a> by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Piwik, etc. to your site</li>
|
|
1335
|
-
<li>
|
|
1336
|
-
<a href="https://github.com/tmthrgd/ditaa-ditaa">ditaa-ditaa</a> by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.</li>
|
|
1337
|
-
<li>
|
|
1338
|
-
<a href="https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb">Pygments Cache Path by Raimonds Simanovskis</a>: Plugin to cache syntax-highlighted code from Pygments.</li>
|
|
1339
|
-
<li>
|
|
1340
|
-
<a href="https://gist.github.com/49630">Draft/Publish Plugin by Michael Ivey</a>: Save posts as drafts.</li>
|
|
1341
|
-
<li>
|
|
1342
|
-
<a href="https://gist.github.com/490101">Growl Notification Generator by Tate Johnson</a>: Send Jekyll notifications to Growl.</li>
|
|
1343
|
-
<li>
|
|
1344
|
-
<a href="https://gist.github.com/525267">Growl Notification Hook by Tate Johnson</a>: Better alternative to the above, but requires his “hook” fork.</li>
|
|
1345
|
-
<li>
|
|
1346
|
-
<a href="https://github.com/LawrenceWoodman/related_posts-jekyll_plugin">Related Posts by Lawrence Woodman</a>: Overrides <code class="highlighter-rouge">site.related_posts</code> to use categories to assess relationship.</li>
|
|
1347
|
-
<li>
|
|
1348
|
-
<a href="https://github.com/toshimaru/jekyll-tagging-related_posts">jekyll-tagging-related_posts</a>: Jekyll related_posts function based on tags (works on Jekyll3).</li>
|
|
1349
|
-
<li>
|
|
1350
|
-
<a href="https://gist.github.com/88cda643aa7e3b0ca1e5">Tiered Archives by Eli Naeher</a>: Create tiered template variable that allows you to group archives by year and month.</li>
|
|
1351
|
-
<li>
|
|
1352
|
-
<a href="https://github.com/blackwinter/jekyll-localization">Jekyll-localization</a>: Jekyll plugin that adds localization features to the rendering engine.</li>
|
|
1353
|
-
<li>
|
|
1354
|
-
<a href="https://github.com/blackwinter/jekyll-rendering">Jekyll-rendering</a>: Jekyll plugin to provide alternative rendering engines.</li>
|
|
1355
|
-
<li>
|
|
1356
|
-
<a href="https://github.com/blackwinter/jekyll-pagination">Jekyll-pagination</a>: Jekyll plugin to extend the pagination generator.</li>
|
|
1357
|
-
<li>
|
|
1358
|
-
<a href="https://github.com/pattex/jekyll-tagging">Jekyll-tagging</a>: Jekyll plugin to automatically generate a tag cloud and tag pages.</li>
|
|
1359
|
-
<li>
|
|
1360
|
-
<a href="https://github.com/inukshuk/jekyll-scholar">Jekyll-scholar</a>: Jekyll extensions for the blogging scholar.</li>
|
|
1361
|
-
<li>
|
|
1362
|
-
<a href="https://github.com/moshen/jekyll-asset_bundler">Jekyll-asset_bundler</a>: Bundles and minifies JavaScript and CSS.</li>
|
|
1363
|
-
<li>
|
|
1364
|
-
<a href="http://jekyll.github.io/jekyll-assets/">Jekyll-assets</a> by <a href="https://github.com/ixti">ixti</a>: Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).</li>
|
|
1365
|
-
<li>
|
|
1366
|
-
<a href="https://github.com/kitsched/japr">JAPR</a>: Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.</li>
|
|
1367
|
-
<li>
|
|
1368
|
-
<a href="https://gist.github.com/2758691">File compressor</a> by <a href="https://github.com/mytharcher">mytharcher</a>: Compress HTML and JavaScript files on site build.</li>
|
|
1369
|
-
<li>
|
|
1370
|
-
<a href="https://github.com/tkareine/jekyll-minibundle">Jekyll-minibundle</a>: Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.</li>
|
|
1371
|
-
<li>
|
|
1372
|
-
<a href="https://github.com/JCB-K/singlepage-jekyll">Singlepage-jekyll</a> by <a href="https://github.com/JCB-K">JCB-K</a>: Turns Jekyll into a dynamic one-page website.</li>
|
|
1373
|
-
<li>
|
|
1374
|
-
<a href="https://github.com/robwierzbowski/generator-jekyllrb">generator-jekyllrb</a>: A generator that wraps Jekyll in <a href="http://yeoman.io/">Yeoman</a>, a tool collection and workflow for building modern web apps.</li>
|
|
1375
|
-
<li>
|
|
1376
|
-
<a href="https://github.com/dannygarcia/grunt-jekyll">grunt-jekyll</a>: A straightforward <a href="http://gruntjs.com/">Grunt</a> plugin for Jekyll.</li>
|
|
1377
|
-
<li>
|
|
1378
|
-
<a href="https://github.com/indirect/jekyll-postfiles">jekyll-postfiles</a>: Add <code class="highlighter-rouge">_postfiles</code> directory and <code class="highlighter-rouge">{{ postfile }}</code> tag so the files a post refers to will always be right there inside your repo.</li>
|
|
1379
|
-
<li>
|
|
1380
|
-
<a href="http://jch.penibelst.de/">A layout that compresses HTML</a>: GitHub Pages compatible, configurable way to compress HTML files on site build.</li>
|
|
1381
|
-
<li>
|
|
1382
|
-
<a href="https://github.com/wdenton/jekyll-co2">Jekyll CO₂</a>: Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.</li>
|
|
1383
|
-
<li>
|
|
1384
|
-
<a href="http://www.northfieldx.co.uk/remote-include/">remote-include</a>: Includes files using remote URLs</li>
|
|
1385
|
-
<li>
|
|
1386
|
-
<a href="https://github.com/digitalsparky/jekyll-minifier">jekyll-minifier</a>: Minifies HTML, XML, CSS, and Javascript both inline and as separate files utilising yui-compressor and htmlcompressor.</li>
|
|
1387
|
-
<li>
|
|
1388
|
-
<a href="https://bitbucket.org/nyufac/jekyll-views-router">Jekyll views router</a>: Simple router between generator plugins and templates.</li>
|
|
1389
|
-
<li>
|
|
1390
|
-
<a href="https://github.com/vwochnik/jekyll-language-plugin">Jekyll Language Plugin</a>: Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.</li>
|
|
1391
|
-
<li>
|
|
1392
|
-
<a href="https://github.com/vwochnik/jekyll-deploy">Jekyll Deploy</a>: Adds a <code class="highlighter-rouge">deploy</code> sub-command to Jekyll.</li>
|
|
1393
|
-
<li>
|
|
1394
|
-
<a href="https://github.com/contentful/jekyll-contentful-data-import">Official Contentful Jekyll Plugin</a>: Adds a <code class="highlighter-rouge">contentful</code> sub-command to Jekyll to import data from Contentful.</li>
|
|
1395
|
-
<li>
|
|
1396
|
-
<a href="https://github.com/KrzysiekJ/jekyll-paspagon">jekyll-paspagon</a>: Sell your posts in various formats for cryptocurrencies.</li>
|
|
1397
|
-
<li>
|
|
1398
|
-
<a href="https://github.com/awood/hawkins">Hawkins</a>: Adds a <code class="highlighter-rouge">liveserve</code> sub-command to Jekyll that incorporates <a href="http://livereload.com/">LiveReload</a> into your pages while you preview them. No more hitting the refresh button in your browser!</li>
|
|
1399
|
-
<li>
|
|
1400
|
-
<a href="https://github.com/vwochnik/jekyll-autoprefixer">Jekyll Autoprefixer</a>: Autoprefixer integration for Jekyll</li>
|
|
1401
|
-
<li>
|
|
1402
|
-
<a href="https://github.com/git-no/jekyll-breadcrumbs">Jekyll-breadcrumbs</a>: Creates breadcrumbs for Jekyll 3.x, includes features like SEO optimization, optional breadcrumb item translation and more.</li>
|
|
1403
|
-
<li>
|
|
1404
|
-
<a href="https://github.com/sondr3/generator-jekyllized">generator-jekyllized</a>: A Yeoman generator for rapidly developing sites with Gulp. Live reload your site, automatically minify and optimize your assets and much more.</li>
|
|
1405
|
-
<li>
|
|
1406
|
-
<a href="https://github.com/MertcanGokgoz/Jekyll-Spotify">Jekyll-Spotify</a>: Easily output Spotify Embed Player for jekyll</li>
|
|
1407
|
-
<li>
|
|
1408
|
-
<a href="https://github.com/forestryio/jekyll-menus">jekyll-menus</a>: Hugo style menus for your Jekyll site… recursive menus included.</li>
|
|
1409
|
-
<li>
|
|
1410
|
-
<a href="https://github.com/ashmaroli/jekyll-data">jekyll-data</a>: Read data files within Jekyll Theme Gems.</li>
|
|
1411
|
-
<li>
|
|
1412
|
-
<a href="https://github.com/snaptortoise/jekyll-pinboard-plugin">jekyll-pinboard</a>: Access your Pinboard bookmarks within your Jekyll theme.</li>
|
|
1413
|
-
<li>
|
|
1414
|
-
<a href="https://github.com/mpchadwick/jekyll-migrate-permalink">jekyll-migrate-permalink</a>: Adds a <code class="highlighter-rouge">migrate-permalink</code> sub-command to help deal with side effects of changing your permalink.</li>
|
|
1415
|
-
<li>
|
|
1416
|
-
<a href="https://github.com/robcrocombe/jekyll-post">Jekyll-Post</a>: A CLI tool to easily draft, edit, and publish Jekyll posts.</li>
|
|
1417
|
-
<li>
|
|
1418
|
-
<a href="https://github.com/muratayusuke/jekyll-numbered-headings">jekyll-numbered-headings</a>: Adds ordered number to headings.</li>
|
|
1419
|
-
<li>
|
|
1420
|
-
<a href="https://github.com/mpchadwick/jekyll-pre-commit">jekyll-pre-commit</a>: A framework for running checks against your posts using a git pre-commit hook before you publish them.</li>
|
|
1421
|
-
</ul>
|
|
1422
|
-
|
|
1423
|
-
<div class="note info">
|
|
1424
|
-
<h5>Jekyll Plugins Wanted</h5>
|
|
1425
|
-
<p>
|
|
1426
|
-
If you have a Jekyll plugin that you would like to see added to this list,
|
|
1427
|
-
you should <a href="../contributing/">read the contributing page</a> to find
|
|
1428
|
-
out how to make that happen.
|
|
1429
|
-
</p>
|
|
1430
|
-
</div>
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
<div class="section-nav">
|
|
1504
|
-
<div class="left align-right">
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
<a href="/docs/pagination/" class="prev">Back</a>
|
|
1509
|
-
|
|
1510
|
-
</div>
|
|
1511
|
-
<div class="right align-left">
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
<a href="/docs/themes/" class="next">Next</a>
|
|
1516
|
-
|
|
1517
|
-
</div>
|
|
1518
|
-
</div>
|
|
1519
|
-
<div class="clear"></div>
|
|
1520
|
-
|
|
1521
|
-
</article>
|
|
1522
|
-
</div>
|
|
1523
|
-
|
|
1524
|
-
<div class="unit one-fifth hide-on-mobiles">
|
|
1525
|
-
<aside>
|
|
1526
|
-
|
|
1527
|
-
<h4>Getting Started</h4>
|
|
1528
|
-
<ul>
|
|
1529
|
-
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
<li class=""><a href="/docs/home/">Welcome</a></li>
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
<li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
|
|
1537
|
-
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
<li class=""><a href="/docs/installation/">Installation</a></li>
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
<li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
<li class=""><a href="/docs/usage/">Basic Usage</a></li>
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
<li class=""><a href="/docs/structure/">Directory structure</a></li>
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
<li class=""><a href="/docs/configuration/">Configuration</a></li>
|
|
1557
|
-
|
|
1558
|
-
</ul>
|
|
1559
|
-
|
|
1560
|
-
|
|
1561
|
-
<h4>Your Content</h4>
|
|
1562
|
-
<ul>
|
|
1563
|
-
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
<li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
|
|
1567
|
-
|
|
1568
|
-
|
|
1569
|
-
|
|
1570
|
-
<li class=""><a href="/docs/posts/">Writing posts</a></li>
|
|
1571
|
-
|
|
1572
|
-
|
|
1573
|
-
|
|
1574
|
-
<li class=""><a href="/docs/drafts/">Working with drafts</a></li>
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
|
|
1578
|
-
<li class=""><a href="/docs/pages/">Creating pages</a></li>
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
<li class=""><a href="/docs/static-files/">Static Files</a></li>
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
|
|
1586
|
-
<li class=""><a href="/docs/variables/">Variables</a></li>
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
<li class=""><a href="/docs/collections/">Collections</a></li>
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
<li class=""><a href="/docs/datafiles/">Data Files</a></li>
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
<li class=""><a href="/docs/assets/">Assets</a></li>
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
<li class=""><a href="/docs/migrations/">Blog migrations</a></li>
|
|
1603
|
-
|
|
1604
|
-
</ul>
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
<h4>Customization</h4>
|
|
1608
|
-
<ul>
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
<li class=""><a href="/docs/templates/">Templates</a></li>
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
<li class=""><a href="/docs/includes/">Includes</a></li>
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
<li class=""><a href="/docs/permalinks/">Permalinks</a></li>
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
<li class=""><a href="/docs/pagination/">Pagination</a></li>
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
<li class="current"><a href="/docs/plugins/">Plugins</a></li>
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
<li class=""><a href="/docs/themes/">Themes</a></li>
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
<li class=""><a href="/docs/extras/">Extras</a></li>
|
|
1637
|
-
|
|
1638
|
-
</ul>
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
<h4>Deployment</h4>
|
|
1642
|
-
<ul>
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
<li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
<li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
<li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
|
|
1655
|
-
|
|
1656
|
-
</ul>
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
<h4>Miscellaneous</h4>
|
|
1660
|
-
<ul>
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
<li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
<li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
<li class=""><a href="/docs/resources/">Resources</a></li>
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
<li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
<li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
|
|
1681
|
-
|
|
1682
|
-
</ul>
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
<h4>Meta</h4>
|
|
1686
|
-
<ul>
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
<li class=""><a href="/docs/contributing/">Contributing</a></li>
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
<li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
<li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
<li class=""><a href="/docs/history/">History</a></li>
|
|
1703
|
-
|
|
1704
|
-
</ul>
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
</aside>
|
|
1708
|
-
</div>
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
<div class="clear"></div>
|
|
1712
|
-
|
|
1713
|
-
</div>
|
|
1714
|
-
</section>
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
<footer>
|
|
1718
|
-
<div class="grid">
|
|
1719
|
-
<div class="unit one-third center-on-mobiles">
|
|
1720
|
-
<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>
|
|
1721
|
-
</div>
|
|
1722
|
-
<div class="unit two-thirds align-right center-on-mobiles">
|
|
1723
|
-
<p>
|
|
1724
|
-
Proudly hosted by
|
|
1725
|
-
<a href="https://github.com">
|
|
1726
|
-
<img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
|
|
1727
|
-
</a>
|
|
1728
|
-
</p>
|
|
1729
|
-
</div>
|
|
1730
|
-
</div>
|
|
1731
|
-
</footer>
|
|
1732
|
-
|
|
1733
|
-
<script>
|
|
1734
|
-
var anchorForId = function (id) {
|
|
1735
|
-
var anchor = document.createElement("a");
|
|
1736
|
-
anchor.className = "header-link";
|
|
1737
|
-
anchor.href = "#" + id;
|
|
1738
|
-
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
|
1739
|
-
anchor.title = "Permalink";
|
|
1740
|
-
return anchor;
|
|
1741
|
-
};
|
|
1742
|
-
|
|
1743
|
-
var linkifyAnchors = function (level, containingElement) {
|
|
1744
|
-
var headers = containingElement.getElementsByTagName("h" + level);
|
|
1745
|
-
for (var h = 0; h < headers.length; h++) {
|
|
1746
|
-
var header = headers[h];
|
|
1747
|
-
|
|
1748
|
-
if (typeof header.id !== "undefined" && header.id !== "") {
|
|
1749
|
-
header.appendChild(anchorForId(header.id));
|
|
1750
|
-
}
|
|
1751
|
-
}
|
|
1752
|
-
};
|
|
1753
|
-
|
|
1754
|
-
document.onreadystatechange = function () {
|
|
1755
|
-
if (this.readyState === "complete") {
|
|
1756
|
-
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
|
1757
|
-
if (!contentBlock) {
|
|
1758
|
-
return;
|
|
1759
|
-
}
|
|
1760
|
-
for (var level = 1; level <= 6; level++) {
|
|
1761
|
-
linkifyAnchors(level, contentBlock);
|
|
1762
|
-
}
|
|
1763
|
-
}
|
|
1764
|
-
};
|
|
1765
|
-
</script>
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
<!-- Gauges (http://get.gaug.es/) -->
|
|
1769
|
-
<script>
|
|
1770
|
-
var _gauges = _gauges || [];
|
|
1771
|
-
(function() {
|
|
1772
|
-
var t = document.createElement('script');
|
|
1773
|
-
t.type = 'text/javascript';
|
|
1774
|
-
t.async = true;
|
|
1775
|
-
t.id = 'gauges-tracker';
|
|
1776
|
-
t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
|
|
1777
|
-
t.src = '//secure.gaug.es/track.js';
|
|
1778
|
-
var s = document.getElementsByTagName('script')[0];
|
|
1779
|
-
s.parentNode.insertBefore(t, s);
|
|
1780
|
-
})();
|
|
1781
|
-
</script>
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
<!-- Google Analytics (https://www.google.com/analytics) -->
|
|
1786
|
-
<script>
|
|
1787
|
-
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
|
1788
|
-
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
|
1789
|
-
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
|
1790
|
-
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
|
1791
|
-
|
|
1792
|
-
ga('create', 'UA-50755011-1', 'jekyllrb.com');
|
|
1793
|
-
ga('send', 'pageview');
|
|
1794
|
-
|
|
1795
|
-
</script>
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
</body>
|
|
1800
|
-
</html>
|