jekyll-toc 0.14.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc8236ac8c5ff74ef8f7f23fc8b2b2fedbf94cb238a2c20783256d4ca8523909
-  data.tar.gz: 8b92259b9e2f5345b58ff472a7232121e18fbac6986bda5938c53ff79bc7c501
+  metadata.gz: fe363b8051bd23fb22696b5580fcaade629e103d2797cdebdfe071382523719e
+  data.tar.gz: 3c4417745d50b56e7d9ea9ac22d3d9b78738113d87d748fe514332c5838bbd47
 SHA512:
-  metadata.gz: 70be39d4763e0ca77a39d1ee77e9a743a2bec709181e0ef75214c767ca2605d342ff2f245eec5aa0ac80fc28b78f58eb82c064687023aeedb4411785b5f5dca1
-  data.tar.gz: 18d1a1d16869dfbbaec20805470ea5e260e5daa2d252f2a751c479ba3457425f2f0b2b36c8794b29bc61f1637466524448d7acf3201d570b545d29e982e11df6
+  metadata.gz: b736b83b238cd84e1501a89cd77ae2414d7206ba38c7196e5d117e03ac04d20d5304cef29fcd0cbe28bce49fbf88c4fa46c3109d75fd39c013dfb142685b614d
+  data.tar.gz: 9fb3ecf7aad279a24068ee6c9ee1d78dbf7128f02451ef83e575389be9c5d6ba89775977dab540bfa5801a2abb8c97acc281f5b99086eea7c52493d04aa319c3

data/.github/dependabot.yml

@@ -0,0 +1,19 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - toshimaru
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - toshimaru

data/.github/workflows/ci.yml

@@ -1,23 +1,22 @@
 name: CI
-on: [push]
+on: [push, pull_request]
 jobs:
   build:
     strategy:
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7]
+        ruby: [2.5, 2.6, 2.7, 3.0]
         gemfile:
-        - gemfiles/jekyll_4.0.gemfile
-        - gemfiles/jekyll_3.8.gemfile
-        exclude:
-        - ruby: 2.4
-          gemfile: gemfiles/jekyll_4.0.gemfile
+          - gemfiles/jekyll_3.9.gemfile
+          - gemfiles/jekyll_4.0.gemfile
+          - gemfiles/jekyll_4.1.gemfile
+          - gemfiles/jekyll_4.2.gemfile
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}
-      uses: eregon/use-ruby-action@master
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: bundle install

data/.github/workflows/coverage.yml

@@ -1,21 +1,21 @@
 name: Coverage
-on: [push]
+on: [push, pull_request]
 jobs:
   build:
     strategy:
       matrix:
-        ruby: [2.6]
+        ruby: [3.0]
     runs-on: ubuntu-latest
     name: coverage
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: eregon/use-ruby-action@master
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
       - name: bundle install
         run: bundle install --jobs 4 --retry 3
-      - uses: paambaati/codeclimate-action@v2.4.0
+      - uses: paambaati/codeclimate-action@v2.7.5
         env:
           CC_TEST_REPORTER_ID: 6b81e393ea6ad38560386f650ea2fb0e57a7beb5e20f8c8364fabee30d5bff07
         with:

data/.github/workflows/rubocop.yml

@@ -1,16 +1,16 @@
 name: RuboCop
-on: [push]
+on: [push, pull_request]
 jobs:
   build:
     strategy:
       matrix:
-        ruby: [2.6]
+        ruby: [3.0]
     runs-on: ubuntu-latest
     name: rubocop
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: eregon/use-ruby-action@master
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
       - name: bundle install

data/.rubocop.yml

@@ -1,11 +1,15 @@
 AllCops:
   TargetRubyVersion: 2.4
+  NewCops: enable
   Exclude:
     - "*.gemspec"
     - "gemfiles/*"
     - "vendor/**/*"
     - Rakefile
     - Gemfile
+require:
+  - rubocop-performance
+  - rubocop-minitest
 
 Metrics/MethodLength:
   Enabled: false

data/Appraisals

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-appraise 'jekyll-4.0' do
-  gem 'jekyll', '4.0'
-end
+SUPPORTED_VERSIONS = %w[3.8 3.9 4.0 4.1 4.2].freeze
 
