jekyll-paginate-content 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a368a5ecaaf041db59bbfccf429d4f3f99be19f
-  data.tar.gz: 267e320de472fd9c29ee5f8983a429c6f16ecf55
+  metadata.gz: 072dcff2738413164040b9b5e8cfc4e06f0c0142
+  data.tar.gz: 05172f8814d8cf43d7646a7723ab1c33fceff0ea
 SHA512:
-  metadata.gz: 1fc990bc920130af1e51a4128b95404b535d4124f6ce8516bc96aaf5ee45dc05bff8355ad7a11bc0e2e0e8e008f0116527688074f2b2f908c56f83909632207b
-  data.tar.gz: 49259cc0c9a665344ff637b67530d6e507a5376b401b20f737517be079746988a6428948f40ba91144cb8d6fd922869d07e64871ef69a4f124cbc18eead83327
+  metadata.gz: 7a7d396dd2239d92fead8e728910c2e1049cb7466942372ed9fe1d31f9e76f384adc297f56d250126ca96dc056ccf909e31834f28670997cc4013d8dc5a19d9a
+  data.tar.gz: c9ec011450a938500412da3ce45470c2136b5ba62e806d5569e642257c9cc1b3bac267936a48955fb56a2652cf4ee1c0984234b9c397c5b30fbf24da436a0930

data/README.md

