jekyll-series-links 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 227d180344b8879c35e383835be6f3d6df525c35234ed1bacf99a03c37ac9647
+  data.tar.gz: bcb720700201224ee5d9c6709bd2db885aa80661a9124e6a28123ca48b585dc8
+SHA512:
+  metadata.gz: 19a459e21007b5d7fa123a2e97fd9d96a80e4ef408611a91cbf5d335ca08cd140fa9c2ed63563040ea3499675c0781fa6cbb9042725e025977b1a996e8d332ea
+  data.tar.gz: '018868b0c27ecab7556f69d410663a13ad2ff82410844ed45ee2d4a3110425322dfc19c24809d5748caa479292ec0357f2c4710894c49770e386a6daac59a187'

data/lib/jekyll/series/generator.rb

@@ -0,0 +1,40 @@
+module Jekyll
+  module Series
+    class Generator < Jekyll::Generator
+      safe true
+      priority :low
+
+      def generate(site)
+        series_groups = {}
+
+        site.posts.docs.each do |post|
+          series_name = post.data["series"]
+          next unless series_name
+
+          series_groups[series_name] ||= []
+          series_groups[series_name] << post
+        end
+
+        series_groups.each do |series_name, posts|
+          sorted = posts.sort_by { |p| [p.data["series_part"]&.to_i || p.date, p.data["title"].to_s] }
+
+          sorted.each_with_index do |p, i|
+            p.data["series_part"] ||= i + 1
+          end
+
+          series_data = sorted.map do |p|
+            {
+              "title" => p.data["title"],
+              "url" => p.url,
+              "part" => p.data["series_part"].to_i
+            }
+          end
+
+          sorted.each do |post|
+            post.data["series_posts"] = series_data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/series/tag.rb

@@ -0,0 +1,53 @@
+module Jekyll
+  module Series
+    class SeriesLinksTag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+      end
+
+      def render(context)
+        site = context.registers[:site]
+        page = context.registers[:page]
+
+        series_posts = page["series_posts"]
+        return "" unless series_posts
+
+        series_name = page["series"]
+        current_url = page["url"]
+
+        include_path = File.join(site.source, "_includes", "series_links.html")
+        if File.exist?(include_path)
+          template = File.read(include_path)
+          context["series_posts"] = series_posts
+          context["series_name"] = series_name
+          Liquid::Template.parse(template).render(context)
+        else
+          render_default(series_name, series_posts, current_url)
+        end
+      end
+
+      private
+
+      def render_default(series_name, series_posts, current_url)
+        items = series_posts.map do |post|
+          if post["url"] == current_url
+            %(<li class="series-nav-item series-nav-current"><strong>Part #{post["part"]}: #{post["title"]}</strong></li>)
+          else
+            %(<li class="series-nav-item"><a href="#{post["url"]}">Part #{post["part"]}: #{post["title"]}</a></li>)
+          end
+        end.join("\n    ")
+
+        <<~HTML
+          <nav class="series-nav">
+            <h4>Series: #{series_name}</h4>
+            <ol>
+              #{items}
+            </ol>
+          </nav>
+        HTML
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("series_links", Jekyll::Series::SeriesLinksTag)

data/lib/jekyll-series-links.rb

@@ -0,0 +1,3 @@
+require "jekyll"
+require "jekyll/series/generator"
+require "jekyll/series/tag"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-series-links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Armand Halbert
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A Jekyll plugin that lets blog posts declare membership in a series via
+  front matter and renders navigation links to all parts.
+email:
+- armand.halbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-series-links.rb
+- lib/jekyll/series/generator.rb
+- lib/jekyll/series/tag.rb
+homepage: https://github.com/ahalbert/jekyll-series-links
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Jekyll plugin for organizing posts into series
+test_files: []