jekyll-docs 3.6.0 → 3.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (253) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jekyll.rb +195 -0
  3. data/lib/jekyll/cleaner.rb +110 -0
  4. data/lib/jekyll/collection.rb +230 -0
  5. data/lib/jekyll/command.rb +78 -0
  6. data/lib/jekyll/commands/build.rb +102 -0
  7. data/lib/jekyll/commands/clean.rb +43 -0
  8. data/lib/jekyll/commands/doctor.rb +153 -0
  9. data/lib/jekyll/commands/help.rb +34 -0
  10. data/lib/jekyll/commands/new.rb +156 -0
  11. data/lib/jekyll/commands/new_theme.rb +40 -0
  12. data/lib/jekyll/commands/serve.rb +245 -0
  13. data/lib/jekyll/commands/serve/servlet.rb +62 -0
  14. data/lib/jekyll/configuration.rb +410 -0
  15. data/lib/jekyll/converter.rb +54 -0
  16. data/lib/jekyll/converters/identity.rb +23 -0
  17. data/lib/jekyll/converters/markdown.rb +104 -0
  18. data/lib/jekyll/converters/markdown/kramdown_parser.rb +123 -0
  19. data/lib/jekyll/converters/markdown/rdiscount_parser.rb +35 -0
  20. data/lib/jekyll/converters/markdown/redcarpet_parser.rb +108 -0
  21. data/lib/jekyll/converters/smartypants.rb +36 -0
  22. data/lib/jekyll/convertible.rb +251 -0
  23. data/lib/jekyll/deprecator.rb +52 -0
  24. data/lib/jekyll/document.rb +507 -0
  25. data/lib/jekyll/drops/collection_drop.rb +22 -0
  26. data/lib/jekyll/drops/document_drop.rb +69 -0
  27. data/lib/jekyll/drops/drop.rb +214 -0
  28. data/lib/jekyll/drops/excerpt_drop.rb +15 -0
  29. data/lib/jekyll/drops/jekyll_drop.rb +33 -0
  30. data/lib/jekyll/drops/site_drop.rb +47 -0
  31. data/lib/jekyll/drops/static_file_drop.rb +13 -0
  32. data/lib/jekyll/drops/unified_payload_drop.rb +25 -0
  33. data/lib/jekyll/drops/url_drop.rb +88 -0
  34. data/lib/jekyll/entry_filter.rb +123 -0
  35. data/lib/jekyll/errors.rb +20 -0
  36. data/lib/jekyll/excerpt.rb +126 -0
  37. data/lib/jekyll/external.rb +74 -0
  38. data/lib/jekyll/filters.rb +430 -0
  39. data/lib/jekyll/filters/grouping_filters.rb +65 -0
  40. data/lib/jekyll/filters/url_filters.rb +60 -0
  41. data/lib/jekyll/frontmatter_defaults.rb +197 -0
  42. data/lib/jekyll/generator.rb +5 -0
  43. data/lib/jekyll/hooks.rb +104 -0
  44. data/lib/jekyll/layout.rb +62 -0
  45. data/lib/jekyll/liquid_extensions.rb +24 -0
  46. data/lib/jekyll/liquid_renderer.rb +49 -0
  47. data/lib/jekyll/liquid_renderer/file.rb +56 -0
  48. data/lib/jekyll/liquid_renderer/table.rb +96 -0
  49. data/lib/jekyll/log_adapter.rb +147 -0
  50. data/lib/jekyll/mime.types +825 -0
  51. data/lib/jekyll/page.rb +187 -0
  52. data/lib/jekyll/plugin.rb +98 -0
  53. data/lib/jekyll/plugin_manager.rb +113 -0
  54. data/lib/jekyll/publisher.rb +23 -0
  55. data/lib/jekyll/reader.rb +134 -0
  56. data/lib/jekyll/readers/collection_reader.rb +22 -0
  57. data/lib/jekyll/readers/data_reader.rb +77 -0
  58. data/lib/jekyll/readers/layout_reader.rb +71 -0
  59. data/lib/jekyll/readers/page_reader.rb +25 -0
  60. data/lib/jekyll/readers/post_reader.rb +72 -0
  61. data/lib/jekyll/readers/static_file_reader.rb +25 -0
  62. data/lib/jekyll/readers/theme_assets_reader.rb +49 -0
  63. data/lib/jekyll/regenerator.rb +201 -0
  64. data/lib/jekyll/related_posts.rb +52 -0
  65. data/lib/jekyll/renderer.rb +269 -0
  66. data/lib/jekyll/site.rb +471 -0
  67. data/lib/jekyll/static_file.rb +162 -0
  68. data/lib/jekyll/stevenson.rb +61 -0
  69. data/lib/jekyll/tags/highlight.rb +141 -0
  70. data/lib/jekyll/tags/include.rb +215 -0
  71. data/lib/jekyll/tags/link.rb +37 -0
  72. data/lib/jekyll/tags/post_url.rb +103 -0
  73. data/lib/jekyll/theme.rb +68 -0
  74. data/lib/jekyll/theme_builder.rb +119 -0
  75. data/lib/jekyll/url.rb +161 -0
  76. data/lib/jekyll/utils.rb +337 -0
  77. data/lib/jekyll/utils/ansi.rb +59 -0
  78. data/lib/jekyll/utils/exec.rb +27 -0
  79. data/lib/jekyll/utils/platforms.rb +82 -0
  80. data/lib/jekyll/utils/rouge.rb +21 -0
  81. data/lib/jekyll/utils/win_tz.rb +75 -0
  82. data/lib/jekyll/version.rb +5 -0
  83. data/lib/site_template/404.html +24 -0
  84. data/lib/site_template/_config.yml +43 -0
  85. data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +25 -0
  86. data/lib/site_template/about.md +18 -0
  87. data/lib/site_template/index.md +6 -0
  88. data/lib/theme_template/CODE_OF_CONDUCT.md.erb +74 -0
  89. data/lib/theme_template/Gemfile +4 -0
  90. data/lib/theme_template/LICENSE.txt.erb +21 -0
  91. data/lib/theme_template/README.md.erb +52 -0
  92. data/lib/theme_template/_layouts/default.html +1 -0
  93. data/lib/theme_template/_layouts/page.html +5 -0
  94. data/lib/theme_template/_layouts/post.html +5 -0
  95. data/lib/theme_template/example/_config.yml.erb +1 -0
  96. data/lib/theme_template/example/_post.md +12 -0
  97. data/lib/theme_template/example/index.html +14 -0
  98. data/lib/theme_template/example/style.scss +7 -0
  99. data/lib/theme_template/gitignore.erb +5 -0
  100. data/lib/theme_template/theme.gemspec.erb +19 -0
  101. metadata +103 -156
  102. data/lib/jekyll-docs.rb +0 -31
  103. data/site/404.html +0 -153
  104. data/site/CNAME +0 -1
  105. data/site/community/index.html +0 -299
  106. data/site/conduct/index.html +0 -10
  107. data/site/css/screen.css +0 -1
  108. data/site/docs/assets/index.html +0 -724
  109. data/site/docs/code_of_conduct/index.html +0 -730
  110. data/site/docs/collections/index.html +0 -1097
  111. data/site/docs/conduct/index.html +0 -744
  112. data/site/docs/configuration/index.html +0 -1403
  113. data/site/docs/continuous-integration/buddyworks/index.html +0 -726
  114. data/site/docs/continuous-integration/circleci/index.html +0 -757
  115. data/site/docs/continuous-integration/index.html +0 -681
  116. data/site/docs/continuous-integration/travis-ci/index.html +0 -891
  117. data/site/docs/contributing/index.html +0 -863
  118. data/site/docs/datafiles/index.html +0 -780
  119. data/site/docs/deployment-methods/index.html +0 -875
  120. data/site/docs/drafts/index.html +0 -636
  121. data/site/docs/extras/index.html +0 -689
  122. data/site/docs/frontmatter/index.html +0 -807
  123. data/site/docs/github-pages/index.html +0 -819
  124. data/site/docs/history/index.html +0 -3955
  125. data/site/docs/home/index.html +0 -644
  126. data/site/docs/includes/index.html +0 -800
  127. data/site/docs/index.html +0 -10
  128. data/site/docs/installation/index.html +0 -732
  129. data/site/docs/maintaining/affinity-team-captain/index.html +0 -706
  130. data/site/docs/maintaining/avoiding-burnout/index.html +0 -709
  131. data/site/docs/maintaining/becoming-a-maintainer/index.html +0 -717
  132. data/site/docs/maintaining/index.html +0 -713
  133. data/site/docs/maintaining/merging-a-pull-request/index.html +0 -747
  134. data/site/docs/maintaining/reviewing-a-pull-request/index.html +0 -725
  135. data/site/docs/maintaining/special-labels/index.html +0 -705
  136. data/site/docs/maintaining/triaging-an-issue/index.html +0 -735
  137. data/site/docs/migrations/index.html +0 -647
  138. data/site/docs/pages/index.html +0 -695
  139. data/site/docs/pagination/index.html +0 -870
  140. data/site/docs/permalinks/index.html +0 -1027
  141. data/site/docs/plugins/index.html +0 -1800
  142. data/site/docs/posts/index.html +0 -858
  143. data/site/docs/quickstart/index.html +0 -650
  144. data/site/docs/resources/index.html +0 -769
  145. data/site/docs/sites/index.html +0 -702
  146. data/site/docs/static-files/index.html +0 -720
  147. data/site/docs/structure/index.html +0 -822
  148. data/site/docs/templates/index.html +0 -1208
  149. data/site/docs/themes/index.html +0 -935
  150. data/site/docs/troubleshooting/index.html +0 -893
  151. data/site/docs/upgrading/0-to-2/index.html +0 -826
  152. data/site/docs/upgrading/2-to-3/index.html +0 -824
  153. data/site/docs/upgrading/index.html +0 -693
  154. data/site/docs/usage/index.html +0 -705
  155. data/site/docs/variables/index.html +0 -1048
  156. data/site/docs/windows/index.html +0 -799
  157. data/site/favicon.ico +0 -0
  158. data/site/feed.xml +0 -372
  159. data/site/fonts/FontAwesome.eot +0 -0
  160. data/site/fonts/FontAwesome.svg +0 -12
  161. data/site/fonts/FontAwesome.ttf +0 -0
  162. data/site/fonts/FontAwesome.woff +0 -0
  163. data/site/github.html +0 -10
  164. data/site/help/index.html +0 -244
  165. data/site/icomoon-selection.json +0 -96
  166. data/site/img/article-footer.png +0 -0
  167. data/site/img/footer-arrow.png +0 -0
  168. data/site/img/footer-logo.png +0 -0
  169. data/site/img/jekyll-sticker.jpg +0 -0
  170. data/site/img/jekylllayoutconcept.png +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 -267
  175. data/site/issues.html +0 -10
  176. data/site/js/html5shiv.min.js +0 -4
  177. data/site/js/respond.min.js +0 -5
  178. data/site/latest_version.txt +0 -1
  179. data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +0 -570
  180. data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +0 -570
  181. data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +0 -571
  182. data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +0 -568
  183. data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +0 -570
  184. data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +0 -569
  185. data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +0 -565
  186. data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +0 -565
  187. data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +0 -572
  188. data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +0 -566
  189. data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +0 -564
  190. data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +0 -599
  191. data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +0 -568
  192. data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +0 -583
  193. data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +0 -565
  194. data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +0 -564
  195. data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +0 -573
  196. data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +0 -564
  197. data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +0 -569
  198. data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +0 -585
  199. data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +0 -565
  200. data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +0 -567
  201. data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +0 -582
  202. data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +0 -579
  203. data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +0 -568
  204. data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +0 -588
  205. data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +0 -574
  206. data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +0 -597
  207. data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +0 -575
  208. data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +0 -565
  209. data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +0 -572
  210. data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +0 -567
  211. data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +0 -568
  212. data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +0 -588
  213. data/site/news/2015/02/26/introducing-jekyll-talk/index.html +0 -563
  214. data/site/news/2015/10/26/jekyll-3-0-released/index.html +0 -592
  215. data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +0 -576
  216. data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +0 -566
  217. data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +0 -599
  218. data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +0 -583
  219. data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +0 -578
  220. data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +0 -569
  221. data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +0 -565
  222. data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +0 -571
  223. data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +0 -566
  224. data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +0 -572
  225. data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +0 -576
  226. data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +0 -564
  227. data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +0 -566
  228. data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +0 -567
  229. data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +0 -676
  230. data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +0 -571
  231. data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +0 -566
  232. data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +0 -645
  233. data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +0 -569
  234. data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +0 -592
  235. data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +0 -649
  236. data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +0 -598
  237. data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +0 -594
  238. data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +0 -589
  239. data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +0 -569
  240. data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +0 -573
  241. data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +0 -565
  242. data/site/news/index.html +0 -3609
  243. data/site/news/releases/index.html +0 -3344
  244. data/site/philosophy.html +0 -46
  245. data/site/readme.md +0 -23
  246. data/site/robots.txt +0 -1
  247. data/site/sitemap.xml +0 -485
  248. data/site/tutorials/convert-site-to-jekyll/index.html +0 -793
  249. data/site/tutorials/custom-404-page/index.html +0 -358
  250. data/site/tutorials/home/index.html +0 -323
  251. data/site/tutorials/index.html +0 -10
  252. data/site/tutorials/navigation/index.html +0 -872
  253. data/site/tutorials/orderofinterpretation/index.html +0 -441