-appraise 'jekyll-3.8' do
-  gem 'jekyll', '3.8'
+SUPPORTED_VERSIONS.each do |version|
+  appraise "jekyll-#{version}" do
+    gem 'jekyll', version
+  end
 end

data/Gemfile

@@ -7,5 +7,8 @@ gem 'minitest-reporters'
 gem 'minitest'
 gem 'pry'
 gem 'rake'
-gem 'rubocop', '~> 0.81'
+gem 'rubocop-minitest'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop'
 gem 'simplecov', '~> 0.17.1'

data/README.md

@@ -1,7 +1,7 @@
 # jekyll-toc
 
 ![CI](https://github.com/toshimaru/jekyll-toc/workflows/CI/badge.svg)
-[![Gem Version](https://badge.fury.io/rb/jekyll-toc.svg)](http://badge.fury.io/rb/jekyll-toc)
+[![Gem Version](https://badge.fury.io/rb/jekyll-toc.svg)](https://badge.fury.io/rb/jekyll-toc)
 [![Code Climate](https://codeclimate.com/github/toshimaru/jekyll-toc/badges/gpa.svg)](https://codeclimate.com/github/toshimaru/jekyll-toc)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/cd56b207f327603662a1/test_coverage)](https://codeclimate.com/github/toshimaru/jekyll-toc/test_coverage)
 
@@ -9,16 +9,19 @@
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [1. Basic Usage](#1-basic-usage)
-  - [2. Advanced Usage](#2-advanced-usage)
+  - [Basic Usage](#basic-usage)
+  - [Advanced Usage](#advanced-usage)
 - [Generated HTML](#generated-html)
-- [Default Configuration](#default-configuration)
 - [Customization](#customization)
+  - [Default Configuration](#default-configuration)
   - [TOC levels](#toc-levels)
+  - [Enable TOC by default](#enable-toc-by-default)
   - [Skip TOC](#skip-toc)
-  - [Skip TOC Section](#skip-toc-section)
+  - [Skip TOC Sectionally](#skip-toc-sectionally)
   - [CSS Styling](#css-styling)
-  - [Custom CSS Class](#custom-css-class)
+  - [Custom CSS Class and ID](#custom-css-class-and-id)
+  - [Using Unordered/Ordered lists](#using-unorderedordered-lists)
+- [Alternative Tools](#alternative-tools)
 
 ## Installation
 
@@ -50,7 +53,7 @@ toc: true
 There are three Liquid filters, which can be applied to HTML content,
 e.g. the Liquid variable `content` available in Jekyll's templates.
 
-### 1. Basic Usage
+### Basic Usage
 
 #### `toc` filter
 
@@ -62,11 +65,11 @@ Add the `toc` filter to your site's `{{ content }}` (e.g. `_layouts/post.html`).
 
 This filter places the TOC directly above the content.
 
-### 2. Advanced Usage
+### Advanced Usage
 
 If you'd like separated TOC and content, you can use `{% toc %}` tag (or `toc_only` filter) and `inject_anchors` filter.
 
-#### `{% toc %}` tag
+#### `{% toc %}` tag / `toc_only` filter
 
 Generates the TOC itself as described [below](#generated-html).
 Mostly useful in cases where the TOC should _not_ be placed immediately
@@ -85,7 +88,8 @@ above the content but at some other place of the page, i.e. an aside.
 
 :warning: **`{% toc %}` Tag Limitation**
 
-`{% toc %}` can be available only in [Jekyll Posts](https://jekyllrb.com/docs/step-by-step/08-blogging/) and [Jekyll Collections](https://jekyllrb.com/docs/collections/). If you'd like to use `{% toc %}` except posts or collections, please use `toc_only` filter as described below.
+`{% toc %}` works only for [Jekyll Posts](https://jekyllrb.com/docs/step-by-step/08-blogging/) and [Jekyll Collections](https://jekyllrb.com/docs/collections/).
+If you'd like to use `{% toc %}` except posts or collections, please use `toc_only` filter as described below.
 
 ```html
 <div>
@@ -114,10 +118,10 @@ location with the `toc_only` filter.
 
 ## Generated HTML
 
-jekyll-toc generates an unordered list. The HTML output is as follows.
+jekyll-toc generates an unordered list by default. The HTML output is as follows.
 
 ```html
-<ul class="section-nav">
+<ul id="toc" class="section-nav">
   <li class="toc-entry toc-h1"><a href="#heading1">Heading.1</a>
     <ul>
       <li class="toc-entry toc-h2"><a href="#heading1-1">Heading.1-1</a></li>
@@ -140,52 +144,69 @@ jekyll-toc generates an unordered list. The HTML output is as follows.
 
 ![screenshot](https://user-images.githubusercontent.com/803398/28401295-0dcfb7ca-6d54-11e7-892b-2f2e6ca755a7.png)
 
-## Default Configuration 
+## Customization
+
+jekyll-toc is customizable on `_config.yml`.
+
+### Default Configuration
 
 ```yml
+# _config.yml
 toc:
   min_level: 1
   max_level: 6
+  ordered_list: false
   no_toc_section_class: no_toc_section
+  list_id: toc
   list_class: section-nav
   sublist_class: ''
   item_class: toc-entry
   item_prefix: toc-
 ```
 
-## Customization
-
 ### TOC levels
 
-The toc levels can be configured on `_config.yml`:
-
 ```yml
+# _config.yml
 toc:
   min_level: 2 # default: 1
   max_level: 5 # default: 6
 ```
 
-The default level range is `<h1>` to `<h6>`.
+The default heading range is from `<h1>` to `<h6>`.
+
+### Enable TOC by default
+
+You can enable TOC by default with [Front Matter Defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/):
+
+```yml
+# _config.yml
+defaults:
+  - scope:
+      path: ""
+    values:
+      toc: true
+```
 
 ### Skip TOC
 
-The heading is ignored in the toc when you add `no_toc` to the class.
+The heading is ignored in the toc by adding `no_toc` class.
 
 ```html
 <h1>h1</h1>
-<h1 class="no_toc">This heading is ignored in the toc</h1>
+<h1 class="no_toc">This heading is ignored in the TOC</h1>
 <h2>h2</h2>
 ```
 
-### Skip TOC Section
+### Skip TOC Sectionally
 
 The headings are ignored inside the element which has `no_toc_section` class.
 
 ```html
 <h1>h1</h1>
 <div class="no_toc_section">
-  <h2>This heading is ignored in the toc</h2>
-  <h3>This heading is ignored in the toc</h3>
+  <h2>This heading is ignored in the TOC</h2>
+  <h3>This heading is ignored in the TOC</h3>
 </div>
 <h4>h4</h4>
 ```
@@ -195,13 +216,15 @@ Which would result in only the `<h1>` & `<h4>` within the example being included
 The class can be configured on `_config.yml`:
 
 ```yml
+# _config.yml
 toc:
   no_toc_section_class: exclude # default: no_toc_section
 ```
 
-Configuring multiple classes for `no_toc_section_class` is allowed:
+Configuring multiple classes are allowed:
 
 ```yml
+# _config.yml
 toc:
   no_toc_section_class:
     - no_toc_section
@@ -227,21 +250,64 @@ The toc can be modified with CSS. The sample CSS is the following.
 
 Each TOC `li` entry has two CSS classes for further styling. The general `toc-entry` is applied to all `li` elements in the `ul.section-nav`.
 
-Depending on the heading level each specific entry refers to, it has a second CSS class `toc-XX`, where `XX` is the HTML heading tag name. For example, the TOC entry linking to a heading `<h1>...</h1>` (a single
-`#` in Markdown) will get the CSS class `toc-h1`.
+Depending on the heading level each specific entry refers to, it has a second CSS class `toc-XX`, where `XX` is the HTML heading tag name.
+For example, the TOC entry linking to a heading `<h1>...</h1>` (a single `#` in Markdown) will get the CSS class `toc-h1`.
 
-### Custom CSS Class
+### Custom CSS Class and ID
 
 You can apply custom CSS classes to the generated `<ul>` and `<li>` tags.
 
 ```yml
+# _config.yml
+toc:
+  list_id: my-toc-id # Default: "toc"
+  list_class: my-list-class # Default: "section-nav"
+  sublist_class: my-sublist-class # Default: no class for sublists
+  item_class: my-item-class # Default: "toc-entry"
+  item_prefix: item- # Default: "toc-":
+```
+
+### Using Unordered/Ordered lists
+
+By default the table of contents will be generated as an unordered list via `<ul></ul>` tags. This can be configured to use ordered lists instead `<ol></ol>`.
+This can be configured in `_config.yml`:
+
+```yml
+# _config.yml
 toc:
-  # Default is "section-nav":
+  ordered_list: true # default is false
+```
+
+In order to change the list type, use the [list-style-type](https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type) css property.
+Add a class to the `sublist_class` configuration to append it to the `ol` tags so that you can add the `list-style-type` property.
+
+Example
+
+```yml
+# _config.yml
+toc:
+  ordered_list: true
   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-
 ```
+
+```css
+.my-list-class {
+  list-style-type: upper-alpha;
+}
+
+.my-sublist-class: {
+  list-style-type: lower-alpha;
+}
+```
+
+This will produce:
+
+![screenshot](https://user-images.githubusercontent.com/7675276/85813980-a0ea5a80-b719-11ea-9458-ccf9b86a778b.png)
+
+## Alternative Tools
+
+- Adding anchor to headings
+  - [AnchorJS](https://www.bryanbraun.com/anchorjs/)
+- Generating TOC for kramdown content
+  - [Automatic “Table of Contents” Generation](https://kramdown.gettalong.org/converter/html.html#toc) (See also. [Create Table of Contents in kramdown](https://blog.toshima.ru/2020/05/22/kramdown-toc))

data/gemfiles/jekyll_3.8.gemfile

@@ -7,7 +7,10 @@ gem "minitest-reporters"
 gem "minitest"
 gem "pry"
 gem "rake"
-gem "rubocop", "~> 0.81"
+gem "rubocop-minitest"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop"
 gem "simplecov", "~> 0.17.1"
 gem "jekyll", "3.8"
 

data/gemfiles/jekyll_3.9.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop-minitest"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop"
+gem "simplecov", "~> 0.17.1"
+gem "jekyll", "3.9"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.0.gemfile

@@ -7,7 +7,10 @@ gem "minitest-reporters"
 gem "minitest"
 gem "pry"
 gem "rake"
-gem "rubocop", "~> 0.81"
+gem "rubocop-minitest"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop"
 gem "simplecov", "~> 0.17.1"
 gem "jekyll", "4.0"
 

data/gemfiles/jekyll_4.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop-minitest"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop"
+gem "simplecov", "~> 0.17.1"
+gem "jekyll", "4.1"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.2.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "minitest-reporters"
+gem "minitest"
+gem "pry"
+gem "rake"
+gem "rubocop-minitest"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop"
+gem "simplecov", "~> 0.17.1"
+gem "jekyll", "4.2"
+
+gemspec path: "../"

data/jekyll-toc.gemspec

@@ -8,17 +8,17 @@ Gem::Specification.new do |spec|
   spec.name          = 'jekyll-toc'
   spec.version       = Jekyll::TableOfContents::VERSION
   spec.summary       = 'Jekyll Table of Contents plugin'
-  spec.description   = 'Jekyll (Ruby static website generator) plugin which generates a table of contents.'
+  spec.description   = 'Jekyll (Ruby static website generator) plugin which generates a Table of Contents for the page.'
   spec.authors       = %w(toshimaru torbjoernk)
   spec.email         = 'me@toshimaru.net'
   spec.files         = `git ls-files -z`.split("\x0")
   spec.homepage      = 'https://github.com/toshimaru/jekyll-toc'
   spec.license       = 'MIT'
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'
 
-  spec.add_dependency 'jekyll', '>= 3.8'
+  spec.add_dependency 'jekyll', '>= 3.9'
   spec.add_dependency 'nokogiri', '~> 1.10'
 end

data/lib/table_of_contents/configuration.rb

@@ -4,13 +4,15 @@ module Jekyll
   module TableOfContents
     # jekyll-toc configuration class
     class Configuration
-      attr_reader :toc_levels, :no_toc_class, :no_toc_section_class,
-                  :list_class, :sublist_class, :item_class, :item_prefix
+      attr_reader :toc_levels, :no_toc_class, :ordered_list, :no_toc_section_class,
+                  :list_id, :list_class, :sublist_class, :item_class, :item_prefix
 
       DEFAULT_CONFIG = {
         'min_level' => 1,
         'max_level' => 6,
+        'ordered_list' => false,
         'no_toc_section_class' => 'no_toc_section',
+        'list_id' => 'toc',
         'list_class' => 'section-nav',
         'sublist_class' => '',
         'item_class' => 'toc-entry',
@@ -21,8 +23,10 @@ module Jekyll
         options = generate_option_hash(options)
 
         @toc_levels = options['min_level']..options['max_level']
+        @ordered_list = options['ordered_list']
         @no_toc_class = 'no_toc'
         @no_toc_section_class = options['no_toc_section_class']
+        @list_id = options['list_id']
         @list_class = options['list_class']
         @sublist_class = options['sublist_class']
         @item_class = options['item_class']

data/lib/table_of_contents/parser.rb

@@ -19,7 +19,7 @@ module Jekyll
       end
 
       def build_toc
-        %(<ul class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
+        %(<#{list_tag} id="#{@configuration.list_id}" class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</#{list_tag}>)
       end
 
       def inject_anchors_into_html
@@ -74,7 +74,7 @@ module Jekyll
             next_i = i + 1
             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#{ul_attributes}>\n#{build_toc_list(nest_entries)}</ul>\n)
+              toc_list << %(\n<#{list_tag}#{ul_attributes}>\n#{build_toc_list(nest_entries)}</#{list_tag}>\n)
               i += nest_entries.count
             end
             # Add the closing tag for the current entry in the list
@@ -107,7 +107,7 @@ module Jekyll
       end
 
       def toc_headings_in_no_toc_section
-        if @configuration.no_toc_section_class.is_a? Array
+        if @configuration.no_toc_section_class.is_a?(Array)
           @configuration.no_toc_section_class.map { |cls| toc_headings_within(cls) }.join(',')
         else
           toc_headings_within(@configuration.no_toc_section_class)
@@ -121,6 +121,10 @@ module Jekyll
       def ul_attributes
         @ul_attributes ||= @configuration.sublist_class.empty? ? '' : %( class="#{@configuration.sublist_class}")
       end
+
+      def list_tag
+        @list_tag ||= @configuration.ordered_list ? 'ol' : 'ul'
+      end
     end
   end
 end

data/lib/table_of_contents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module TableOfContents
-    VERSION = '0.14.0'
+    VERSION = '0.17.0'
   end
 end

data/test/parser/test_inject_anchors_filter.rb

@@ -18,6 +18,6 @@ class TestInjectAnchorsFilter < Minitest::Test
   def test_does_not_inject_toc
     html = @parser.inject_anchors_into_html
 
-    assert_nil(/<ul class="section-nav">/ =~ html)
+    refute_includes(html, %(<ul id="toc" class="section-nav">))
   end
 end

data/test/parser/test_invalid_options.rb

@@ -5,7 +5,7 @@ require 'test_helper'
 class TestInvalidOptions < Minitest::Test
   BASE_HTML = '<h1>h1</h1>'
   EXPECTED_HTML = <<~HTML.chomp
-    <ul class="section-nav">
+    <ul id="toc" class="section-nav">
     <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
     </ul>
   HTML

data/test/parser/test_ordered_list.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestOrderedList < Minitest::Test
+  include TestHelpers
+
+  def test_default_configuration
+    configuration = Jekyll::TableOfContents::Configuration.new({})
+
+    refute(configuration.ordered_list)
+  end
+
+  def test_disabled_ordered_list
+    configuration = Jekyll::TableOfContents::Configuration.new('ordered_list' => false)
+
+    refute(configuration.ordered_list)
+  end
+
+  def test_enabled_ordered_list
+    configuration = Jekyll::TableOfContents::Configuration.new('ordered_list' => true)
+
+    assert(configuration.ordered_list)
+  end
+
+  def test_basic_ordered_list_top_heading
+    parse_with_ordered_list
+    html = @parser.toc
+
+    assert_match(/^<ol id="toc" class="section-nav">/, html)
+  end
+
+  def test_ordered_list_sub_headings
+    parse_with_ordered_list
+    html = @parser.toc
+
+    assert_match(/<ol>\n<li class="toc-entry/, html)
+  end
+
+  def test_ordered_list_top_heading_with_classes
+    parse_with_ordered_list_and_classes
+    html = @parser.toc
+
+    assert_match(/^<ol id="toc" class="top-list-class">/, html)
+  end
+
+  def test_ordered_list_sub_headings_with_classes
+    parse_with_ordered_list_and_classes
+    html = @parser.toc
+
+    assert_match(/<ol class="sublist-class">/, html)
+  end
+
+  def test_ordered_list_subheadings_with_classes_nested_structure
+    parse_with_ordered_list_and_classes
+    html = @parser.toc
+
+    occurrences = html.scan(/<ol class="sublist-class">/).count
+
+    assert_equal(5, occurrences)
+  end
+
+  private
+
+  def parse_with_ordered_list
+    read_html_and_create_parser('ordered_list' => true)
+  end
+
+  def parse_with_ordered_list_and_classes
+    read_html_and_create_parser(
+      'ordered_list' => true,
+      'list_class' => 'top-list-class',
+      'sublist_class' => 'sublist-class'
+    )
+  end
+end

data/test/parser/test_toc_filter.rb

@@ -31,6 +31,6 @@ class TestTOCFilter < Minitest::Test
   def test_injects_toc_container
     html = @parser.toc
 
-    assert_match(/<ul class="section-nav">/, html)
+    assert_match(/<ul id="toc" class="section-nav">/, html)
   end
 end

data/test/parser/test_toc_only_filter.rb

@@ -12,12 +12,12 @@ class TestTOCOnlyFilter < Minitest::Test
   def test_injects_toc_container
     html = @parser.build_toc
 
-    assert_match(/<ul class="section-nav">/, html)
+    assert_includes(html, %(<ul id="toc" class="section-nav">))
   end
 
   def test_does_not_return_content
     html = @parser.build_toc
 
-    assert_nil(%r{<h1>Simple H1</h1>} =~ html)
+    refute_includes(html, %(<h1>Simple H1</h1>))
   end
 end

data/test/parser/test_various_toc_html.rb

@@ -12,7 +12,7 @@ class TestVariousTocHtml < Minitest::Test
   def test_nested_toc
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML)
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" 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>
@@ -31,7 +31,7 @@ class TestVariousTocHtml < Minitest::Test
   def test_nested_toc_with_min_and_max
     parser = Jekyll::TableOfContents::Parser.new(TEST_HTML, 'min_level' => 2, 'max_level' => 5)
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h3"><a href="#h3">h3</a></li>
       </ul>
     HTML
@@ -47,7 +47,7 @@ class TestVariousTocHtml < Minitest::Test
       <h6>h6</h6>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" 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></li>
@@ -74,7 +74,7 @@ class TestVariousTocHtml < Minitest::Test
       <h1>h1</h1>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h6"><a href="#h6">h6</a></li>
       <li class="toc-entry toc-h5"><a href="#h5">h5</a></li>
       <li class="toc-entry toc-h4"><a href="#h4">h4</a></li>
@@ -96,7 +96,7 @@ class TestVariousTocHtml < Minitest::Test
       <h5>h5</h5>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" 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></li>
@@ -129,7 +129,7 @@ class TestVariousTocHtml < Minitest::Test
       <h4 class="no_toc">no_toc h4</h4>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a>
       <ul>
       <li class="toc-entry toc-h2"><a href="#h2">h2</a>
@@ -156,7 +156,7 @@ class TestVariousTocHtml < Minitest::Test
       <h3>う</h3>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#%E3%81%82">あ</a>
       <ul>
       <li class="toc-entry toc-h2"><a href="#%E3%81%84">い</a>
@@ -184,7 +184,7 @@ class TestVariousTocHtml < Minitest::Test
       <h1>&amp; &lt; &gt;</h1>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#base-href">&lt;base href&gt;</a></li>
       <li class="toc-entry toc-h1"><a href="#--">&amp; &lt; &gt;</a></li>
@@ -200,7 +200,7 @@ class TestVariousTocHtml < Minitest::Test
       <h2><em>h2</em></h2>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h2"><a href="#h2">h2</a></li>
       <li class="toc-entry toc-h2"><a href="#h2-1">h2</a></li>
       </ul>
@@ -219,7 +219,7 @@ class TestVariousTocHtml < Minitest::Test
       <h6>h6</h6>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" 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>
@@ -254,7 +254,7 @@ class TestVariousTocHtml < Minitest::Test
       <h6>h6</h6>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" 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>
@@ -291,7 +291,7 @@ class TestVariousTocHtml < Minitest::Test
       <h6>h6</h6>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" 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>
@@ -321,7 +321,7 @@ class TestVariousTocHtml < Minitest::Test
       <h1 id="third">h3</h1>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#second">h2</a></li>
       <li class="toc-entry toc-h1"><a href="#third">h3</a></li>
@@ -342,7 +342,7 @@ class TestVariousTocHtml < Minitest::Test
       <h1>h1</h1>
     HTML
     expected = <<~HTML.chomp
-      <ul class="section-nav">
+      <ul id="toc" class="section-nav">
       <li class="toc-entry toc-h1"><a href="#h1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#h1-1">h1</a></li>
       <li class="toc-entry toc-h1"><a href="#h1-2">h1</a></li>
@@ -355,10 +355,10 @@ class TestVariousTocHtml < Minitest::Test
   def test_custom_css_classes
     parser = Jekyll::TableOfContents::Parser.new(
       TEST_HTML,
-      'item_class' => 'custom-item', 'list_class' => 'custom-list', 'sublist_class' => 'custom-sublist', 'item_prefix' => 'custom-prefix-'
+      'item_class' => 'custom-item', 'list_id' => 'custom-toc-id', 'list_class' => 'custom-list', 'sublist_class' => 'custom-sublist', 'item_prefix' => 'custom-prefix-'
     )
     expected = <<~HTML.chomp
-      <ul class="custom-list">
+      <ul id="custom-toc-id" 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>

data/test/test_configuration.rb

@@ -3,25 +3,29 @@
 require 'test_helper'
 
 class TestConfiguration < Minitest::Test
-  def test_default_conf1guration
+  def test_default_configuration
     configuration = Jekyll::TableOfContents::Configuration.new({})
 
-    assert_equal configuration.toc_levels, 1..6
-    assert_equal configuration.no_toc_section_class, 'no_toc_section'
-    assert_equal configuration.list_class, 'section-nav'
-    assert_equal configuration.sublist_class, ''
-    assert_equal configuration.item_class, 'toc-entry'
-    assert_equal configuration.item_prefix, 'toc-'
+    assert_equal(1..6, configuration.toc_levels)
+    refute(configuration.ordered_list)
+    assert_equal('no_toc_section', configuration.no_toc_section_class)
+    assert_equal('toc', configuration.list_id)
+    assert_equal('section-nav', configuration.list_class)
+    assert_equal('', configuration.sublist_class)
+    assert_equal('toc-entry', configuration.item_class)
+    assert_equal('toc-', configuration.item_prefix)
   end
 
   def test_type_error
     configuration = Jekyll::TableOfContents::Configuration.new('TypeError!')
 
-    assert_equal configuration.toc_levels, 1..6
-    assert_equal configuration.no_toc_section_class, 'no_toc_section'
-    assert_equal configuration.list_class, 'section-nav'
-    assert_equal configuration.sublist_class, ''
-    assert_equal configuration.item_class, 'toc-entry'
-    assert_equal configuration.item_prefix, 'toc-'
+    assert_equal(1..6, configuration.toc_levels)
+    refute(configuration.ordered_list)
+    assert_equal('no_toc_section', configuration.no_toc_section_class)
+    assert_equal('toc', configuration.list_id)
+    assert_equal('section-nav', configuration.list_class)
+    assert_equal('', configuration.sublist_class)
+    assert_equal('toc-entry', configuration.item_class)
+    assert_equal('toc-', configuration.item_prefix)
   end
 end

data/test/test_helper.rb

@@ -20,7 +20,7 @@ SIMPLE_HTML = <<~HTML
 HTML
 
 module TestHelpers
-  def read_html_and_create_parser
-    @parser = Jekyll::TableOfContents::Parser.new(SIMPLE_HTML)
+  def read_html_and_create_parser(options = {})
+    @parser = Jekyll::TableOfContents::Parser.new(SIMPLE_HTML, options)
   end
 end

data/test/test_jekyll-toc.rb

@@ -24,7 +24,7 @@ class TestTableOfContentsFilter < Minitest::Test
 
   def test_toc_only2
     @context = enable_toc_context
-    assert_equal "<ul class=\"section-nav\">\n</ul>", toc_only(DUMMY_HTML)
+    assert_equal %(<ul id="toc" class="section-nav">\n</ul>), toc_only(DUMMY_HTML)
   end
 
   def test_inject_anchors2
@@ -34,7 +34,7 @@ class TestTableOfContentsFilter < Minitest::Test
 
   def test_toc2
     @context = enable_toc_context
-    assert_equal "<ul class=\"section-nav\">\n</ul>#{DUMMY_HTML}", toc(DUMMY_HTML)
+    assert_equal %(<ul id="toc" class="section-nav">\n</ul>#{DUMMY_HTML}), toc(DUMMY_HTML)
   end
 
   private

data/test/test_kramdown_list.rb

@@ -36,7 +36,7 @@ class TestKramdownList < Minitest::Test
     assert_equal(expected, actual)
   end
 
-  def test_kramdown_list_1
+  def test_kramdown_list_l1_l5
     text = <<~MARKDOWN
       * level-1
         * level-2
@@ -70,7 +70,7 @@ class TestKramdownList < Minitest::Test
     assert_equal(expected, actual)
   end
 
-  def test_kramdown_list_2
+  def test_kramdown_list_l1_l3_l2_l4
     text = <<~MARKDOWN
       * level-1
           * level-3
@@ -101,7 +101,7 @@ class TestKramdownList < Minitest::Test
     assert_equal(expected, actual)
   end
 
-  def test_kramdown_list_3
+  def test_kramdown_list_l4_l1
     text = <<~MARKDOWN
             * level-4
           * level-3
@@ -118,7 +118,7 @@ class TestKramdownList < Minitest::Test
     assert_equal(expected, actual)
   end
 
-  def test_kramdown_list_4
+  def test_kramdown_list_l1_l4_l1
     text = <<~MARKDOWN
       * level-1
             * level-4
@@ -143,7 +143,7 @@ class TestKramdownList < Minitest::Test
     assert_equal(expected, actual)
   end
 
-  def test_kramdown_list_5
+  def test_kramdown_list_l1_l3_l1
     text = <<~MARKDOWN
       * level-1
           * level-3

data/test/test_toc_tag.rb

@@ -17,7 +17,7 @@ class TestTableOfContentsTag < Minitest::Test
       site: @stubbed_context1.new({ 'toc' => nil })
     )
     tag = Jekyll::TocTag.parse('toc_tag', '', Tokenizer.new(''), ParseContext.new)
-    assert_equal tag.render(context), "<ul class=\"section-nav\">\n<li class=\"toc-entry toc-h1\"><a href=\"#test\">test</a></li>\n</ul>"
+    assert_equal(%(<ul id="toc" class="section-nav">\n<li class="toc-entry toc-h1"><a href="#test">test</a></li>\n</ul>), tag.render(context))
   end
 
   def test_toc_tag_returns_empty_string

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.17.0
 platform: ruby
 authors:
 - toshimaru
 - torbjoernk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -39,13 +39,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-description: Jekyll (Ruby static website generator) plugin which generates a table
-  of contents.
+description: Jekyll (Ruby static website generator) plugin which generates a Table
+  of Contents for the page.
 email: me@toshimaru.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/coverage.yml"
 - ".github/workflows/rubocop.yml"
@@ -58,7 +59,10 @@ files:
 - README.md
 - Rakefile
 - gemfiles/jekyll_3.8.gemfile
+- gemfiles/jekyll_3.9.gemfile
 - gemfiles/jekyll_4.0.gemfile
+- gemfiles/jekyll_4.1.gemfile
+- gemfiles/jekyll_4.2.gemfile
 - jekyll-toc.gemspec
 - lib/jekyll-toc.rb
 - lib/table_of_contents/configuration.rb
@@ -67,6 +71,7 @@ files:
 - lib/table_of_contents/version.rb
 - test/parser/test_inject_anchors_filter.rb
 - test/parser/test_invalid_options.rb
+- test/parser/test_ordered_list.rb
 - test/parser/test_toc_filter.rb
 - test/parser/test_toc_only_filter.rb
 - test/parser/test_various_toc_html.rb
@@ -79,7 +84,7 @@ homepage: https://github.com/toshimaru/jekyll-toc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,13 +99,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Jekyll Table of Contents plugin
 test_files:
 - test/parser/test_inject_anchors_filter.rb
 - test/parser/test_invalid_options.rb
+- test/parser/test_ordered_list.rb
 - test/parser/test_toc_filter.rb
 - test/parser/test_toc_only_filter.rb
 - test/parser/test_various_toc_html.rb