pro_generate_toc 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83cc3e4482e272e458314b0cae3cd6ae40a4e73498a5bff1cecb587dfb2b9023
-  data.tar.gz: 5ed5dea8383d01e8f4361ce26c82470fcf472c020f1fefc7e0c0508909908b90
+  metadata.gz: ae3bd0311b08f8cc00fafc299213869f54624c6f98f96c2924f7e7c134f486ce
+  data.tar.gz: 38bbadd318cfc80b043d56daea283bb447e1c6c1b6fb7fb0228800a3d037115e
 SHA512:
-  metadata.gz: 3847e92f9f9a148afb055dd476f00d01c27d3650ee7ec0f81cd4ab062520c384a87b43121317c5694a03c15681060fc17a52b44b9ebebeefb1747d2d118d499b
-  data.tar.gz: bbf73de4b1fa4ed2f0fcf55acee7f57cbb4929399a5648ac9f04c5e23839b2227548d3568e282e7556c28f79a2e0959f470f546604e79e50d66721a07c5f52cc
+  metadata.gz: f95e0729456a884c45723e438e606321960a206e196b2932df2dc942fd442f42cf745fed689e782ac8e4aa6c25934b42157e7ac2b13578e16051abed2e4939f1
+  data.tar.gz: 7cbfe614cac202e8ad03c72a6e88128e097596e7027c9a9caf0703d18cf21a2755cf4f2305ba6e3468d72dd96fbfbaab1fbebd55908b545eab511bc99165c3f0

data/README.md

@@ -0,0 +1 @@
+# pro_generate_toc

data/lib/pro_generate_toc.rb

@@ -0,0 +1,108 @@
+require 'nokogiri'
+
+module Jekyll
+    class RenderTocPro < Liquid::Tag
+        def initialize(tag_name, input, tokens)
+              super
+        end
+        def render(context)
+          @doc = Nokogiri::HTML::DocumentFragment.parse(context.registers[:page]['content'])
+
+          %(<ul id="pro-sidebar" class="js-scroll-nav list-group">\n#{Parser.new(@doc).build_toc_list}</ul>)
+        end
+    end
+  module TableOfContentsFilter
+      def pro_toc(html)
+          @doc = Nokogiri::HTML::DocumentFragment.parse(html)
+
+          %(<ul id="pro-sidebar" class="js-scroll-nav list-group">\n#{Parser.new(@doc).build_toc_list}</ul>)
+      end
+  end
+  class Parser
+    def initialize(html, options = {})
+          @doc = Nokogiri::HTML::DocumentFragment.parse(html)
+          @entries = parse_content
+    end
+    def parse_content
+      headers = Hash.new(0)
+
+      (@doc.css(toc_headings) - @doc.css(toc_headings_within))
+        .reject { |n| n.classes.include?('no_toc_section') }
+        .inject([]) do |entries, node|
+        text = node.text
+        id = node.attribute('id') || 'ryan-id'
+
+        suffix_num = headers[id]
+        headers[id] += 1
+
+        entries << {
+          id: suffix_num.zero? ? id : "#{id}-#{suffix_num}",
+          text: CGI.escapeHTML(text),
+          node_name: node.name,
+          header_content: node.children.first,
+          h_num: node.name.delete('h').to_i
+        }
+      end
+    end
+
+    def toc_headings
+        @toc_levels = 2..2
+        @toc_levels.map { |level| "h#{level}" }.join(',')
+    end
+
+    def toc_headings_within
+        @toc_levels = 2..2
+        @toc_levels.map { |level| ".no_toc_section h#{level}" }.join(',')
+    end
+
+    def build_toc_list
+      entries = @entries;
+      i = 0
+      limit = 3
+      hasToggle = 0
+      toc_list = +''
+      min_h_num = @entries.map { |e| e[:h_num] }.min
+
+      while i < entries.count
+        entry = entries[i]
+        if entry[:h_num] == min_h_num
+          next_i = i + 1
+          if next_i <= limit
+              toc_list << %(<li><a href="#" class="js-go-to" data-target="##{entry[:id]}">#{next_i}. #{entry[:text]}</a>)
+
+              if next_i < entries.count && entries[next_i][:h_num] > min_h_num
+                nest_entries = get_nest_entries(entries[next_i, entries.count], min_h_num)
+                toc_list << %(\n<ul id="pro-sidebar-sub" class="js-scroll-nav list-group">\n#{build_toc_list(nest_entries)}</ul>\n)
+                i += nest_entries.count
+              end
+          else
+            hasToggle += 1
+            toc_list << %(<li id="sidebar-collapse" class="collapse"><a href="#" class="js-go-to" data-target="##{entry[:id]}">#{next_i}. #{entry[:text]}</a>)
+          end
+
+          toc_list << %(</li>\n)
+        elsif entry[:h_num] > min_h_num
+          nest_entries = get_nest_entries(entries[i, entries.count], min_h_num)
+          toc_list << build_toc_list(nest_entries)
+          i += nest_entries.count - 1
+        end
+        i += 1
+      end
+      if hasToggle > 0
+         toc_list << %(<div id="blog-sidebar-loadmore" data-toggle="collapse" data-target="#sidebar-collapse" aria-expanded="false" aria-controls="sidebar-collapse" style="text-align: center; cursor: pointer; color: #407bff"><i class="fa"></i></div>)
+      end
+      toc_list
+    end
+
+    def get_nest_entries(entries, min_h_num)
+        entries.inject([]) do |nest_entries, entry|
+          break nest_entries if entry[:h_num] == min_h_num
+
+          nest_entries << entry
+        end
+      end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::TableOfContentsFilter)
+Liquid::Template.register_tag('render_toc', Jekyll::RenderTocPro)

data/pro_generate_toc.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'pro_generate_toc'
+  spec.version       = '1.0.2'
+  spec.summary       = 'Jekyll Table of Contents plugin'
+  spec.description   = 'Jekyll (Ruby static website generator) plugin which generates a Table of Contents for the page.'
+  spec.authors       = %w[Ryan]
+  spec.email         = 'sonnb@mageplaza.com'
+  spec.homepage      = 'https://mageplaza.com'
+  spec.license       = 'Ryan'
+  spec.require_paths = ['lib']
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+   spec.files         = `git ls-files -z`.split("\x0")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pro_generate_toc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Ryan
@@ -16,7 +16,10 @@ email: sonnb@mageplaza.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- README.md
+- lib/pro_generate_toc.rb
+- pro_generate_toc.gemspec
 homepage: https://mageplaza.com
 licenses:
 - Ryan