@@ -1,870 +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>Pagination | Jekyll • Simple, blog-aware, static sites</title>
15
- <meta property="og:title" content="Pagination">
16
- <meta property="og:locale" content="en_US">
17
- <meta name="description" content="With many websites — especially blogs — it’s very common to break the main listing of posts up into smaller lists and display them over multiple pages. Jekyll offers a pagination plugin, so you can automatically generate the appropriate files and folders you need for paginated listings.">
18
- <meta property="og:description" content="With many websites — especially blogs — it’s very common to break the main listing of posts up into smaller lists and display them over multiple pages. Jekyll offers a pagination plugin, so you can automatically generate the appropriate files and folders you need for paginated listings.">
19
- <link rel="canonical" href="https://jekyllrb.com/docs/pagination/">
20
- <meta property="og:url" content="https://jekyllrb.com/docs/pagination/">
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":"With many websites — especially blogs — it’s very common to break the main listing of posts up into smaller lists and display them over multiple pages. Jekyll offers a pagination plugin, so you can automatically generate the appropriate files and folders you need for paginated listings.","url":"https://jekyllrb.com/docs/pagination/","headline":"Pagination","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/pagination/"},"@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/pagination.md"><i class="fa fa-pencil"></i>  Improve this page</a>
288
- </div>
289
- <h1>Pagination</h1>
290
- <p>With many websites — especially blogs — it’s very common to
291
- break the main listing of posts up into smaller lists and display them over
292
- multiple pages. Jekyll offers a pagination plugin, so you can automatically
293
- generate the appropriate files and folders you need for paginated listings.</p>
294
-
295
- <p>For Jekyll 3, include the <code class="highlighter-rouge">jekyll-paginate</code> plugin in your Gemfile and in
296
- your <code class="highlighter-rouge">_config.yml</code> under <code class="highlighter-rouge">plugins</code>. For Jekyll 2, this is standard.</p>
297
-
298
- <div class="note info">
299
- <h5>Pagination only works within HTML files</h5>
300
- <p>
301
- Pagination does not work from within Markdown or Textile files from
302
- your Jekyll site. Pagination works when called from within the HTML
303
- file, named <code>index.html</code>, which optionally may reside in and
304
- produce pagination from within a subdirectory, via the
305
- <code>paginate_path</code> configuration value.
306
- </p>
307
- </div>
308
-
309
- <h2 id="enable-pagination">Enable pagination</h2>
310
-
311
- <p>To enable pagination for your blog, add a line to the <code class="highlighter-rouge">_config.yml</code> file that
312
- specifies how many items should be displayed per page:</p>
313
-
314
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">paginate</span><span class="pi">:</span> <span class="s">5</span>
315
- </code></pre></div></div>
316
-
317
- <p>The number should be the maximum number of Posts you’d like to be displayed
318
- per-page in the generated site.</p>
319
-
320
- <p>You may also specify the destination of the pagination pages:</p>
321
-
322
- <div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">paginate_path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/blog/page:num/"</span>
323
- </code></pre></div></div>
324
-
325
- <p>This will read in <code class="highlighter-rouge">blog/index.html</code>, send it each pagination page in Liquid as
326
- <code class="highlighter-rouge">paginator</code> and write the output to <code class="highlighter-rouge">blog/page:num/</code>, where <code class="highlighter-rouge">:num</code> is the
327
- pagination page number, starting with <code class="highlighter-rouge">2</code>. If a site has 12 posts and specifies
328
- <code class="highlighter-rouge">paginate: 5</code>, Jekyll will write <code class="highlighter-rouge">blog/index.html</code> with the first 5 posts, <code class="highlighter-rouge">blog/page2/index.html</code> with the next 5 posts
329
- and <code class="highlighter-rouge">blog/page3/index.html</code> with the last 2 posts into the destination
330
- directory.</p>
331
-
332
- <div class="note warning">
333
- <h5>Don't set a permalink</h5>
334
- <p>
335
- Setting a permalink in the front matter of your blog page will cause
336
- pagination to break. Just omit the permalink.
337
- </p>
338
- </div>
339
-
340
- <h2 id="liquid-attributes-available">Liquid Attributes Available</h2>
341
-
342
- <p>The pagination plugin exposes the <code class="highlighter-rouge">paginator</code> liquid object with the following
343
- attributes:</p>
344
-
345
- <div class="mobile-side-scroller">
346
- <table>
347
- <thead>
348
- <tr>
349
- <th>Attribute</th>
350
- <th>Description</th>
351
- </tr>
352
- </thead>
353
- <tbody>
354
- <tr>
355
- <td><p><code>page</code></p></td>
356
- <td><p>current page number</p></td>
357
- </tr>
358
- <tr>
359
- <td><p><code>per_page</code></p></td>
360
- <td><p>number of posts per page</p></td>
361
- </tr>
362
- <tr>
363
- <td><p><code>posts</code></p></td>
364
- <td><p>a list of posts for the current page</p></td>
365
- </tr>
366
- <tr>
367
- <td><p><code>total_posts</code></p></td>
368
- <td><p>total number of posts in the site</p></td>
369
- </tr>
370
- <tr>
371
- <td><p><code>total_pages</code></p></td>
372
- <td><p>number of pagination pages</p></td>
373
- </tr>
374
- <tr>
375
- <td><p><code>previous_page</code></p></td>
376
- <td>
377
- <p>
378
- page number of the previous pagination page,
379
- or <code>nil</code> if no previous page exists
380
- </p>
381
- </td>
382
- </tr>
383
- <tr>
384
- <td><p><code>previous_page_path</code></p></td>
385
- <td>
386
- <p>
387
- path of previous pagination page,
388
- or <code>nil</code> if no previous page exists
389
- </p>
390
- </td>
391
- </tr>
392
- <tr>
393
- <td><p><code>next_page</code></p></td>
394
- <td>
395
- <p>
396
- page number of the next pagination page,
397
- or <code>nil</code> if no subsequent page exists
398
- </p>
399
- </td>
400
- </tr>
401
- <tr>
402
- <td><p><code>next_page_path</code></p></td>
403
- <td>
404
- <p>
405
- path of next pagination page,
406
- or <code>nil</code> if no subsequent page exists
407
- </p>
408
- </td>
409
- </tr>
410
- </tbody>
411
- </table>
412
- </div>
413
-
414
- <div class="note info">
415
- <h5>Pagination does not support tags or categories</h5>
416
- <p>Pagination pages through every post in the <code>posts</code>
417
- variable unless a post has <code>hidden: true</code> in its YAML Front Matter.
418
- It does not currently allow paging over groups of posts linked
419
- by a common tag or category. It cannot include any collection of
420
- documents because it is restricted to posts.</p>
421
- </div>
422
-
423
- <h2 id="render-the-paginated-posts">Render the paginated Posts</h2>
424
-
425
- <p>The next thing you need to do is to actually display your posts in a list using
426
- the <code class="highlighter-rouge">paginator</code> variable that will now be available to you. You’ll probably
427
- want to do this in one of the main pages of your site. Here’s one example of a
428
- simple way of rendering paginated Posts in a HTML file:</p>
429
-
430
- <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
431
- ---
432
- layout: default
433
- title: My Blog
434
- ---
435
-
436
- <span class="c">&lt;!-- This loops through the paginated posts --&gt;</span>
437
- {% for post in paginator.posts %}
438
- <span class="nt">&lt;h1&gt;&lt;a</span> <span class="na">href=</span><span class="s">"{{ post.url }}"</span><span class="nt">&gt;</span>{{ post.title }}<span class="nt">&lt;/a&gt;&lt;/h1&gt;</span>
439
- <span class="nt">&lt;p</span> <span class="na">class=</span><span class="s">"author"</span><span class="nt">&gt;</span>
440
- <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"date"</span><span class="nt">&gt;</span>{{ post.date }}<span class="nt">&lt;/span&gt;</span>
441
- <span class="nt">&lt;/p&gt;</span>
442
- <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">"content"</span><span class="nt">&gt;</span>
443
- {{ post.content }}
444
- <span class="nt">&lt;/div&gt;</span>
445
- {% endfor %}
446
-
447
- <span class="c">&lt;!-- Pagination links --&gt;</span>
448
- <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">"pagination"</span><span class="nt">&gt;</span>
449
- {% if paginator.previous_page %}
450
- <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"{{ paginator.previous_page_path }}"</span> <span class="na">class=</span><span class="s">"previous"</span><span class="nt">&gt;</span>Previous<span class="nt">&lt;/a&gt;</span>
451
- {% else %}
452
- <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"previous"</span><span class="nt">&gt;</span>Previous<span class="nt">&lt;/span&gt;</span>
453
- {% endif %}
454
- <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"page_number "</span><span class="nt">&gt;</span>Page: {{ paginator.page }} of {{ paginator.total_pages }}<span class="nt">&lt;/span&gt;</span>
455
- {% if paginator.next_page %}
456
- <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"{{ paginator.next_page_path }}"</span> <span class="na">class=</span><span class="s">"next"</span><span class="nt">&gt;</span>Next<span class="nt">&lt;/a&gt;</span>
457
- {% else %}
458
- <span class="nt">&lt;span</span> <span class="na">class=</span><span class="s">"next "</span><span class="nt">&gt;</span>Next<span class="nt">&lt;/span&gt;</span>
459
- {% endif %}
460
- <span class="nt">&lt;/div&gt;</span>
461
-
462
- </code></pre></div></div>
463
-
464
- <div class="note warning">
465
- <h5>Beware the page one edge-case</h5>
466
- <p>
467
- Jekyll does not generate a ‘page1’ folder, so the above code will not work
468
- when a <code>/page1</code> link is produced. See below for a way to handle
469
- this if it’s a problem for you.
470
- </p>
471
- </div>
472
-
473
- <p>The following HTML snippet should handle page one, and render a list of each
474
- page with links to all but the current page.</p>
475
-
476
- <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
477
- {% if paginator.total_pages &gt; 1 %}
478
- <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">"pagination"</span><span class="nt">&gt;</span>
479
- {% if paginator.previous_page %}
480
- <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}"</span><span class="nt">&gt;</span><span class="ni">&amp;laquo;</span> Prev<span class="nt">&lt;/a&gt;</span>
481
- {% else %}
482
- <span class="nt">&lt;span&gt;</span><span class="ni">&amp;laquo;</span> Prev<span class="nt">&lt;/span&gt;</span>
483
- {% endif %}
484
-
485
- {% for page in (1..paginator.total_pages) %}
486
- {% if page == paginator.page %}
487
- <span class="nt">&lt;em&gt;</span>{{ page }}<span class="nt">&lt;/em&gt;</span>
488
- {% elsif page == 1 %}
489
- <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}"</span><span class="nt">&gt;</span>{{ page }}<span class="nt">&lt;/a&gt;</span>
490
- {% else %}
491
- <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}"</span><span class="nt">&gt;</span>{{ page }}<span class="nt">&lt;/a&gt;</span>
492
- {% endif %}
493
- {% endfor %}
494
-
495
- {% if paginator.next_page %}
496
- <span class="nt">&lt;a</span> <span class="na">href=</span><span class="s">"{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}"</span><span class="nt">&gt;</span>Next <span class="ni">&amp;raquo;</span><span class="nt">&lt;/a&gt;</span>
497
- {% else %}
498
- <span class="nt">&lt;span&gt;</span>Next <span class="ni">&amp;raquo;</span><span class="nt">&lt;/span&gt;</span>
499
- {% endif %}
500
- <span class="nt">&lt;/div&gt;</span>
501
- {% endif %}
502
-
503
- </code></pre></div></div>
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
-
569
-
570
-
571
-
572
-
573
- <div class="section-nav">
574
- <div class="left align-right">
575
-
576
-
577
-
578
- <a href="/docs/permalinks/" class="prev">Back</a>
579
-
580
- </div>
581
- <div class="right align-left">
582
-
583
-
584
-
585
- <a href="/docs/plugins/" class="next">Next</a>
586
-
587
- </div>
588
- </div>
589
- <div class="clear"></div>
590
-
591
- </article>
592
- </div>
593
-
594
- <div class="unit one-fifth hide-on-mobiles">
595
- <aside>
596
-
597
- <h4>Getting Started</h4>
598
- <ul>
599
-
600
-
601
-
602
- <li class=""><a href="/docs/home/">Welcome</a></li>
603
-
604
-
605
-
606
- <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>
607
-
608
-
609
-
610
- <li class=""><a href="/docs/installation/">Installation</a></li>
611
-
612
-
613
-
614
- <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>
615
-
616
-
617
-
618
- <li class=""><a href="/docs/usage/">Basic Usage</a></li>
619
-
620
-
621
-
622
- <li class=""><a href="/docs/structure/">Directory structure</a></li>
623
-
624
-
625
-
626
- <li class=""><a href="/docs/configuration/">Configuration</a></li>
627
-
628
- </ul>
629
-
630
-
631
- <h4>Your Content</h4>
632
- <ul>
633
-
634
-
635
-
636
- <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>
637
-
638
-
639
-
640
- <li class=""><a href="/docs/posts/">Writing posts</a></li>
641
-
642
-
643
-
644
- <li class=""><a href="/docs/drafts/">Working with drafts</a></li>
645
-
646
-
647
-
648
- <li class=""><a href="/docs/pages/">Creating pages</a></li>
649
-
650
-
651
-
652
- <li class=""><a href="/docs/static-files/">Static Files</a></li>
653
-
654
-
655
-
656
- <li class=""><a href="/docs/variables/">Variables</a></li>
657
-
658
-
659
-
660
- <li class=""><a href="/docs/collections/">Collections</a></li>
661
-
662
-
663
-
664
- <li class=""><a href="/docs/datafiles/">Data Files</a></li>
665
-
666
-
667
-
668
- <li class=""><a href="/docs/assets/">Assets</a></li>
669
-
670
-
671
-
672
- <li class=""><a href="/docs/migrations/">Blog migrations</a></li>
673
-
674
- </ul>
675
-
676
-
677
- <h4>Customization</h4>
678
- <ul>
679
-
680
-
681
-
682
- <li class=""><a href="/docs/templates/">Templates</a></li>
683
-
684
-
685
-
686
- <li class=""><a href="/docs/includes/">Includes</a></li>
687
-
688
-
689
-
690
- <li class=""><a href="/docs/permalinks/">Permalinks</a></li>
691
-
692
-
693
-
694
- <li class="current"><a href="/docs/pagination/">Pagination</a></li>
695
-
696
-
697
-
698
- <li class=""><a href="/docs/plugins/">Plugins</a></li>
699
-
700
-
701
-
702
- <li class=""><a href="/docs/themes/">Themes</a></li>
703
-
704
-
705
-
706
- <li class=""><a href="/docs/extras/">Extras</a></li>
707
-
708
- </ul>
709
-
710
-
711
- <h4>Deployment</h4>
712
- <ul>
713
-
714
-
715
-
716
- <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>
717
-
718
-
719
-
720
- <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>
721
-
722
-
723
-
724
- <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>
725
-
726
- </ul>
727
-
728
-
729
- <h4>Miscellaneous</h4>
730
- <ul>
731
-
732
-
733
-
734
- <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>
735
-
736
-
737
-
738
- <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>
739
-
740
-
741
-
742
- <li class=""><a href="/docs/resources/">Resources</a></li>
743
-
744
-
745
-
746
- <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>
747
-
748
-
749
-
750
- <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>
751
-
752
- </ul>
753
-
754
-
755
- <h4>Meta</h4>
756
- <ul>
757
-
758
-
759
-
760
- <li class=""><a href="/docs/contributing/">Contributing</a></li>
761
-
762
-
763
-
764
- <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>
765
-
766
-
767
-
768
- <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>
769
-
770
-
771
-
772
- <li class=""><a href="/docs/history/">History</a></li>
773
-
774
- </ul>
775
-
776
-
777
- </aside>
778
- </div>
779
-
780
-
781
- <div class="clear"></div>
782
-
783
- </div>
784
- </section>
785
-
786
-
787
- <footer>
788
- <div class="grid">
789
- <div class="unit one-third center-on-mobiles">
790
- <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>
791
- </div>
792
- <div class="unit two-thirds align-right center-on-mobiles">
793
- <p>
794
- Proudly hosted by
795
- <a href="https://github.com">
796
- <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
797
- </a>
798
- </p>
799
- </div>
800
- </div>
801
- </footer>
802
-
803
- <script>
804
- var anchorForId = function (id) {
805
- var anchor = document.createElement("a");
806
- anchor.className = "header-link";
807
- anchor.href = "#" + id;
808
- anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
809
- anchor.title = "Permalink";
810
- return anchor;
811
- };
812
-
813
- var linkifyAnchors = function (level, containingElement) {
814
- var headers = containingElement.getElementsByTagName("h" + level);
815
- for (var h = 0; h < headers.length; h++) {
816
- var header = headers[h];
817
-
818
- if (typeof header.id !== "undefined" && header.id !== "") {
819
- header.appendChild(anchorForId(header.id));
820
- }
821
- }
822
- };
823
-
824
- document.onreadystatechange = function () {
825
- if (this.readyState === "complete") {
826
- var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
827
- if (!contentBlock) {
828
- return;
829
- }
830
- for (var level = 1; level <= 6; level++) {
831
- linkifyAnchors(level, contentBlock);
832
- }
833
- }
834
- };
835
- </script>
836
-
837
-
838
- <!-- Gauges (http://get.gaug.es/) -->
839
- <script>
840
- var _gauges = _gauges || [];
841
- (function() {
842
- var t = document.createElement('script');
843
- t.type = 'text/javascript';
844
- t.async = true;
845
- t.id = 'gauges-tracker';
846
- t.setAttribute('data-site-id', '503c5af6613f5d0f19000027');
847
- t.src = '//secure.gaug.es/track.js';
848
- var s = document.getElementsByTagName('script')[0];
849
- s.parentNode.insertBefore(t, s);
850
- })();
851
- </script>
852
-
853
-
854
-
855
- <!-- Google Analytics (https://www.google.com/analytics) -->
856
- <script>
857
- !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
858
- (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
859
- L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
860
- L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
861
-
862
- ga('create', 'UA-50755011-1', 'jekyllrb.com');
863
- ga('send', 'pageview');
864
-
865
- </script>
866
-
867
-
868
-
869
- </body>
870
- </html>