jekyll-toc 0.8.0 → 0.9.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4467af27a06bb26975169fc6b483ac6b9cf7dc193d957a4d1802018f3e538ea9
-  data.tar.gz: 78d9f36a92f6d5329476fe348cbbcae64bf5174762934324a093e65a24d19aee
+  metadata.gz: e065b97dcb3e794963823391777d7f7b18858c3bf40ee47a9266f695c2306cb5
+  data.tar.gz: f2be7aea0ba994d5aa8348f37c0d85080dcd9aebfa7d2e8ec9e1611802efacf7
 SHA512:
-  metadata.gz: 5a3b28995adb47063335b775d389472b0b1584fde3818b134e76792da6e20c7bfe4a86ef2afe1b038c3f8de8128d92d87e6f14a816fef5dacc58fe13f76c1982
-  data.tar.gz: 8e27495a54ea17a012e3027464bee31a26e954d91fdb7a0e807c5b13f99baeb29c1461a2f9aea8de2fa966a4e041b3a7897e1f1c0e4c22ecb44c9db312bf0b19
+  metadata.gz: 14af1dc403067ef8ce268acbdb7f6a8af5712be0f8d59f77736dfd46ff31607c5073595c5d984c336022202f41e62c8d72128e9a86865c6d80092026ae06008a
+  data.tar.gz: e396d673df7bad05f79cf218b49ab690e275b3ec943821c5b7e65387f7ac3c8226bee0cc13555cbbead5bf7f8d9685ea4d41559c49a77e96d1987b77d16a0018

data/README.md

@@ -154,6 +154,20 @@ toc:
   max_level: 5 # default: 6
 ```
 
+You can apply custom CSS classes to the generated `<ul>` and `<li>` tags.
+
+```yml
+toc:
+  # Default is "section-nav":
+  list_class: my-list-class
+  # Default is no class for sublists:
+  sublist_class: my-sublist-class
+  # Default is "toc-entry":
+  item_class: my-item-class
+  # Default is "toc-":
+  item_prefix: item-
+```
+
 The default level range is `<h1>` to `<h6>`.
 
 #### CSS Styling

data/lib/table_of_contents/parser.rb

@@ -10,7 +10,11 @@ module Jekyll
       DEFAULT_CONFIG = {
         'no_toc_section_class' => 'no_toc_section',
         'min_level' => 1,
-        'max_level' => 6
+        'max_level' => 6,
+        "list_class" => "section-nav",
+        "sublist_class" => "",
+        "item_class" => "toc-entry",
+        "item_prefix" => "toc-"
       }.freeze
 
       def initialize(html, options = {})
@@ -18,6 +22,10 @@ module Jekyll
         options = generate_option_hash(options)
         @toc_levels = options['min_level']..options['max_level']
         @no_toc_section_class = options['no_toc_section_class']
+        @list_class = options["list_class"]
+        @sublist_class = options["sublist_class"]
+        @item_class = options["item_class"]
+        @item_prefix = options["item_prefix"]
         @entries = parse_content
       end
 
@@ -26,7 +34,7 @@ module Jekyll
       end
 
       def build_toc
-        %(<ul class="section-nav">\n#{build_toc_list(@entries)}</ul>)
+        %(<ul class="#{@list_class}">\n#{build_toc_list(@entries)}</ul>)
       end
 
       def inject_anchors_into_html
@@ -77,15 +85,16 @@ module Jekyll
 
         while i < entries.count
           entry = entries[i]
+          ul_attributes = @sublist_class.empty? ? "" : %( class="#{@sublist_class}")
           if entry[:h_num] == min_h_num
             # If the current entry should not be indented in the list, add the entry to the list
-            toc_list << %(<li class="toc-entry toc-#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a>)
+            toc_list << %(<li class="#{@item_class} #{@item_prefix}#{entry[:node_name]}"><a href="##{entry[:id]}#{entry[:uniq]}">#{entry[:text]}</a>)
             # If the next entry should be indented in the list, generate a sublist
             if i + 1 < entries.count
               next_entry = entries[i + 1]
               if next_entry[:h_num] > min_h_num
                 nest_entries = get_nest_entries(entries[i + 1, entries.count], min_h_num)
-                toc_list << %(\n<ul>\n#{build_toc_list(nest_entries)}</ul>\n)
+                toc_list << %(\n<ul#{ul_attributes}>\n#{build_toc_list(nest_entries)}</ul>\n)
                 i += nest_entries.count
               end
             end

data/lib/version.rb

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

data/test/test_various_toc_html.rb

@@ -353,3 +353,25 @@ class TestVariousTocHtml < Minitest::Test
     assert_includes(html, %(<a id="third" class="anchor" href="#third" aria-hidden="true">))
   end
 end
+
+def test_custom_css_classes
+  parser = Jekyll::TableOfContents::Parser.new(TEST_HTML_1, { "item_class" => "custom-item", "list_class" => "custom-list", "sublist_class" => "custom-sublist", "item_prefix" => "custom-prefix-" })
+  doc = Nokogiri::HTML(parser.toc)
+  expected = <<-HTML
+<ul class="custom-list">
+<li class="custom-item custom-prefix-h1">
+<a href="#h1">h1</a>
+<ul class="custom-sublist">
+<li class="custom-item custom-prefix-h3">
+<a href="#h3">h3</a>
+<ul class="custom-sublist">
+<li class="custom-item custom-prefix-h6"><a href="#h6">h6</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+  HTML
+
+  assert_equal(expected, doc.css('ul.custom-list').to_s)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0.beta1
 platform: ruby
 authors:
 - toshimaru
@@ -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