Add id to h-elements

.github/workflows/ci.yml

@@ -1,29 +1,29 @@
-name: CI
-on: [push]
-jobs:
-  build:
-    strategy:
-      matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7]
-        gemfile:
-        - gemfiles/jekyll_4.0.gemfile
-        - gemfiles/jekyll_3.8.gemfile
-        - gemfiles/jekyll_3.7.gemfile
-        exclude:
-        - ruby: 2.4
-          gemfile: gemfiles/jekyll_4.0.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
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: bundle install
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-    - name: Run Test
-      run: bundle exec rake
+name: CI
+on: [push]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+        gemfile:
+        - gemfiles/jekyll_4.0.gemfile
+        - gemfiles/jekyll_3.8.gemfile
+        - gemfiles/jekyll_3.7.gemfile
+        exclude:
+        - ruby: 2.4
+          gemfile: gemfiles/jekyll_4.0.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
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: bundle install
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Run Test
+      run: bundle exec rake

.github/workflows/coverage.yml

@@ -1,22 +1,22 @@
-name: Coverage
-on: [push]
-jobs:
-  build:
-    strategy:
-      matrix:
-        ruby: [2.6]
-    runs-on: ubuntu-latest
-    name: coverage
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: bundle install
-        run: bundle install --jobs 4 --retry 3
-      - uses: paambaati/[email protected]
-        env:
-          CC_TEST_REPORTER_ID: 6b81e393ea6ad38560386f650ea2fb0e57a7beb5e20f8c8364fabee30d5bff07
-        with:
-          coverageCommand: bundle exec rake
+name: Coverage
+on: [push]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.6]
+    runs-on: ubuntu-latest
+    name: coverage
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: bundle install
+        run: bundle install --jobs 4 --retry 3
+      - uses: paambaati/[email protected]
+        env:
+          CC_TEST_REPORTER_ID: 6b81e393ea6ad38560386f650ea2fb0e57a7beb5e20f8c8364fabee30d5bff07
+        with:
+          coverageCommand: bundle exec rake

.github/workflows/rubocop.yml

@@ -1,19 +1,19 @@
-name: RuboCop
-on: [push]
-jobs:
-  build:
-    strategy:
-      matrix:
-        ruby: [2.6]
-    runs-on: ubuntu-latest
-    name: rubocop
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby }}
-        uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: bundle install
-        run: bundle install --jobs 4 --retry 3
-      - name: Run RuboCop
-        run: bundle exec rubocop
+name: RuboCop
+on: [push]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.6]
+    runs-on: ubuntu-latest
+    name: rubocop
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: bundle install
+        run: bundle install --jobs 4 --retry 3
+      - name: Run RuboCop
+        run: bundle exec rubocop

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: UnitTest
+on: [push]
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.6]
+        gemfile:
+        - gemfiles/jekyll_4.0.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
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: bundle install
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Run Test
+      run: bundle exec rake

.gitignore

@@ -1,5 +1,12 @@
+# gems
 *.gem
 /Gemfile.lock
-/.bundle/
-/coverage
 *.gemfile.lock
+/gems/
+
+# tests / test coverage
+/coverage
+
+# bundler
+/.bundle/
+/vendor/bundle/

.rubocop.yml

@@ -3,6 +3,9 @@ AllCops:
   Exclude:
     - "*.gemspec"
     - "gemfiles/*"
+    - gems/**/*
+    - node_modules/**/*
+    - vendor/bundle/**/*
     - Rakefile
     - Gemfile
 
@@ -21,9 +24,24 @@ Style/WordArray:
 Naming/FileName:
   Enabled: false
 
+Layout/EndOfLine:
+  Enabled: false
+
 Layout/LineLength:
   Enabled: false
 
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
 Style/HashEachMethods:
   Enabled: true
 

README.md

