jekyll-toc 0.7.1 → 0.8.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a98fa015f2cd16b45d6ea73f70f520f75270c27e4ca3a79258c817a475c573dc
-  data.tar.gz: a4274d04f1f0fe73d5e02e3f910d91012e21d0bd2911e6af8b78db1850888dfa
+  metadata.gz: d596d99053aad35a05c81278de0edfad519bd76727ff60d9b01b70e71008e987
+  data.tar.gz: 331da3befd626489ff0a39d9d70837abbd902bf8cb17548b219b10e7e24b876a
 SHA512:
-  metadata.gz: 5c4c08e4c22c891df141d3a12c9a2c46127b07b3afadd5a68cdf81d1f59fd9f17b35c8f8013e461f4a466c1a561539f010ec8433104867c2a6d90397ecd61fbd
-  data.tar.gz: b20a95d26d6435f55d874f740f8c4560cc139ae3b44073fe46911f5289fe7cb9b874642554318b7ad7ad6ba4bcd2471e49d3ef97473d554fba32ce22c1d5f99e
+  metadata.gz: ec2c4e4cba02a4205b05249997746a4acab870876e89368b54f601e0082908e42ea3e08098483b3e12b0eb691cbf24a60da81c86db8717525336486d1deb083c
+  data.tar.gz: 577d24958e189a1f69feafb48e8f1a937cfdbb966ba5186773fe693641bd958575145186dc7d5e7d13be26b633437a06146d9c73c179c46ecbc5065568a57e7e

data/README.md

@@ -133,6 +133,26 @@ toc:
 
 The default level range is `<h1>` to `<h6>`.
 
+### Ignore within
+
+It can be configured to ignore elements within a selector:
+
+```yml
+toc:
+  ignore_within: .exclude
+```
+
+```html
+<h1>h1</h1>
+<div class="exclude">
+  <h2>h2</h2>
+  <h3>h3</h3>
+</div>
+<h4>h4</h4>
+```
+
+Which would result in only the `<h1>` & `<h4>` within the example being included in the TOC.
+
 ### CSS Styling
 
 The toc can be modified with CSS. The sample CSS is the following.

data/lib/table_of_contents/parser.rb

@@ -14,7 +14,8 @@ module Jekyll
       def initialize(html, options = {})
         @doc = Nokogiri::HTML::DocumentFragment.parse(html)
         options = generate_option_hash(options)
-        @toc_levels = options['min_level']..options['max_level']
+        @toc_levels = options["min_level"]..options["max_level"]
+        @ignore_within = options["ignore_within"]
         @entries = parse_content
       end
 
@@ -42,6 +43,10 @@ module Jekyll
         entries = []
         headers = Hash.new(0)
 
+        if @ignore_within
+          @doc.css(@ignore_within).remove
+        end
+
         # TODO: Use kramdown auto ids
         @doc.css(toc_headings).reject { |n| n.classes.include?('no_toc') }.each do |node|
           text = node.text

data/lib/version.rb

@@ -1,3 +1,3 @@
 module JekyllToc
-  VERSION = '0.7.1'.freeze
+  VERSION = '0.8.0.beta1'.freeze
 end

data/test/test_various_toc_html.rb

@@ -245,6 +245,42 @@ class TestVariousTocHtml < Minitest::Test
     HTML
     actual = doc.css('ul.section-nav').to_s
 
+    assert_equal(expected, actual)
+  end
+
+TEST_HTML_IGNORE = <<-HTML
+<h1>h1</h1>
+<div class="exclude">
+<h2>h2</h2>
+</div>
+<h3>h3</h3>
+<div class="exclude">
+<h4>h4</h4>
+<h4>h5</h4>
+</div>
+<h6>h6</h6>
+HTML
+
+  def test_nested_toc_with_ignore_within_option
+    parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_IGNORE, { "ignore_within" => '.exclude'})
+    doc = Nokogiri::HTML(parser.toc)
+    expected = <<-HTML
+<ul class="section-nav">
+<li class="toc-entry toc-h1">
+<a href="#h1">h1</a>
+<ul>
+<li class="toc-entry toc-h3">
+<a href="#h3">h3</a>
+<ul>
+<li class="toc-entry toc-h6"><a href="#h6">h6</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+    HTML
+    actual = doc.css('ul.section-nav').to_s
+
     assert_equal(expected, actual)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0.beta1
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-30 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -153,9 +153,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6