@@ -27,7 +27,9 @@
     + [Overriding and restoring properties](#overriding-and-restoring-properties)
       - [Special values](#special-values)
     + [Default properties](#default-properties)
-    + [Example](#example)
+    + [Example: blog](#example-blog)
+    + [Example: slides/presentation](#example-slidespresentation)
+      - [Last slide](#last-slide)
   * [Pagination trails](#pagination-trails)
     + [Usage](#usage-1)
     + [Page flipper](#page-flipper)
@@ -53,14 +55,7 @@ layout: page
 paginate: true
 ---
 
-{% if paginator.paginated %}
-  <a href="{{ paginator.single_page }}">View as a single page</a>
-{% elsif paginator %}
-  <a href="{{ paginator.first_path }}">View as {{ paginator.total_pages }} pages</a>
-{% endif %}
-
 This shows up at the top of all pages.
-
 <!--page_header-->
 
 This is page 1 of the JPC example.
@@ -70,10 +65,6 @@ This is page 1 of the JPC example.
 <!--page-->
 This is page 2 with a [link] to the first page which works in single or paged view.
 
-{% if paginator.paginated %}
-<p><a href="{{ paginator.next_path }}">Go on to page {{ paginator.next_page }}</a></p>
-{% endif %}
-
 <!--page-->
 This is the last page.
 
@@ -84,11 +75,11 @@ This goes into the bottom of all pages.
 ```
 [Live demo](https://ibrado.org/demos/jpc-3page-manual)
 
-### Automatic, with config overrides and mixed syntax
+### Automatic, with config overrides
 
 ```markdown
 ---
-title: "JPC demo: 3-page auto, mixed syntax"
+title: "JPC demo: 3-page auto"
 layout: page
 paginate: true
 paginate_content:
@@ -97,26 +88,18 @@ paginate_content:
   permalink: /page:numof:max.html
 ---
 
-<h2>Introduction</h2>
+# Introduction
+
 Hello!
 
 ## What did something?
+
 The quick brown fox...
 
-What did it do?
----------------
+## What did it do?
+
 ...jumped over the lazy dog.
 
-<!--page_footer-->
-<div>
-{% if paginator.prev_section %}
-  &laquo; <a href="{{ paginator.prev_path }}">{{ paginator.prev_section }}</a>
-{% endif %}
-{% if paginator.prev_section and paginator.next_section %} | {% endif %}
-{% if paginator.next_section %}
-  <a href="{{ paginator.next_path }}">{{ paginator.next_section }}</a> &raquo;
-{% endif %}
-</div>
 ```
 
 [Live demo](https://ibrado.org/demos/jpc-3page-auto)
@@ -127,12 +110,14 @@ See other [demos](#demos).
 
 1. You want to split long posts and pages/articles/reviews, etc. into multiple pages, e.g. chapters;
 1. You want to offer faster loading times to your readers;
-1. You want to make slide/presentation-type content;
+1. You want to make slide/presentation-type content (see [demo](https://ibrado.org/jpc/slides/)!)
 1. You want more ad revenue from your Jekyll site;
 1. You wanna be the cool kid. :stuck_out_tongue:
 
 ## What's new?
 
+v1.1.0 Layout overrides for e.g. slides; regenerate and other fixes
+
 v1.0.4 Allow inclusion in `_config.yml` plugins
 
 v1.0.3 Bugfixes; force option
@@ -400,7 +385,6 @@ These properties/fields are available to your layouts and content via the `pagin
 | `page`               | `page_num`      | Current page number                 |
 | `page_path`          |                 | Path to the current page            |
 | `page_trail`         |                 | Page trail, see [below](#pagination-trails)    |
-| `paginated`          | `activated`     | `true` if this is a partial page    |
 | `total_pages`        | `pages`         | Total number of pages               |
 |                      |                 |                                     |
 | `single_page`        | `view_all`      | Path to the original/full page      |
@@ -408,9 +392,11 @@ These properties/fields are available to your layouts and content via the `pagin
 | `toc`                |                 | Table Of Contents generator, see [below](#table-of-contents-toc)
 |                      |                 |                                     |
 | `section`            |                 | Text of the first header (&lt;h1&gt; etc.) on this page
+| `section_id`         |                 | The header id (`<a name>`) of this section
 | `previous_section`   | `prev_section`  | Ditto for the previous page         |
 | `next_section`       |                 | Ditto for the next page             |
 |                      |                 |                                     |
+| `paginated`          | `activated`     | `true` if this is a partial page    |
 | `has_next`           |                 | `true` if there is a next page      |
 | `has_previous`       | `has_prev`      | `true` if there is a previous page  |
 | `is_first`           |                 | `true` if this is the first page    |
@@ -476,7 +462,7 @@ paginate_content:
 
 In your layout, you'd use something like
 
-```html
+```liquid
 {% if post.comments %}
    <!-- Disqus section -->
 {% endif %}
@@ -486,7 +472,7 @@ The single-page view would then show the [Disqus](https://disqus.com/) comments
 
 ### Overriding and restoring properties
 
-You can set almost any front-matter property via the `properties` section, except for `title`, `layout`, `date`, `permalink`, and `pagination_info`. Use with caution.
+You can set almost any front-matter property via the `properties` section, except for `title`, `date`, `permalink`, and `pagination_info`. Use with caution.
 
 #### Special values
 
@@ -541,7 +527,7 @@ For reference, the default properties effectively map out to:
         type: 'single'
 ```
 
-### Example
+### Example: blog
 
 The author's `_config.yml` has the following:
 
@@ -576,7 +562,7 @@ The author's `_config.yml` has the following:
 
 `x_title` saves the original title for use in social media sharing. The example below also does something similar for the URL to be shared:
 
-```
+```liquid
 {% if page.x_title %}
   {% assign share_title = page.x_title %}
 {% else %}
@@ -590,6 +576,52 @@ The author's `_config.yml` has the following:
 {% endif %}
 ```
 
+### Example: slides/presentation
+
+JPC can be used to generate slides as well as a detailed document from the same source Markdown, i.e.
+
+```liquid
+{% if paginator.paginated %}
+  // Content that only shows up in the slides
+{% else %}
+  // Content that only shows up in the single/details page.
+{% endif %}
+```
+
+Or alternatively,
+
+```liquid
+{% if paginator.paginated %}
+  // Content that only shows up in the slides
+{% endif %}
+```
+
+and
+
+```liquid
+{% unless paginator.paginated %}
+  // Content that only shows up in the single/details page.
+{% endif %}
+```
+
+Here's an example configuration:
+
+```yaml
+  properties:
+    all:
+      layout: slides
+    single:
+      layout: $
+```
+
+This makes all pages except the single-page view use the `slides` layout. The latter will use the original layout.
+
+#### Last slide
+
+When using JPC to generate slides, you may use `_last_` as the title for the last slide (usually a "thank you" or contact info slide). It will be removed and hidden from the TOC.
+
+The [demos](#demos) include a sample presentation.
+
 ## Pagination trails
 
 You use `paginator.page_trail` to create a pager that will allow your readers to move from page to page. It is set up as follows:
@@ -628,7 +660,7 @@ Let's say your document has 7 pages, and you have a `trail` as above. The pager
 
 Here is an example adapted from [JPv2's documentation](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#creating-pagination-trails). Note that you don't need to prepend `site.baseurl` to `trail.path` as it is automatically added in by JPC [by default](#sitebaseurl).
 
-```html
+```liquid
 {% if paginator.page_trail %}
   <ul class="pager">
   {% for trail in paginator.page_trail %}
@@ -658,7 +690,7 @@ You'll end up with something like this, for page 4:
 
 The author's own pager is a little more involved and uses some convenience fields and aliases:
 
-```html
+```liquid
 {% if paginator.page_trail %}
   <div class="pager">
     {% if paginator.is_first %}
@@ -702,7 +734,7 @@ This results in a pager that looks like this:
 
 You may also want to add a page "flipper" that uses section names:
 
-```html
+```liquid
 <!--page_footer-->
 <div>
   {% if paginator.previous_section %}
@@ -717,7 +749,7 @@ You may also want to add a page "flipper" that uses section names:
 
 Should there be no available section name, "Untitled" will be returned. You can then handle it like so:
 
-```html
+```liquid
 {% if paginator.previous_section == "Untitled" %}
   Previous
 {% else %}
@@ -727,7 +759,7 @@ Should there be no available section name, "Untitled" will be returned. You can
 
 Of course, you always have the option of adding some navigational cues to your content:
 
-```html
+```liquid
 {% if paginator.paginated %}
   <a href="{{ paginator.next_page_path }}">On to the next chapter...</a>
 {% endif %}
@@ -739,13 +771,13 @@ This text will not appear in the single-page view.
 
 JPC automatically generates a Table of Contents for you. To use this from within your content, simply insert the following:
 
-```
+```liquid
   {{ paginator.toc.simple }}
 ```
 
 If you want to use this from an HTML layout, e.g. an included `sidebar.html`:
 
-```
+```liquid
   {{ paginator.toc.simple | markdownify }}
 ```
 
@@ -793,7 +825,7 @@ Now that your site features split pages (*finally!*), how do you optimize it for
 
 You could simply add the following somewhere inside the <tt>&lt;head&gt;</tt> of your document:
 
-```
+```liquid
 {{ paginator.seo.links }}
 ```
 
@@ -811,7 +843,7 @@ It will produce up to three lines, like so (assuming you are on page 5):
 
 It would be better to use the following approach, though:
 
-```html
+```liquid
 {% unless paginator %}
   <link rel="canonical" href="{{ site.canonical }}{{ site.baseurl }}{{ page.url }}" />
 {% endunless %}
@@ -836,6 +868,7 @@ What about `canonical` for JPv2-generated pages? Unless you have a "view-all" pa
 1. TL;DR demos: [manual](https://ibrado.org/demos/jpc-3page-manual/), [automatic](https://ibrado.org/demos/jpc-3page-auto/)
 1. Simple example as a [post](https://ibrado.org/2017/12/jpc-demo-post/), as an item in a [collection](https://ibrado.org/demos/jpc/), and as a [page](https://ibrado.org/jpc-demo/).
 1. [This README](https://ibrado.org/jpc/readme/), autopaginated
+1. [Simple Slides in Jekyll](https://ibrado.org/jpc/slides/)
 
 ## Limitations
 

data/example/.gitignore

@@ -0,0 +1,3 @@
+_site
+.sass-cache
+.jekyll-metadata

data/example/404.html

@@ -0,0 +1,24 @@
+---
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/example/Gemfile

@@ -0,0 +1,28 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 3.6.2"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+  gem "jekyll-paginate-content"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+

data/example/_config.yml

@@ -0,0 +1,54 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: "Jekyll::Paginate::Content"
+email: jekyll@ibrado.org
+description: >- # this means to ignore newlines until "baseurl:"
+  Split your Jekyll pages, posts, etc. into multiple pages
+  automatically. Single-page view, pager, SEO support, self-adjusting links,
+  multipage-aware Table Of Contents, more.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: ibrado
+github_username:  ibrado
+
+# Build settings
+markdown: kramdown
+theme: minima
+plugins:
+  - jekyll-feed
+  - jekyll-paginate-content
+
+collections:
+  demos:
+    output: true
+    permalink: /demos/:path/
+
+paginate_content:
+  debug: true
+  collections: pages, posts, demos
+
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+# exclude:
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

data/example/_demos/jpc-3page-auto.md

@@ -0,0 +1,19 @@
+---
+title: "JPC demo: 3-page auto, mixed syntax"
+layout: page
+paginate_content:
+  separator: h2
+  title: ":title :num/:max"
+  permalink: /page:numof:max.html 
+---
+
+<h2>Introduction</h2>
+Hello!
+
+## What did something?
+The quick brown fox...
+
+What did it do?
+---------------
+...jumped over the lazy dog.
+

data/example/_includes/header.html

@@ -0,0 +1,34 @@
+<header class="site-header" role="banner">
+
+  <div class="wrapper">
+    {% assign default_paths = site.pages | map: "path" %}
+    {% assign page_paths = site.header_pages | default: default_paths %}
+    <a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
+
+    {% if page_paths %}
+      <nav class="site-nav">
+        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+        <label for="nav-trigger">
+          <span class="menu-icon">
+            <svg viewBox="0 0 18 15" width="18px" height="15px">
+              <path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
+              <path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
+              <path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
+            </svg>
+          </span>
+        </label>
+
+        {% assign page_paths = page_paths | uniq %}
+
+        <div class="trigger">
+          {% for path in page_paths %}
+            {% assign my_page = site.pages | where: "path", path | first %}
+            {% if my_page.title %}
+            <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            {% endif %}
+          {% endfor %}
+        </div>
+      </nav>
+    {% endif %}
+  </div>
+</header>