@@ -100,17 +100,33 @@ 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 outputting the TOC itself.
-They are of the form:
+Injects HTML anchors into the content without actually outputting the TOC itself.  
+
+They are of the form (usage of [octicons](https://github.com/primer/octicons) as icon collection):
 
 ```html
 <a class="anchor" href="#heading1-1" aria-hidden="true">
   <span class="octicon octicon-link"></span>
 </a>
 ```
 
-This is only useful when the TOC itself should be placed at some other
-location with the `toc_only` filter.
+They are of the form (unicode symbol):
+
+```html
+<a class="anchor" href="#heading1-1" aria-hidden="true">
+  &#128279;&nbsp;
+</a>
+```
+
+This is useful when the TOC itself should be placed at some other location with the `toc_only` filter.  
+
+The second usecase is when you want to **share a link** to the page and link directly to the headline / section.  
+
+There is a new configuration `inject_anchors_content` key, possible values are (or what you prefer)
+
+* `&#128279;&nbsp;` (default) to add a unicode symbol (chain) for an link
+* `<span class="octicon octicon-link"></span>` to use the octicon icon
+* ` ` an empty string or a space is for **hide** the anchor
 
 ## Generated HTML
 

lib/table_of_contents/configuration.rb

@@ -5,16 +5,19 @@ module TableOfContents
     # jekyll-toc configuration class
     class Configuration
       attr_accessor :toc_levels, :no_toc_class, :no_toc_section_class,
-                    :list_class, :sublist_class, :item_class, :item_prefix
+                    :list_class, :list_id, :sublist_class, :item_class, :item_prefix,
+                    :inject_anchors_content
 
       DEFAULT_CONFIG = {
         'min_level' => 1,
         'max_level' => 6,
         'no_toc_section_class' => 'no_toc_section',
         'list_class' => 'section-nav',
+        'list_id' => 'toc',
         'sublist_class' => '',
         'item_class' => 'toc-entry',
-        'item_prefix' => 'toc-'
+        'item_prefix' => 'toc-',
+        'inject_anchors_content' => 'MyLinkAnchor'
       }.freeze
 
       def initialize(options)
@@ -24,9 +27,11 @@ def initialize(options)
         @no_toc_class = 'no_toc'
         @no_toc_section_class = options['no_toc_section_class']
         @list_class = options['list_class']
+        @list_id = options['list_id']
         @sublist_class = options['sublist_class']
         @item_class = options['item_class']
         @item_prefix = options['item_prefix']
+        @inject_anchors_content = options['inject_anchors_content']
       end
 
       private

lib/table_of_contents/parser.rb

@@ -17,13 +17,16 @@ def toc
       end
 
       def build_toc
-        %(<ul class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
+        %(<ul id="#{@configuration.list_id}" class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</ul>)
       end
 
       def inject_anchors_into_html
         @entries.each do |entry|
+          # Add id to h-element
+          entry[:header_parent].set_attribute('id', entry[:id].to_s)
+
           entry[:header_content].add_previous_sibling(
-            %(<a class="anchor" href="##{entry[:id]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>)
+            %(<a class="anchor" href="##{entry[:id]}" aria-hidden="true">#{@configuration.inject_anchors_content}</a>)
           )
         end
 
@@ -53,6 +56,7 @@ def parse_content
             id: suffix_num.zero? ? id : "#{id}-#{suffix_num}",
             text: CGI.escapeHTML(text),
             node_name: node.name,
+            header_parent: node,
             header_content: node.children.first,
             h_num: node.name.delete('h').to_i
           }

test/parser/test_inject_anchors_filter.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class TestInjectAnchorsFilter < Minitest::Test
-  include TestHelpers
-
-  def setup
-    read_html_and_create_parser
-  end
-
-  def test_injects_anchors_into_content
-    html = @parser.inject_anchors_into_html
-
-    assert_match(%r{<a class="anchor" href="#simple-h1" aria-hidden="true"><span.*span></a>Simple H1}, html)
-  end
-
-  def test_does_not_inject_toc
-    html = @parser.inject_anchors_into_html
-
-    assert_nil(/<ul class="section-nav">/ =~ html)
-  end
-end
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestInjectAnchorsFilter < Minitest::Test
+  include TestHelpers
+
+  def setup
+    read_html_and_create_parser
+  end
+
+  def test_injects_anchors_into_content
+    html = @parser.inject_anchors_into_html
+
+    assert_match(%r{<a class="anchor" href="#simple-h1" aria-hidden="true">MyLinkAnchor</a>Simple H1}, html)
+  end
+
+  def test_does_not_inject_toc
+    html = @parser.inject_anchors_into_html
+
+    assert_nil(/<ul id="toc" class="section-nav">/ =~ html)
+  end
+end