jekyll-toc 0.15.0.rc → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d791df4c69353cee2810d445dc565746e9d4ed2f7f738e205f6ee2fef19d369
-  data.tar.gz: '084bc15ad6fe3fb08b2ad83e979e08d93ffb988adbccc6c7981479cd210d9de4'
+  metadata.gz: e250bc0a38525c4496ba464685b2ca3bc9c462953ce7c299a52cf52611940099
+  data.tar.gz: 628f832e2adaae7b8b225423149b6dd950d04c884698f1b8e42c6e3990f33359
 SHA512:
-  metadata.gz: 44021a6c5bf17fa105b698571d43715aa381297b47355f4f439179063f695318f8071a8c1120318682c9eb25c17d7067fcacfdfc0ea5ce62995428f3e2f3649f
-  data.tar.gz: 69af07e31563443aa18492717b820aa3d274cc2e1cbb520a9b1489b87c72492ef3611fb96a25403565ea9e809161cffb2809aaead154b047984dac67da268bcb
+  metadata.gz: 258fde765cb95ce75abd2b87a4336a3a58630188e872c337014b8b780ac06843521b49070a201a3c9cdc7530409f61caeb159b770801b580eed8fb4921a5f74c
+  data.tar.gz: d9d8e1dc2b78c353333db1af1ad03eb86b387e35e89fea8fd554c834e3b8d93b200539f48f9bc070d95bb24f18addb8127329b966a6512ef6bac02909ce37ef1

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

@@ -21,7 +21,7 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}
-      uses: eregon/use-ruby-action@master
+      uses: actions/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: bundle install

data/.github/workflows/coverage.yml

@@ -10,12 +10,12 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: eregon/use-ruby-action@master
+        uses: actions/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.4
         env:
           CC_TEST_REPORTER_ID: 6b81e393ea6ad38560386f650ea2fb0e57a7beb5e20f8c8364fabee30d5bff07
         with:

data/.github/workflows/rubocop.yml

@@ -10,7 +10,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: eregon/use-ruby-action@master
+        uses: actions/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/Gemfile

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

data/README.md

@@ -9,17 +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)
   - [Using Unordered/Ordered lists](#using-unorderedordered-lists)
+- [Alternative Tools](#alternative-tools)
 
 ## Installation
 
@@ -51,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
 
@@ -63,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
@@ -86,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>
@@ -115,7 +118,7 @@ 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">
@@ -141,9 +144,14 @@ 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
@@ -155,39 +163,49 @@ toc:
   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>
 ```
@@ -197,13 +215,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
@@ -229,14 +249,15 @@ 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
 
 You can apply custom CSS classes to the generated `<ul>` and `<li>` tags.
 
 ```yml
+# _config.yml
 toc:
   # Default is "section-nav":
   list_class: my-list-class
@@ -254,6 +275,7 @@ By default the table of contents will be generated as an unordered list via `<ul
 This can be configured in `_config.yml`:
 
 ```yml
+# _config.yml
 toc:
   ordered_list: true # default is false
 ```
@@ -264,6 +286,7 @@ Add a class to the `sublist_class` configuration to append it to the `ol` tags s
 Example
 
 ```yml
+# _config.yml
 toc:
   ordered_list: true
   list_class: my-list-class
@@ -283,3 +306,10 @@ toc:
 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/jekyll-toc.gemspec

@@ -8,13 +8,13 @@ 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'

data/lib/table_of_contents/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module TableOfContents
-    VERSION = '0.15.0.rc'
+    VERSION = '0.15.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 class="section-nav">))
   end
 end

data/test/parser/test_ordered_list.rb

@@ -8,19 +8,19 @@ class TestOrderedList < Minitest::Test
   def test_default_configuration
     configuration = Jekyll::TableOfContents::Configuration.new({})
 
-    assert_equal configuration.ordered_list, false
+    refute(configuration.ordered_list)
   end
 
   def test_disabled_ordered_list
     configuration = Jekyll::TableOfContents::Configuration.new('ordered_list' => false)
 
-    assert_equal configuration.ordered_list, false
+    refute(configuration.ordered_list)
   end
 
   def test_enabled_ordered_list
     configuration = Jekyll::TableOfContents::Configuration.new('ordered_list' => true)
 
-    assert_equal configuration.ordered_list, true
+    assert(configuration.ordered_list)
   end
 
   def test_basic_ordered_list_top_heading
@@ -57,7 +57,7 @@ class TestOrderedList < Minitest::Test
 
     occurrences = html.scan(/<ol class="sublist-class">/).count
 
-    assert_equal occurrences, 5
+    assert_equal(5, occurrences)
   end
 
   private

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 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/test_configuration.rb

@@ -6,24 +6,24 @@ class TestConfiguration < Minitest::Test
   def test_default_configuration
     configuration = Jekyll::TableOfContents::Configuration.new({})
 
-    assert_equal configuration.toc_levels, 1..6
-    assert_equal configuration.ordered_list, false
-    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('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.ordered_list, false
-    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('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_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 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.15.0.rc
+  version: 0.15.0
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -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"
@@ -93,9 +94,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: