Merge pull request #53 from bandzoogle/master

Add an `ignore_within` option

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.

lib/table_of_contents/parser.rb

@@ -14,7 +14,8 @@ class Parser
       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 @@ def parse_content
         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

lib/version.rb

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

test/test_various_toc_html.rb

@@ -245,6 +245,42 @@ def test_tags_inside_heading
     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