jekyll-toc 0.8.0.rc1 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -12
  3. data/lib/version.rb +1 -1
  4. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ff793cf0c346ce007f527e7441cad059b4ee01d05cf5ff632c163c75031af6f7
4
- data.tar.gz: 000f6cddbd70c9b906caed9182bbefca8ca2127afc9568cebd7fcb5ef636e9f1
3
+ metadata.gz: 4467af27a06bb26975169fc6b483ac6b9cf7dc193d957a4d1802018f3e538ea9
4
+ data.tar.gz: 78d9f36a92f6d5329476fe348cbbcae64bf5174762934324a093e65a24d19aee
5
5
  SHA512:
6
- metadata.gz: 065f6561458207ea00a1512fc78499a77e753c807d9a8fa17b4a2a47b0c89e31eae4f8ff7f4a6a3cf69a85dcd5700dda0fd7e46d34395dd480fb390da6978cc9
7
- data.tar.gz: 2e54f2d06c29eb9afcab58d5f960007e45c6955f42fdee6642ba18055dfd46016b42f7df70d9dffcbc7d763f71f969b00bc5c8342a292be2539b79145b7fb1c3
6
+ metadata.gz: 5a3b28995adb47063335b775d389472b0b1584fde3818b134e76792da6e20c7bfe4a86ef2afe1b038c3f8de8128d92d87e6f14a816fef5dacc58fe13f76c1982
7
+ data.tar.gz: 8e27495a54ea17a012e3027464bee31a26e954d91fdb7a0e807c5b13f99baeb29c1461a2f9aea8de2fa966a4e041b3a7897e1f1c0e4c22ecb44c9db312bf0b19
data/README.md CHANGED
@@ -70,8 +70,8 @@ above the content but at some other place of the page, i.e. an aside.
70
70
 
71
71
  #### `inject_anchors` filter
72
72
 
73
- Injects HTML anchors into the content without actually outputing the
74
- TOC itself. They are of the form:
73
+ Injects HTML anchors into the content without actually outputing the TOC itself.
74
+ They are of the form:
75
75
 
76
76
  ```html
77
77
  <a id="heading11" class="anchor" href="#heading1-1" aria-hidden="true">
@@ -124,27 +124,29 @@ The heading is ignored in the toc when you add `no_toc` to the class.
124
124
 
125
125
  #### Skip TOC Section
126
126
 
127
- It can be configured to ignore elements within a selector:
128
-
129
- ```yml
130
- toc:
131
- no_toc_section_class: no_toc_within # default: no_toc_section
132
- ```
127
+ The headings are ignored inside the element which has `no_toc_section` class.
133
128
 
134
129
  ```html
135
130
  <h1>h1</h1>
136
- <div class="no_toc_within">
137
- <h2>h2</h2>
138
- <h3>h3</h3>
131
+ <div class="no_toc_section">
132
+ <h2>This heading is ignored in the toc</h2>
133
+ <h3>This heading is ignored in the toc</h3>
139
134
  </div>
140
135
  <h4>h4</h4>
141
136
  ```
142
137
 
143
138
  Which would result in only the `<h1>` & `<h4>` within the example being included in the TOC.
144
139
 
140
+ The class can be configured on `_config.yml`:
141
+
142
+ ```yml
143
+ toc:
144
+ no_toc_section_class: exclude # default: no_toc_section
145
+ ```
146
+
145
147
  #### TOC levels
146
148
 
147
- The toc levels can be configured on `_config.yml`.
149
+ The toc levels can be configured on `_config.yml`:
148
150
 
149
151
  ```yml
150
152
  toc:
@@ -1,3 +1,3 @@
1
1
  module JekyllToc
2
- VERSION = '0.8.0.rc1'.freeze
2
+ VERSION = '0.8.0'.freeze
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-toc
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.0.rc1
4
+ version: 0.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - toshimaru
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2018-10-16 00:00:00.000000000 Z
12
+ date: 2018-10-18 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: nokogiri
@@ -153,9 +153,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
153
153
  version: 2.2.2
154
154
  required_rubygems_version: !ruby/object:Gem::Requirement
155
155
  requirements:
156
- - - ">"
156
+ - - ">="
157
157
  - !ruby/object:Gem::Version
158
- version: 1.3.1
158
+ version: '0'
159
159
  requirements: []
160
160
  rubyforge_project:
161
161
  rubygems_version: 2.7.6