jekyll-toc 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 705551195e11b692852b8515218169cd4c9c338824817b13591f5427d9921da2
-  data.tar.gz: 497a38ad31db5eddca9c7f7723cb65310732ad8dc07946fa08686258b1aa18c4
+  metadata.gz: a2c1e79e71caeb6e93026f4111464e4dc7ac4d8040b7af5c9fe0d5b426c0cfd5
+  data.tar.gz: c93040f18d95262ce323cbf660a21cd41b1d9afe756bf617f9a434c791d43dcb
 SHA512:
-  metadata.gz: bfad59fcefb5a35f2c332ba948d16e3db883178eb413cc6729ab2c088e6efdc79c26c8f459b676b7ba9cd8ff27a17cfe637f20c87023187418f22cd9445dbdf9
-  data.tar.gz: d6d020c0adc84111b1e9dd4919412b65a5d60d4f913e0eec4fcebc85acdc04c6da9bc535b0d096c9d1a69848553f3fb5f7079e08b8eac5c2c8b6b232c6de5788
+  metadata.gz: c7b9e1971a2c442d34104a698efe9625b6defa110c6833751b6767ef959d4257ad18ea6b6f9c1f93e756a44daf936eea79a62dd24f638b20621aa91bd7ab2ed2
+  data.tar.gz: ed6afcf94eeb1813607311b6c5caef82f905314fe5e76bee044a0bdc008692d1218989ae97c9f5c8517154d034d325525c4471b521ca730a89444a0599a5a8e1

data/README.md

@@ -9,6 +9,8 @@
 
 - [Installation](#installation)
 - [Usage](#usage)
+  - [1. Basic Usage](#1-basic-usage)
+  - [2. Advanced Usage](#2-advanced-usage)
 - [Generated HTML](#generated-html)
 - [Customization](#customization)
   - [Skip TOC](#skip-toc)
@@ -64,13 +66,13 @@ If you'd like separated TOC and content, you can use `toc_only` and `inject_anch
 
 #### `toc_only` filter
 
-Generates the TOC itself as described [below](#generated-table-of-contents-html).
+Generates the TOC itself as described [below](#generated-html).
 Mostly useful in cases where the TOC should _not_ be placed immediately
 above the content but at some other place of the page, i.e. an aside.
 
 #### `inject_anchors` filter
 
-Injects HTML anchors into the content without actually outputing the TOC itself. 
+Injects HTML anchors into the content without actually outputting the TOC itself.
 They are of the form:
 
 ```html
@@ -82,9 +84,7 @@ They are of the form:
 This is only useful when the TOC itself should be placed at some other
 location with the `toc_only` filter.
 
-### Generated HTML
-
-![screenshot](https://user-images.githubusercontent.com/803398/28401295-0dcfb7ca-6d54-11e7-892b-2f2e6ca755a7.png)
+## Generated HTML
 
 jekyll-toc generates an unordered list. The HTML output is as follows.
 
@@ -110,9 +110,11 @@ jekyll-toc generates an unordered list. The HTML output is as follows.
 </ul>
 ```
 
-### Customization
+![screenshot](https://user-images.githubusercontent.com/803398/28401295-0dcfb7ca-6d54-11e7-892b-2f2e6ca755a7.png)s
+
+## Customization
 
-#### Skip TOC
+### Skip TOC
 
 The heading is ignored in the toc when you add `no_toc` to the class.
 
@@ -122,7 +124,7 @@ The heading is ignored in the toc when you add `no_toc` to the class.
 <h2>h2</h2>
 ```
 
-#### Skip TOC Section
+### Skip TOC Section
 
 The headings are ignored inside the element which has `no_toc_section` class.
 
@@ -144,17 +146,17 @@ toc:
   no_toc_section_class: exclude # default: no_toc_section
 ```
 
-Configuring mutiple classes are allowed:
+Configuring multiple classes for `no_toc_section_class` is allowed:
 
 ```yml
 toc:
-  no_toc_section_class: 
+  no_toc_section_class:
     - no_toc_section
     - exclude
     - your_custom_skip_class_name
 ```
 
-#### TOC levels
+### TOC levels
 
 The toc levels can be configured on `_config.yml`:
 
@@ -180,7 +182,7 @@ toc:
 
 The default level range is `<h1>` to `<h6>`.
 
-#### CSS Styling
+### CSS Styling
 
 The toc can be modified with CSS. The sample CSS is the following.
 

data/jekyll-toc.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_runtime_dependency 'nokogiri', '~> 1.8'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.9'
 
   spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'jekyll', '>= 3.5'

data/lib/jekyll-toc.rb

@@ -16,7 +16,7 @@ module Jekyll
   # Jekyll Table of Contents filter plugin
   module TableOfContentsFilter
     def toc_only(html)
-      return html unless toc_enabled?
+      return '' unless toc_enabled?
 
       ::Jekyll::TableOfContents::Parser.new(html, toc_config).build_toc
     end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllToc
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

data/test/test_jekyll-toc.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestTableOfContentsFilter < Minitest::Test
+  include Jekyll::TableOfContentsFilter
+
+  DUMMY_HTML = "<div>Dummy HTML Content</div>"
+  
+  def setup
+    stubbed_context = Struct.new(:registers)
+    @context = stubbed_context.new(page: "xxx")
+    @context
+  end
+
+  def test_toc_only
+    assert_empty toc_only(DUMMY_HTML)
+  end
+
+  def test_inject_anchors
+    assert_equal inject_anchors(DUMMY_HTML), DUMMY_HTML
+  end
+
+  def test_toc
+    assert_equal toc(DUMMY_HTML), DUMMY_HTML
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-toc
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - toshimaru
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2019-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,7 @@ files:
 - lib/version.rb
 - test/test_helper.rb
 - test/test_inject_anchors_filter.rb
+- test/test_jekyll-toc.rb
 - test/test_kramdown_list.rb
 - test/test_option_error.rb
 - test/test_toc_filter.rb
@@ -172,14 +173,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll Table of Contents plugin
 test_files:
 - test/test_helper.rb
 - test/test_inject_anchors_filter.rb
+- test/test_jekyll-toc.rb
 - test/test_kramdown_list.rb
 - test/test_option_error.rb
 - test/test_toc_filter.rb