jekyll 2.2.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of jekyll might be problematic. Click here for more details.

Files changed (306) hide show
  1. checksums.yaml +4 -4
  2. data/README.markdown +1 -1
  3. data/lib/jekyll.rb +0 -1
  4. data/lib/jekyll/collection.rb +18 -3
  5. data/lib/jekyll/command.rb +0 -25
  6. data/lib/jekyll/commands/build.rb +7 -2
  7. data/lib/jekyll/commands/help.rb +33 -0
  8. data/lib/jekyll/configuration.rb +36 -28
  9. data/lib/jekyll/converters/markdown/kramdown_parser.rb +1 -1
  10. data/lib/jekyll/convertible.rb +43 -20
  11. data/lib/jekyll/deprecator.rb +15 -8
  12. data/lib/jekyll/document.rb +21 -4
  13. data/lib/jekyll/filters.rb +27 -1
  14. data/lib/jekyll/frontmatter_defaults.rb +46 -12
  15. data/lib/jekyll/plugin.rb +10 -1
  16. data/lib/jekyll/post.rb +6 -13
  17. data/lib/jekyll/related_posts.rb +2 -2
  18. data/lib/jekyll/renderer.rb +7 -2
  19. data/lib/jekyll/site.rb +5 -7
  20. data/lib/jekyll/static_file.rb +24 -4
  21. data/lib/jekyll/tags/include.rb +3 -1
  22. data/lib/jekyll/tags/post_url.rb +2 -2
  23. data/lib/jekyll/utils.rb +88 -69
  24. data/lib/jekyll/version.rb +1 -1
  25. data/lib/site_template/_config.yml +6 -4
  26. data/lib/site_template/_includes/footer.html +43 -49
  27. data/lib/site_template/_includes/head.html +3 -4
  28. data/lib/site_template/_includes/header.html +9 -10
  29. data/lib/site_template/_layouts/default.html +6 -5
  30. data/lib/site_template/_layouts/page.html +3 -3
  31. data/lib/site_template/_layouts/post.html +4 -4
  32. data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +6 -5
  33. data/lib/site_template/_sass/_base.scss +203 -0
  34. data/lib/site_template/_sass/_layout.scss +236 -0
  35. data/lib/site_template/_sass/_syntax-highlighting.scss +67 -0
  36. data/lib/site_template/css/main.scss +49 -0
  37. data/lib/site_template/feed.xml +1 -1
  38. data/lib/site_template/index.html +7 -4
  39. metadata +24 -431
  40. data/.gitignore +0 -15
  41. data/.travis.yml +0 -27
  42. data/CONTRIBUTING.markdown +0 -91
  43. data/Gemfile +0 -2
  44. data/History.markdown +0 -1310
  45. data/Rakefile +0 -268
  46. data/cucumber.yml +0 -3
  47. data/docs/jp/CONTRIBUTING.jp.markdown +0 -93
  48. data/docs/jp/README.jp.markdown +0 -68
  49. data/features/collections.feature +0 -145
  50. data/features/create_sites.feature +0 -158
  51. data/features/data.feature +0 -105
  52. data/features/drafts.feature +0 -46
  53. data/features/embed_filters.feature +0 -107
  54. data/features/frontmatter_defaults.feature +0 -136
  55. data/features/include_tag.feature +0 -68
  56. data/features/markdown.feature +0 -67
  57. data/features/pagination.feature +0 -82
  58. data/features/permalinks.feature +0 -85
  59. data/features/post_data.feature +0 -261
  60. data/features/post_excerpts.feature +0 -50
  61. data/features/rendering.feature +0 -34
  62. data/features/site_configuration.feature +0 -283
  63. data/features/site_data.feature +0 -107
  64. data/features/step_definitions/jekyll_steps.rb +0 -201
  65. data/features/support/env.rb +0 -65
  66. data/jekyll.gemspec +0 -66
  67. data/lib/site_template/css/main.css +0 -410
  68. data/script/bootstrap +0 -4
  69. data/script/branding +0 -11
  70. data/script/cibuild +0 -7
  71. data/script/console +0 -38
  72. data/script/proof +0 -22
  73. data/script/rebund +0 -140
  74. data/script/test +0 -17
  75. data/site/.gitignore +0 -4
  76. data/site/CNAME +0 -1
  77. data/site/README +0 -1
  78. data/site/_config.yml +0 -9
  79. data/site/_data/docs.yml +0 -46
  80. data/site/_includes/analytics.html +0 -30
  81. data/site/_includes/anchor_links.html +0 -32
  82. data/site/_includes/css/font-awesome.css +0 -44
  83. data/site/_includes/css/gridism.css +0 -110
  84. data/site/_includes/css/normalize.css +0 -1
  85. data/site/_includes/css/pygments.css +0 -72
  86. data/site/_includes/css/style.css +0 -1045
  87. data/site/_includes/docs_contents.html +0 -8
  88. data/site/_includes/docs_contents_mobile.html +0 -10
  89. data/site/_includes/docs_option.html +0 -11
  90. data/site/_includes/docs_ul.html +0 -20
  91. data/site/_includes/footer.html +0 -15
  92. data/site/_includes/header.html +0 -18
  93. data/site/_includes/news_contents.html +0 -33
  94. data/site/_includes/news_contents_mobile.html +0 -11
  95. data/site/_includes/news_item.html +0 -24
  96. data/site/_includes/primary-nav-items.html +0 -17
  97. data/site/_includes/section_nav.html +0 -22
  98. data/site/_includes/top.html +0 -17
  99. data/site/_layouts/default.html +0 -13
  100. data/site/_layouts/docs.html +0 -23
  101. data/site/_layouts/news.html +0 -19
  102. data/site/_layouts/news_item.html +0 -27
  103. data/site/_posts/2013-05-06-jekyll-1-0-0-released.markdown +0 -23
  104. data/site/_posts/2013-05-08-jekyll-1-0-1-released.markdown +0 -27
  105. data/site/_posts/2013-05-12-jekyll-1-0-2-released.markdown +0 -28
  106. data/site/_posts/2013-06-07-jekyll-1-0-3-released.markdown +0 -25
  107. data/site/_posts/2013-07-14-jekyll-1-1-0-released.markdown +0 -27
  108. data/site/_posts/2013-07-24-jekyll-1-1-1-released.markdown +0 -31
  109. data/site/_posts/2013-07-25-jekyll-1-0-4-released.markdown +0 -20
  110. data/site/_posts/2013-07-25-jekyll-1-1-2-released.markdown +0 -20
  111. data/site/_posts/2013-09-06-jekyll-1-2-0-released.markdown +0 -23
  112. data/site/_posts/2013-09-14-jekyll-1-2-1-released.markdown +0 -19
  113. data/site/_posts/2013-10-28-jekyll-1-3-0-rc1-released.markdown +0 -19
  114. data/site/_posts/2013-11-04-jekyll-1-3-0-released.markdown +0 -43
  115. data/site/_posts/2013-11-26-jekyll-1-3-1-released.markdown +0 -21
  116. data/site/_posts/2013-12-07-jekyll-1-4-0-released.markdown +0 -30
  117. data/site/_posts/2013-12-09-jekyll-1-4-1-released.markdown +0 -20
  118. data/site/_posts/2013-12-16-jekyll-1-4-2-released.markdown +0 -18
  119. data/site/_posts/2014-01-13-jekyll-1-4-3-released.markdown +0 -26
  120. data/site/_posts/2014-03-24-jekyll-1-5-0-released.markdown +0 -19
  121. data/site/_posts/2014-03-27-jekyll-1-5-1-released.markdown +0 -26
  122. data/site/_posts/2014-05-06-jekyll-turns-2-0-0.markdown +0 -31
  123. data/site/_posts/2014-05-08-jekyll-2-0-3-released.markdown +0 -18
  124. data/site/_posts/2014-06-04-jekyll-stickers-1-dollar-stickermule.markdown +0 -19
  125. data/site/_posts/2014-06-28-jekyll-turns-21-i-mean-2-1-0.markdown +0 -31
  126. data/site/_posts/2014-07-01-jekyll-2-1-1-released.markdown +0 -30
  127. data/site/_posts/2014-07-29-jekyll-2-2-0-released.markdown +0 -19
  128. data/site/css/screen.css +0 -31
  129. data/site/docs/assets.md +0 -66
  130. data/site/docs/collections.md +0 -259
  131. data/site/docs/configuration.md +0 -536
  132. data/site/docs/continuous-integration.md +0 -177
  133. data/site/docs/contributing.md +0 -133
  134. data/site/docs/datafiles.md +0 -108
  135. data/site/docs/deployment-methods.md +0 -127
  136. data/site/docs/drafts.md +0 -21
  137. data/site/docs/extras.md +0 -18
  138. data/site/docs/frontmatter.md +0 -191
  139. data/site/docs/github-pages.md +0 -91
  140. data/site/docs/history.md +0 -1514
  141. data/site/docs/index.md +0 -58
  142. data/site/docs/installation.md +0 -106
  143. data/site/docs/migrations.md +0 -11
  144. data/site/docs/pages.md +0 -86
  145. data/site/docs/pagination.md +0 -212
  146. data/site/docs/permalinks.md +0 -188
  147. data/site/docs/plugins.md +0 -561
  148. data/site/docs/posts.md +0 -211
  149. data/site/docs/quickstart.md +0 -26
  150. data/site/docs/resources.md +0 -43
  151. data/site/docs/sites.md +0 -29
  152. data/site/docs/structure.md +0 -190
  153. data/site/docs/templates.md +0 -376
  154. data/site/docs/troubleshooting.md +0 -147
  155. data/site/docs/upgrading.md +0 -146
  156. data/site/docs/usage.md +0 -74
  157. data/site/docs/variables.md +0 -382
  158. data/site/docs/windows.md +0 -44
  159. data/site/favicon.ico +0 -0
  160. data/site/feed.xml +0 -48
  161. data/site/fonts/FontAwesome.otf +0 -0
  162. data/site/fonts/fontawesome-webfont.eot +0 -0
  163. data/site/fonts/fontawesome-webfont.svg +0 -504
  164. data/site/fonts/fontawesome-webfont.ttf +0 -0
  165. data/site/fonts/fontawesome-webfont.woff +0 -0
  166. data/site/freenode.txt +0 -1
  167. data/site/img/article-footer.png +0 -0
  168. data/site/img/footer-arrow.png +0 -0
  169. data/site/img/footer-logo.png +0 -0
  170. data/site/img/jekyll-sticker.jpg +0 -0
  171. data/site/img/logo-2x.png +0 -0
  172. data/site/img/logo-rss.png +0 -0
  173. data/site/img/octojekyll.png +0 -0
  174. data/site/index.html +0 -90
  175. data/site/js/html5shiv.min.js +0 -4
  176. data/site/js/respond.min.js +0 -5
  177. data/site/news/index.html +0 -10
  178. data/site/news/releases/index.html +0 -10
  179. data/test/fixtures/broken_front_matter1.erb +0 -5
  180. data/test/fixtures/broken_front_matter2.erb +0 -4
  181. data/test/fixtures/broken_front_matter3.erb +0 -7
  182. data/test/fixtures/exploit_front_matter.erb +0 -4
  183. data/test/fixtures/front_matter.erb +0 -4
  184. data/test/helper.rb +0 -80
  185. data/test/source/+/%# +.md +0 -6
  186. data/test/source/+/foo.md +0 -7
  187. data/test/source/.htaccess +0 -8
  188. data/test/source/_config.dev.toml +0 -2
  189. data/test/source/_data/categories/dairy.yaml +0 -6
  190. data/test/source/_data/languages.yml +0 -2
  191. data/test/source/_data/members.json +0 -12
  192. data/test/source/_data/members.yaml +0 -7
  193. data/test/source/_data/products.yml +0 -4
  194. data/test/source/_drafts/draft-properties.text +0 -11
  195. data/test/source/_includes/include.html +0 -1
  196. data/test/source/_includes/params.html +0 -7
  197. data/test/source/_includes/sig.markdown +0 -3
  198. data/test/source/_layouts/default.html +0 -27
  199. data/test/source/_layouts/post/simple.html +0 -1
  200. data/test/source/_layouts/simple.html +0 -1
  201. data/test/source/_methods/_do_not_read_me.md +0 -5
  202. data/test/source/_methods/configuration.md +0 -8
  203. data/test/source/_methods/sanitized_path.md +0 -5
  204. data/test/source/_methods/site/_dont_include_me_either.md +0 -5
  205. data/test/source/_methods/site/generate.md +0 -6
  206. data/test/source/_methods/site/initialize.md +0 -4
  207. data/test/source/_methods/um_hi.md +0 -6
  208. data/test/source/_plugins/dummy.rb +0 -8
  209. data/test/source/_posts/2008-02-02-not-published.textile +0 -8
  210. data/test/source/_posts/2008-02-02-published.textile +0 -8
  211. data/test/source/_posts/2008-10-18-foo-bar.textile +0 -8
  212. data/test/source/_posts/2008-11-21-complex.textile +0 -8
  213. data/test/source/_posts/2008-12-03-permalinked-post.textile +0 -9
  214. data/test/source/_posts/2008-12-13-include.markdown +0 -8
  215. data/test/source/_posts/2009-01-27-array-categories.textile +0 -10
  216. data/test/source/_posts/2009-01-27-categories.textile +0 -7
  217. data/test/source/_posts/2009-01-27-category.textile +0 -7
  218. data/test/source/_posts/2009-01-27-empty-categories.textile +0 -7
  219. data/test/source/_posts/2009-01-27-empty-category.textile +0 -7
  220. data/test/source/_posts/2009-01-27-no-category.textile +0 -6
  221. data/test/source/_posts/2009-03-12-hash-#1.markdown +0 -6
  222. data/test/source/_posts/2009-05-18-empty-tag.textile +0 -6
  223. data/test/source/_posts/2009-05-18-empty-tags.textile +0 -6
  224. data/test/source/_posts/2009-05-18-tag.textile +0 -6
  225. data/test/source/_posts/2009-05-18-tags.textile +0 -9
  226. data/test/source/_posts/2009-06-22-empty-yaml.textile +0 -3
  227. data/test/source/_posts/2009-06-22-no-yaml.textile +0 -1
  228. data/test/source/_posts/2010-01-08-triple-dash.markdown +0 -5
  229. data/test/source/_posts/2010-01-09-date-override.textile +0 -7
  230. data/test/source/_posts/2010-01-09-time-override.textile +0 -7
  231. data/test/source/_posts/2010-01-09-timezone-override.textile +0 -7
  232. data/test/source/_posts/2010-01-16-override-data.textile +0 -4
  233. data/test/source/_posts/2011-04-12-md-extension.md +0 -7
  234. data/test/source/_posts/2011-04-12-text-extension.text +0 -0
  235. data/test/source/_posts/2013-01-02-post-excerpt.markdown +0 -14
  236. data/test/source/_posts/2013-01-12-nil-layout.textile +0 -6
  237. data/test/source/_posts/2013-01-12-no-layout.textile +0 -5
  238. data/test/source/_posts/2013-03-19-not-a-post.markdown/.gitkeep +0 -0
  239. data/test/source/_posts/2013-04-11-custom-excerpt.markdown +0 -10
  240. data/test/source/_posts/2013-05-10-number-category.textile +0 -7
  241. data/test/source/_posts/2013-07-22-post-excerpt-with-layout.markdown +0 -23
  242. data/test/source/_posts/2013-08-01-mkdn-extension.mkdn +0 -0
  243. data/test/source/_posts/2013-12-17-include-variable-filters.markdown +0 -21
  244. data/test/source/_posts/2013-12-20-properties.text +0 -11
  245. data/test/source/_posts/2014-01-06-permalink-traversal.md +0 -5
  246. data/test/source/_posts/2014-03-03-yaml-with-dots.md +0 -5
  247. data/test/source/_posts/2014-03-22-escape-+ %20[].markdown +0 -6
  248. data/test/source/_posts/es/2008-11-21-nested.textile +0 -8
  249. data/test/source/_sass/_grid.scss +0 -1
  250. data/test/source/_slides/example-slide-1.html +0 -4
  251. data/test/source/_slides/example-slide-2.html +0 -7
  252. data/test/source/_slides/example-slide-3.html +0 -5
  253. data/test/source/_with.dots/all.dots/2.4.0.md +0 -5
  254. data/test/source/_with.dots/file.with.dots.md +0 -0
  255. data/test/source/about.html +0 -6
  256. data/test/source/category/_posts/2008-9-23-categories.textile +0 -6
  257. data/test/source/contacts.html +0 -5
  258. data/test/source/contacts/bar.html +0 -5
  259. data/test/source/contacts/index.html +0 -5
  260. data/test/source/css/main.scss +0 -4
  261. data/test/source/css/screen.css +0 -76
  262. data/test/source/deal.with.dots.html +0 -7
  263. data/test/source/environment.html +0 -5
  264. data/test/source/exploit.md +0 -5
  265. data/test/source/foo/_posts/bar/2008-12-12-topical-post.textile +0 -8
  266. data/test/source/index.html +0 -22
  267. data/test/source/js/coffeescript.coffee +0 -10
  268. data/test/source/pgp.key +0 -2
  269. data/test/source/products.yml +0 -4
  270. data/test/source/properties.html +0 -8
  271. data/test/source/sitemap.xml +0 -32
  272. data/test/source/static_files.html +0 -4
  273. data/test/source/symlink-test/symlinked-file +0 -22
  274. data/test/source/unpublished.html +0 -7
  275. data/test/source/win/_posts/2009-05-24-yaml-linebreak.markdown +0 -7
  276. data/test/source/z_category/_posts/2008-9-23-categories.textile +0 -6
  277. data/test/suite.rb +0 -11
  278. data/test/test_cleaner.rb +0 -77
  279. data/test/test_coffeescript.rb +0 -49
  280. data/test/test_collections.rb +0 -224
  281. data/test/test_command.rb +0 -53
  282. data/test/test_configuration.rb +0 -201
  283. data/test/test_convertible.rb +0 -49
  284. data/test/test_document.rb +0 -193
  285. data/test/test_draft.rb +0 -56
  286. data/test/test_entry_filter.rb +0 -124
  287. data/test/test_excerpt.rb +0 -131
  288. data/test/test_filters.rb +0 -207
  289. data/test/test_generated_site.rb +0 -97
  290. data/test/test_kramdown.rb +0 -62
  291. data/test/test_layout_reader.rb +0 -34
  292. data/test/test_liquid_extensions.rb +0 -31
  293. data/test/test_log_adapter.rb +0 -59
  294. data/test/test_new_command.rb +0 -104
  295. data/test/test_page.rb +0 -254
  296. data/test/test_path_sanitization.rb +0 -18
  297. data/test/test_post.rb +0 -741
  298. data/test/test_rdiscount.rb +0 -22
  299. data/test/test_redcarpet.rb +0 -77
  300. data/test/test_redcloth.rb +0 -86
  301. data/test/test_related_posts.rb +0 -47
  302. data/test/test_sass.rb +0 -26
  303. data/test/test_site.rb +0 -452
  304. data/test/test_tags.rb +0 -509
  305. data/test/test_url.rb +0 -28
  306. data/test/test_utils.rb +0 -67
@@ -1,188 +0,0 @@
1
- ---
2
- layout: docs
3
- title: Permalinks
4
- prev_section: templates
5
- next_section: pagination
6
- permalink: /docs/permalinks/
7
- ---
8
-
9
- Jekyll supports a flexible way to build your site’s URLs. You can specify the
10
- permalinks for your site through the [Configuration](../configuration/) or in the
11
- [YAML Front Matter](../frontmatter/) for each post. You’re free to choose one of
12
- the built-in styles to create your links or craft your own. The default style is
13
- `date`.
14
-
15
- Permalinks are constructed by creating a template URL where dynamic elements are
16
- represented by colon-prefixed keywords. For example, the default `date`
17
- permalink is defined as `/:categories/:year/:month/:day/:title.html`.
18
-
19
- ## Template variables
20
-
21
- <div class="mobile-side-scroller">
22
- <table>
23
- <thead>
24
- <tr>
25
- <th>Variable</th>
26
- <th>Description</th>
27
- </tr>
28
- </thead>
29
- <tbody>
30
- <tr>
31
- <td>
32
- <p><code>year</code></p>
33
- </td>
34
- <td>
35
- <p>Year from the Post’s filename</p>
36
- </td>
37
- </tr>
38
- <tr>
39
- <td>
40
- <p><code>month</code></p>
41
- </td>
42
- <td>
43
- <p>Month from the Post’s filename</p>
44
- </td>
45
- </tr>
46
- <tr>
47
- <td>
48
- <p><code>i_month</code></p>
49
- </td>
50
- <td>
51
- <p>Month from the Post’s filename without leading zeros.</p>
52
- </td>
53
- </tr>
54
- <tr>
55
- <td>
56
- <p><code>day</code></p>
57
- </td>
58
- <td>
59
- <p>Day from the Post’s filename</p>
60
- </td>
61
- </tr>
62
- <tr>
63
- <td>
64
- <p><code>i_day</code></p>
65
- </td>
66
- <td>
67
- <p>Day from the Post’s filename without leading zeros.</p>
68
- </td>
69
- </tr>
70
- <tr>
71
- <td>
72
- <p><code>short_year</code></p>
73
- </td>
74
- <td>
75
- <p>Year from the Post’s filename without the century.</p>
76
- </td>
77
- </tr>
78
- <tr>
79
- <td>
80
- <p><code>title</code></p>
81
- </td>
82
- <td>
83
- <p>Title from the Post’s filename</p>
84
- </td>
85
- </tr>
86
- <tr>
87
- <td>
88
- <p><code>categories</code></p>
89
- </td>
90
- <td>
91
- <p>
92
- The specified categories for this Post. Jekyll automatically parses
93
- out double slashes in the URLs, so if no categories are present, it
94
- will ignore this.
95
- </p>
96
- </td>
97
- </tr>
98
- </tbody>
99
- </table>
100
- </div>
101
-
102
- ## Built-in permalink styles
103
-
104
- <div class="mobile-side-scroller">
105
- <table>
106
- <thead>
107
- <tr>
108
- <th>Permalink Style</th>
109
- <th>URL Template</th>
110
- </tr>
111
- </thead>
112
- <tbody>
113
- <tr>
114
- <td>
115
- <p><code>date</code></p>
116
- </td>
117
- <td>
118
- <p><code>/:categories/:year/:month/:day/:title.html</code></p>
119
- </td>
120
- </tr>
121
- <tr>
122
- <td>
123
- <p><code>pretty</code></p>
124
- </td>
125
- <td>
126
- <p><code>/:categories/:year/:month/:day/:title/</code></p>
127
- </td>
128
- </tr>
129
- <tr>
130
- <td>
131
- <p><code>none</code></p>
132
- </td>
133
- <td>
134
- <p><code>/:categories/:title.html</code></p>
135
- </td>
136
- </tr>
137
- </tbody>
138
- </table>
139
- </div>
140
-
141
- ## Permalink style examples
142
-
143
- Given a post named: `/2009-04-29-slap-chop.textile`
144
-
145
- <div class="mobile-side-scroller">
146
- <table>
147
- <thead>
148
- <tr>
149
- <th>URL Template</th>
150
- <th>Resulting Permalink URL</th>
151
- </tr>
152
- </thead>
153
- <tbody>
154
- <tr>
155
- <td>
156
- <p>None specified, or <code>permalink: date</code></p>
157
- </td>
158
- <td>
159
- <p><code>/2009/04/29/slap-chop.html</code></p>
160
- </td>
161
- </tr>
162
- <tr>
163
- <td>
164
- <p><code>pretty</code></p>
165
- </td>
166
- <td>
167
- <p><code>/2009/04/29/slap-chop/index.html</code></p>
168
- </td>
169
- </tr>
170
- <tr>
171
- <td>
172
- <p><code>/:month-:day-:year/:title.html</code></p>
173
- </td>
174
- <td>
175
- <p><code>/04-29-2009/slap-chop.html</code></p>
176
- </td>
177
- </tr>
178
- <tr>
179
- <td>
180
- <p><code>/blog/:year/:month/:day/:title</code></p>
181
- </td>
182
- <td>
183
- <p><code>/blog/2009/04/29/slap-chop/index.html</code></p>
184
- </td>
185
- </tr>
186
- </tbody>
187
- </table>
188
- </div>
@@ -1,561 +0,0 @@
1
- ---
2
- layout: docs
3
- title: Plugins
4
- prev_section: pagination
5
- next_section: extras
6
- permalink: /docs/plugins/
7
- ---
8
-
9
- Jekyll has a plugin system with hooks that allow you to create custom generated
10
- content specific to your site. You can run custom code for your site without
11
- having to modify the Jekyll source itself.
12
-
13
- <div class="note info">
14
- <h5>Plugins on GitHub Pages</h5>
15
- <p>
16
- <a href="http://pages.github.com/">GitHub Pages</a> is powered by Jekyll,
17
- however all Pages sites are generated using the <code>--safe</code> option
18
- to disable custom plugins for security reasons. Unfortunately, this means
19
- your plugins won’t work if you’re deploying to GitHub Pages.<br><br>
20
- You can still use GitHub Pages to publish your site, but you’ll need to
21
- convert the site locally and push the generated static files to your GitHub
22
- repository instead of the Jekyll source files.
23
- </p>
24
- </div>
25
-
26
- ## Installing a plugin
27
-
28
- You have 2 options for installing plugins:
29
-
30
- 1. In your site source root, make a `_plugins` directory. Place your plugins here.
31
- Any file ending in `*.rb` inside this directory will be loaded before Jekyll
32
- generates your site.
33
- 2. In your `_config.yml` file, add a new array with the key `gems` and the values
34
- of the gem names of the plugins you'd like to use. An example:
35
-
36
- gems: [jekyll-test-plugin, jekyll-jsonify, jekyll-assets]
37
- # This will require each of these gems automatically.
38
-
39
- <div class="note info">
40
- <h5>
41
- <code>_plugins</code> and <code>gems</code>
42
- can be used simultaneously
43
- </h5>
44
- <p>
45
- You may use both of the aforementioned plugin options simultaneously in the
46
- same site if you so choose. Use of one does not restrict the use of the other
47
- </p>
48
- </div>
49
-
50
- In general, plugins you make will fall into one of three categories:
51
-
52
- 1. Generators
53
- 2. Converters
54
- 3. Tags
55
-
56
- ## Generators
57
-
58
- You can create a generator when you need Jekyll to create additional content
59
- based on your own rules.
60
-
61
- A generator is a subclass of `Jekyll::Generator` that defines a `generate`
62
- method, which receives an instance of
63
- [`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb).
64
-
65
- Generation is triggered for its side-effects, the return value of `generate` is
66
- ignored. Jekyll does not assume any particular side-effect to happen, it just
67
- runs the method.
68
-
69
- Generators run after Jekyll has made an inventory of the existing content, and
70
- before the site is generated. Pages with YAML front-matters are stored as
71
- instances of
72
- [`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
73
- and are available via `site.pages`. Static files become instances of
74
- [`Jekyll::StaticFile`]({{ site.repository }}/blob/master/lib/jekyll/static_file.rb)
75
- and are available via `site.static_files`. See
76
- [the Variables documentation page](/docs/variables/) and
77
- [`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb)
78
- for more details.
79
-
80
- For instance, a generator can inject values computed at build time for template
81
- variables. In the following example the template `reading.html` has two
82
- variables `ongoing` and `done` that we fill in the generator:
83
-
84
- {% highlight ruby %}
85
- module Reading
86
- class Generator < Jekyll::Generator
87
- def generate(site)
88
- ongoing, done = Book.all.partition(&:ongoing?)
89
-
90
- reading = site.pages.detect {|page| page.name == 'reading.html'}
91
- reading.data['ongoing'] = ongoing
92
- reading.data['done'] = done
93
- end
94
- end
95
- end
96
- {% endhighlight %}
97
-
98
- This is a more complex generator that generates new pages:
99
-
100
- {% highlight ruby %}
101
- module Jekyll
102
-
103
- class CategoryPage < Page
104
- def initialize(site, base, dir, category)
105
- @site = site
106
- @base = base
107
- @dir = dir
108
- @name = 'index.html'
109
-
110
- self.process(@name)
111
- self.read_yaml(File.join(base, '_layouts'), 'category_index.html')
112
- self.data['category'] = category
113
-
114
- category_title_prefix = site.config['category_title_prefix'] || 'Category: '
115
- self.data['title'] = "#{category_title_prefix}#{category}"
116
- end
117
- end
118
-
119
- class CategoryPageGenerator < Generator
120
- safe true
121
-
122
- def generate(site)
123
- if site.layouts.key? 'category_index'
124
- dir = site.config['category_dir'] || 'categories'
125
- site.categories.keys.each do |category|
126
- site.pages << CategoryPage.new(site, site.source, File.join(dir, category), category)
127
- end
128
- end
129
- end
130
- end
131
-
132
- end
133
- {% endhighlight %}
134
-
135
- In this example, our generator will create a series of files under the
136
- `categories` directory for each category, listing the posts in each category
137
- using the `category_index.html` layout.
138
-
139
- Generators are only required to implement one method:
140
-
141
- <div class="mobile-side-scroller">
142
- <table>
143
- <thead>
144
- <tr>
145
- <th>Method</th>
146
- <th>Description</th>
147
- </tr>
148
- </thead>
149
- <tbody>
150
- <tr>
151
- <td>
152
- <p><code>generate</code></p>
153
- </td>
154
- <td>
155
- <p>Generates content as a side-effect.</p>
156
- </td>
157
- </tr>
158
- </tbody>
159
- </table>
160
- </div>
161
-
162
- ## Converters
163
-
164
- If you have a new markup language you’d like to use with your site, you can
165
- include it by implementing your own converter. Both the Markdown and Textile
166
- markup languages are implemented using this method.
167
-
168
- <div class="note info">
169
- <h5>Remember your YAML front-matter</h5>
170
- <p>
171
- Jekyll will only convert files that have a YAML header at the top, even for
172
- converters you add using a plugin.
173
- </p>
174
- </div>
175
-
176
- Below is a converter that will take all posts ending in `.upcase` and process
177
- them using the `UpcaseConverter`:
178
-
179
- {% highlight ruby %}
180
- module Jekyll
181
- class UpcaseConverter < Converter
182
- safe true
183
- priority :low
184
-
185
- def matches(ext)
186
- ext =~ /^\.upcase$/i
187
- end
188
-
189
- def output_ext(ext)
190
- ".html"
191
- end
192
-
193
- def convert(content)
194
- content.upcase
195
- end
196
- end
197
- end
198
- {% endhighlight %}
199
-
200
- Converters should implement at a minimum 3 methods:
201
-
202
- <div class="mobile-side-scroller">
203
- <table>
204
- <thead>
205
- <tr>
206
- <th>Method</th>
207
- <th>Description</th>
208
- </tr>
209
- </thead>
210
- <tbody>
211
- <tr>
212
- <td>
213
- <p><code>matches</code></p>
214
- </td>
215
- <td><p>
216
- Does the given extension match this converter’s list of acceptable
217
- extensions? Takes one argument: the file’s extension (including the
218
- dot). Must return <code>true</code> if it matches, <code>false</code>
219
- otherwise.
220
- </p></td>
221
- </tr>
222
- <tr>
223
- <td>
224
- <p><code>output_ext</code></p>
225
- </td>
226
- <td><p>
227
- The extension to be given to the output file (including the dot).
228
- Usually this will be <code>".html"</code>.
229
- </p></td>
230
- </tr>
231
- <tr>
232
- <td>
233
- <p><code>convert</code></p>
234
- </td>
235
- <td><p>
236
- Logic to do the content conversion. Takes one argument: the raw content
237
- of the file (without YAML front matter). Must return a String.
238
- </p></td>
239
- </tr>
240
- </tbody>
241
- </table>
242
- </div>
243
-
244
- In our example, `UpcaseConverter#matches` checks if our filename extension is
245
- `.upcase`, and will render using the converter if it is. It will call
246
- `UpcaseConverter#convert` to process the content. In our simple converter we’re
247
- simply uppercasing the entire content string. Finally, when it saves the page,
248
- it will do so with a `.html` extension.
249
-
250
- ## Tags
251
-
252
- If you’d like to include custom liquid tags in your site, you can do so by
253
- hooking into the tagging system. Built-in examples added by Jekyll include the
254
- `highlight` and `include` tags. Below is an example of a custom liquid tag that
255
- will output the time the page was rendered:
256
-
257
- {% highlight ruby %}
258
- module Jekyll
259
- class RenderTimeTag < Liquid::Tag
260
-
261
- def initialize(tag_name, text, tokens)
262
- super
263
- @text = text
264
- end
265
-
266
- def render(context)
267
- "#{@text} #{Time.now}"
268
- end
269
- end
270
- end
271
-
272
- Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
273
- {% endhighlight %}
274
-
275
- At a minimum, liquid tags must implement:
276
-
277
- <div class="mobile-side-scroller">
278
- <table>
279
- <thead>
280
- <tr>
281
- <th>Method</th>
282
- <th>Description</th>
283
- </tr>
284
- </thead>
285
- <tbody>
286
- <tr>
287
- <td>
288
- <p><code>render</code></p>
289
- </td>
290
- <td>
291
- <p>Outputs the content of the tag.</p>
292
- </td>
293
- </tr>
294
- </tbody>
295
- </table>
296
- </div>
297
-
298
- You must also register the custom tag with the Liquid template engine as
299
- follows:
300
-
301
- {% highlight ruby %}
302
- Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
303
- {% endhighlight %}
304
-
305
- In the example above, we can place the following tag anywhere in one of our
306
- pages:
307
-
308
- {% highlight ruby %}
309
- {% raw %}
310
- <p>{% render_time page rendered at: %}</p>
311
- {% endraw %}
312
- {% endhighlight %}
313
-
314
- And we would get something like this on the page:
315
-
316
- {% highlight html %}
317
- <p>page rendered at: Tue June 22 23:38:47 –0500 2010</p>
318
- {% endhighlight %}
319
-
320
- ### Liquid filters
321
-
322
- You can add your own filters to the Liquid template system much like you can add
323
- tags above. Filters are simply modules that export their methods to liquid. All
324
- methods will have to take at least one parameter which represents the input of
325
- the filter. The return value will be the output of the filter.
326
-
327
- {% highlight ruby %}
328
- module Jekyll
329
- module AssetFilter
330
- def asset_url(input)
331
- "http://www.example.com/#{input}?#{Time.now.to_i}"
332
- end
333
- end
334
- end
335
-
336
- Liquid::Template.register_filter(Jekyll::AssetFilter)
337
- {% endhighlight %}
338
-
339
- <div class="note">
340
- <h5>ProTip™: Access the site object using Liquid</h5>
341
- <p>
342
- Jekyll lets you access the <code>site</code> object through the
343
- <code>context.registers</code> feature of Liquid at <code>context.registers[:site]</code>. For example, you can
344
- access the global configuration file <code>_config.yml</code> using
345
- <code>context.registers[:site].config</code>.
346
- </p>
347
- </div>
348
-
349
- ### Flags
350
-
351
- There are two flags to be aware of when writing a plugin:
352
-
353
- <div class="mobile-side-scroller">
354
- <table>
355
- <thead>
356
- <tr>
357
- <th>Flag</th>
358
- <th>Description</th>
359
- </tr>
360
- </thead>
361
- <tbody>
362
- <tr>
363
- <td>
364
- <p><code>safe</code></p>
365
- </td>
366
- <td>
367
- <p>
368
- A boolean flag that informs Jekyll whether this plugin may be safely
369
- executed in an environment where arbitrary code execution is not
370
- allowed. This is used by GitHub Pages to determine which core plugins
371
- may be used, and which are unsafe to run. If your plugin does not
372
- allow for arbitrary code, execution, set this to <code>true</code>.
373
- GitHub Pages still won’t load your plugin, but if you submit it for
374
- inclusion in core, it’s best for this to be correct!
375
- </p>
376
- </td>
377
- </tr>
378
- <tr>
379
- <td>
380
- <p><code>priority</code></p>
381
- </td>
382
- <td>
383
- <p>
384
- This flag determines what order the plugin is loaded in. Valid values
385
- are: <code>:lowest</code>, <code>:low</code>, <code>:normal</code>,
386
- <code>:high</code>, and <code>:highest</code>. Highest priority
387
- matches are applied first, lowest priority are applied last.
388
- </p>
389
- </td>
390
- </tr>
391
- </tbody>
392
- </table>
393
- </div>
394
-
395
- To use one of the example plugins above as an illustration, here is how you’d
396
- specify these two flags:
397
-
398
- {% highlight ruby %}
399
- module Jekyll
400
- class UpcaseConverter < Converter
401
- safe true
402
- priority :low
403
- ...
404
- end
405
- end
406
- {% endhighlight %}
407
-
408
- ## Available Plugins
409
-
410
- You can find a few useful plugins at the following locations:
411
-
412
- #### Generators
413
-
414
- - [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
415
- - [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders LESS.js files during generation.
416
- - [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
417
- - [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
418
- - [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
419
- - [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
420
- - [Pageless Redirect Generator by Nick Quinlan](https://github.com/nquinlan/jekyll-pageless-redirects): Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.
421
- - [Projectlist by Frederic Hemberger](https://github.com/fhemberger/jekyll-projectlist): Renders files in a directory as a single page instead of separate posts.
422
- - [RssGenerator by Assaf Gelber](https://github.com/agelber/jekyll-rss): Automatically creates an RSS 2.0 feed from your posts.
423
- - [Monthly archive generator by Shigeya Suzuki](https://github.com/shigeya/jekyll-monthly-archive-plugin): Generator and template which renders monthly archive like MovableType style, based on the work by Ilkka Laukkanen and others above.
424
- - [Category archive generator by Shigeya Suzuki](https://github.com/shigeya/jekyll-category-archive-plugin): Generator and template which renders category archive like MovableType style, based on Monthly archive generator.
425
- - [Emoji for Jekyll](https://github.com/yihangho/emoji-for-jekyll): Seamlessly enable emoji for all posts and pages.
426
- - [Compass integration for Jekyll](https://github.com/mscharley/jekyll-compass): Easily integrate Compass and Sass with your Jekyll website.
427
- - [Pages Directory by Ben Baker-Smith](https://github.com/bbakersmith/jekyll-pages-directory): Defines a `_pages` directory for page files which routes its output relative to the project root.
428
- - [Page Collections by Jeff Kolesky](https://github.com/jeffkole/jekyll-page-collections): Generates collections of pages with functionality that resembles posts.
429
- - [Windows 8.1 Live Tile Generation by Matt Sheehan](https://github.com/sheehamj13/jekyll-live-tiles): Generates Internet Explorer 11 config.xml file and Tile Templates for pinning your site to Windows 8.1.
430
- - [Jekyll::AutolinkEmail by Ivan Tse](https://github.com/ivantsepp/jekyll-autolink_email): Autolink your emails.
431
- - [Jekyll::GitMetadata by Ivan Tse](https://github.com/ivantsepp/jekyll-git_metadata): Expose Git metadata for your templates.
432
-
433
- #### Converters
434
-
435
- - [Jade plugin by John Papandriopoulos](https://github.com/snappylabs/jade-jekyll-plugin): Jade converter for Jekyll.
436
- - [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
437
- - [HAML-Sass Converter by Adam Pearson](https://gist.github.com/481456): Simple HAML-Sass converter for Jekyll. [Fork](https://gist.github.com/528642) by Sam X.
438
- - [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam X’s fork above.
439
- - [LESS Converter by Jason Graham](https://gist.github.com/639920): Convert LESS files to CSS.
440
- - [LESS Converter by Josh Brown](https://gist.github.com/760265): Simple LESS converter.
441
- - [Upcase Converter by Blake Smith](https://gist.github.com/449463): An example Jekyll converter.
442
- - [CoffeeScript Converter by phaer](https://gist.github.com/959938): A [CoffeeScript](http://coffeescript.org) to Javascript converter.
443
- - [Markdown References by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one \_references.md file.
444
- - [Stylus Converter](https://gist.github.com/988201): Convert .styl to .css.
445
- - [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
446
- - [Jekyll-pandoc-plugin](https://github.com/dsanson/jekyll-pandoc-plugin): Use pandoc for rendering markdown.
447
- - [Jekyll-pandoc-multiple-formats](https://github.com/fauno/jekyll-pandoc-multiple-formats) by [edsl](https://github.com/edsl): Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.
448
- - [Transform Layouts](https://gist.github.com/1472645): Allows HAML layouts (you need a HAML Converter plugin for this to work).
449
- - [Org-mode Converter](https://gist.github.com/abhiyerra/7377603): Org-mode converter for Jekyll.
450
- - [Customized Kramdown Converter](https://github.com/mvdbos/kramdown-with-pygments): Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.
451
-
452
- #### Filters
453
-
454
- - [Truncate HTML](https://github.com/MattHall/truncatehtml) by [Matt Hall](http://codebeef.com): A Jekyll filter that truncates HTML while preserving markup structure.
455
- - [Domain Name Filter by Lawrence Woodman](https://github.com/LawrenceWoodman/domain_name-liquid_filter): Filters the input text so that just the domain name is left.
456
- - [Summarize Filter by Mathieu Arnold](https://gist.github.com/731597): Remove markup after a `<div id="extended">` tag.
457
- - [URL encoding by James An](https://gist.github.com/919275): Percent encoding for URIs.
458
- - [JSON Filter](https://gist.github.com/1850654) by [joelverhagen](https://github.com/joelverhagen): Filter that takes input text and outputs it as JSON. Great for rendering JavaScript.
459
- - [i18n_filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb): Liquid filter to use I18n localization.
460
- - [Smilify](https://github.com/SaswatPadhi/jekyll_smilify) by [SaswatPadhi](https://github.com/SaswatPadhi): Convert text emoticons in your content to themeable smiley pics.
461
- - [Read in X Minutes](https://gist.github.com/zachleat/5792681) by [zachleat](https://github.com/zachleat): Estimates the reading time of a string (for blog post content).
462
- - [Jekyll-timeago](https://github.com/markets/jekyll-timeago): Converts a time value to the time ago in words.
463
- - [pluralize](https://github.com/bdesham/pluralize): Easily combine a number and a word into a gramatically-correct amount like “1 minute” or “2 minute**s**”.
464
- - [reading_time](https://github.com/bdesham/reading_time): Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
465
- - [Table of Content Generator](https://github.com/dafi/jekyll-toc-generator): 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.
466
- - [jekyll-humanize](https://github.com/23maverick23/jekyll-humanize): 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).
467
- - [Jekyll-Ordinal](https://github.com/PatrickC8t/Jekyll-Ordinal): Jekyll liquid filter to output a date ordinal such as "st", "nd", "rd", or "th".
468
- - [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
469
-
470
- #### Tags
471
-
472
- - [Asset Path Tag](https://github.com/samrayner/jekyll-asset-path-plugin) by [Sam Rayner](http://www.samrayner.com/): Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.
473
- - [Delicious Plugin by Christian Hellsten](https://github.com/christianhellsten/jekyll-plugins): Fetches and renders bookmarks from delicious.com.
474
- - [Ultraviolet Plugin by Steve Alex](https://gist.github.com/480380): Jekyll tag for the [Ultraviolet](https://github.com/grosser/ultraviolet) code highligher.
475
- - [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Generate a tag cloud that links to tag pages.
476
- - [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Add Git activity inside a list.
477
- - [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
478
- - [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
479
- - [Render Time Tag by Blake Smith](https://gist.github.com/449509): Displays the time a Jekyll page was generated.
480
- - [Status.net/OStatus Tag by phaer](https://gist.github.com/912466): Displays the notices in a given status.net/ostatus feed.
481
- - [Raw Tag by phaer](https://gist.github.com/1020852): Keeps liquid from parsing text betweeen `raw` tags.
482
- - [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using oEmbed.
483
- - [Logarithmic Tag Cloud](https://gist.github.com/2290195): Flexible. Logarithmic distribution. Documentation inline.
484
- - [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
485
- - [FlickrSetTag by Thomas Mango](https://github.com/tsmango/jekyll_flickr_set_tag): Generates image galleries from Flickr sets.
486
- - [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using Twitter’s shortcodes.
487
- - [Jekyll-contentblocks](https://github.com/rustygeldmacher/jekyll-contentblocks): Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
488
- - [Generate YouTube Embed](https://gist.github.com/1805814) by [joelverhagen](https://github.com/joelverhagen): 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.
489
- - [Jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
490
- - [Jsonball](https://gist.github.com/1895282): Reads json files and produces maps for use in Jekyll files.
491
- - [Bibjekyll](https://github.com/pablooliveira/bibjekyll): Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.
492
- - [Jekyll-citation](https://github.com/archome/jekyll-citation): Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).
493
- - [Jekyll Dribbble Set Tag](https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag): Builds Dribbble image galleries from any user.
494
- - [Debbugs](https://gist.github.com/2218470): Allows posting links to Debian BTS easily.
495
- - [Refheap_tag](https://github.com/aburdette/refheap_tag): Liquid tag that allows embedding pastes from [refheap](https://refheap.com).
496
- - [Jekyll-devonly_tag](https://gist.github.com/2403522): A block tag for including markup only during development.
497
- - [JekyllGalleryTag](https://github.com/redwallhp/JekyllGalleryTag) by [redwallhp](https://github.com/redwallhp): Generates thumbnails from a directory of images and displays them in a grid.
498
- - [Youku and Tudou Embed](https://gist.github.com/Yexiaoxing/5891929): Liquid plugin for embedding Youku and Tudou videos.
499
- - [Jekyll-swfobject](https://github.com/sectore/jekyll-swfobject): Liquid plugin for embedding Adobe Flash files (.swf) using [SWFObject](http://code.google.com/p/swfobject/).
500
- - [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](http://picture.responsiveimages.org/) element, polyfilled with Scott Jehl’s [Picturefill](https://github.com/scottjehl/picturefill).
501
- - [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
502
- - [Ditaa Tag](https://github.com/matze/jekyll-ditaa) by [matze](https://github.com/matze): Renders ASCII diagram art into PNG images and inserts a figure tag.
503
- - [Good Include](https://github.com/penibelst/jekyll-good-include) by [Anatol Broder](http://penibelst.de/): Strips newlines and whitespaces from the end of include files before processing.
504
- - [Jekyll Suggested Tweet](https://github.com/davidensinger/jekyll-suggested-tweet) by [David Ensinger](https://github.com/davidensinger/): A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitter’s Web Intents API.
505
- - [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
506
- - [Jekyll Image Encode](https://github.com/GSI/jekyll_image_encode) by [GSI](https://github.com/GSI): Tag that renders base64 codes of images fetched from the web.
507
- - [Jekyll Quick Man](https://github.com/GSI/jekyll_quick_man) by [GSI](https://github.com/GSI): Tag that renders pretty links to man page sources on the internet.
508
- - [jekyll-font-awesome](https://gist.github.com/23maverick23/8532525): Quickly and easily add Font Awesome icons to your posts.
509
- - [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](http://lychee.electerious.com/) albums into a post. For an introduction, see [Jekyll meets Lychee - A Liquid Tag plugin](https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/)
510
- - [Image Set/Gallery Tag](https://github.com/callmeed/jekyll-image-set) by [callmeed](https://github.com/callmeed): Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
511
- - [jekyll_figure](https://github.com/lmullen/jekyll_figure): Generate figures and captions with links to the figure in a variety of formats
512
- - [Jekyll Github Sample Tag](https://github.com/bwillis/jekyll-github-sample): A liquid tag to include a sample of a github repo file in your Jekyll site.
513
- - [Jekyll Project Version Tag](https://github.com/rob-murray/jekyll-version-plugin): A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.
514
- - [Piwigo Gallery](https://github.com/AlessandroLorenzi/piwigo_gallery) by [Alessandro Lorenzi](http://www.alorenzi.eu/): Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag
515
-
516
-
517
- #### Collections
518
-
519
- - [Jekyll Plugins by Recursive Design](http://recursive-design.com/projects/jekyll-plugins/): Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.
520
- - [Company website and blog plugins](https://github.com/flatterline/jekyll-plugins) by Flatterline, a [Ruby on Rails development company](http://flatterline.com/): Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.
521
- - [Jekyll plugins by Aucor](https://github.com/aucor/jekyll-plugins): Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.
522
-
523
- #### Other
524
-
525
- - [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
526
- - [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630): Save posts as drafts.
527
- - [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
528
- - [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
529
- - [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
530
- - [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
531
- - [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
532
- - [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
533
- - [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
534
- - [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
535
- - [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
536
- - [Jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): Bundles and minifies JavaScript and CSS.
537
- - [Jekyll-assets](http://ixti.net/jekyll-assets/) by [ixti](https://github.com/ixti): 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).
538
- - [JAPR](https://github.com/kitsched/japr): Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.
539
- - [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML and JavaScript files on site build.
540
- - [Jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
541
- - [Singlepage-jekyll](https://github.com/JCB-K/singlepage-jekyll) by [JCB-K](https://github.com/JCB-K): Turns Jekyll into a dynamic one-page website.
542
- - [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for builing modern web apps.
543
- - [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
544
- - [jekyll-postfiles](https://github.com/indirect/jekyll-postfiles): Add `_postfiles` directory and {% raw %}`{{ postfile }}`{% endraw %} tag so the files a post refers to will always be right there inside your repo.
545
- - [A layout that compresses HTML](https://github.com/penibelst/jekyll-compress-html) by [Anatol Broder](http://penibelst.de/): Github Pages compatible, configurable way to compress HTML files on site build.
546
- - [Jekyll CO₂](https://github.com/wdenton/jekyll-co2): Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
547
-
548
- #### Editors
549
-
550
- - [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://sublime.wbond.net/packages/Jekyll).
551
- - [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate
552
- new posts and run `jekyll build` all without leaving vim.
553
-
554
- <div class="note info">
555
- <h5>Jekyll Plugins Wanted</h5>
556
- <p>
557
- If you have a Jekyll plugin that you would like to see added to this list,
558
- you should <a href="../contributing/">read the contributing page</a> to find
559
- out how to make that happen.
560
- </p>
561
- </div>