My0150 nav to top

.gitignore

@@ -1,5 +1,20 @@
+# gems
 *.gem
 /Gemfile.lock
-/.bundle/
-/coverage
 *.gemfile.lock
+/gems/
+
+# local gem package folder
+/pkg/
+
+# tests / test coverage
+.jekyll-cache/
+/coverage
+
+# bundler
+/.bundle/
+/vendor/bundle/
+/gemfiles/.bundle/
+/gemfiles/vendor/bundle/
+
+# unsorted

.rubocop.yml

@@ -20,6 +20,8 @@ Metrics/ClassLength:
 
 Naming/FileName:
   Enabled: false
+Naming/VariableNumber:
+  Enabled: false
 
 Layout/LineLength:
   Enabled: false
@@ -41,3 +43,6 @@ Style/HashTransformValues:
   Enabled: true
 Style/ExponentialNotation:
   Enabled: true
+
+Performance/StringInclude:
+  Enabled: false

lib/table_of_contents/configuration.rb

@@ -5,17 +5,20 @@ module TableOfContents
     # jekyll-toc configuration class
     class Configuration
       attr_reader :toc_levels, :no_toc_class, :ordered_list, :no_toc_section_class,
-                  :list_class, :sublist_class, :item_class, :item_prefix
+                  :list_id, :list_class, :sublist_class, :item_class, :item_prefix,
+                  :nav_to_toc_symbol
 
       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',
-        'item_prefix' => 'toc-'
+        'item_prefix' => 'toc-',
+        'nav_to_toc_symbol' => '↥'
       }.freeze
 
       def initialize(options)
@@ -25,10 +28,12 @@ def initialize(options)
         @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']
         @item_prefix = options['item_prefix']
+        @nav_to_toc_symbol = options['nav_to_toc_symbol']
       end
 
       private

lib/table_of_contents/parser.rb

@@ -19,7 +19,7 @@ def toc
       end
 
       def build_toc
-        %(<#{list_tag} class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</#{list_tag}>)
+        %(<#{list_tag} id="#{@configuration.list_id}" class="#{@configuration.list_class}">\n#{build_toc_list(@entries)}</#{list_tag}>)
       end
 
       def inject_anchors_into_html
@@ -28,6 +28,14 @@ def inject_anchors_into_html
           entry[:header_content].add_previous_sibling(
             %(<a class="anchor" href="##{entry[:id]}" aria-hidden="true"><span class="octicon octicon-link"></span></a>)
           )
+
+          # Add link 'nav to toc'
+          arr_to_top = [2, 3]
+          next unless arr_to_top.include?(entry[:h_num])
+
+          entry[:header_content].add_next_sibling(
+            %(<span style="float: right"><a class="anchor_to_top" href="#{@configuration.list_id}" aria-hidden="true">#{@configuration.nav_to_toc_symbol}</a></span>)
+          )
         end
 
         @doc.inner_html

test/parser/test_inject_anchors_filter.rb

@@ -18,6 +18,6 @@ def test_injects_anchors_into_content
   def test_does_not_inject_toc
     html = @parser.inject_anchors_into_html
 
-    refute_includes(html, %(<ul class="section-nav">))
+    refute_includes(html, %(<ul id="toc" class="section-nav">))
   end
 end

test/parser/test_invalid_options.rb

@@ -5,7 +5,7 @@
 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

test/parser/test_ordered_list.rb

@@ -27,7 +27,7 @@ def test_basic_ordered_list_top_heading
     parse_with_ordered_list
     html = @parser.toc
 
-    assert_match(/^<ol class="section-nav">/, html)
+    assert_match(/^<ol id="toc" class="section-nav">/, html)
   end
 
   def test_ordered_list_sub_headings
@@ -41,7 +41,7 @@ def test_ordered_list_top_heading_with_classes
     parse_with_ordered_list_and_classes
     html = @parser.toc
 
-    assert_match(/^<ol class="top-list-class">/, html)
+    assert_match(/^<ol id="toc" class="top-list-class">/, html)
   end
 
   def test_ordered_list_sub_headings_with_classes

test/parser/test_toc_filter.rb

@@ -31,6 +31,6 @@ def test_nested_toc
   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

test/parser/test_toc_only_filter.rb

@@ -12,7 +12,7 @@ def setup
   def test_injects_toc_container
     html = @parser.build_toc
 
-    assert_includes(html, %(<ul class="section-nav">))
+    assert_includes(html, %(<ul id=\"toc\" class="section-nav">))
   end
 
   def test_does_not_return_content

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 @@ def test_nested_toc
   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 @@ def test_complex_nested_toc
       <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 @@ def test_decremental_headings1
       <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 @@ def test_decremental_headings2
       <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 @@ def test_no_toc
       <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 @@ def test_japanese_toc
       <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 @@ def test_angle_bracket
       <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 @@ def test_tags_inside_heading
       <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 @@ def test_nested_toc_with_no_toc_section_class
       <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 @@ def test_nested_toc_with_no_toc_section_class_option
       <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 @@ def test_multiple_no_toc_section_classes
       <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 @@ def test_toc_with_explicit_id
       <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 @@ def test_anchor_is_uniq
       <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>
@@ -358,7 +358,7 @@ def test_custom_css_classes
       'item_class' => 'custom-item', 'list_class' => 'custom-list', 'sublist_class' => 'custom-sublist', 'item_prefix' => 'custom-prefix-'
     )
     expected = <<~HTML.chomp
-      <ul class="custom-list">
+      <ul id="toc" 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>

test/test_configuration.rb

@@ -9,6 +9,7 @@ def test_default_configuration
     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)
@@ -21,6 +22,7 @@ def test_type_error
     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)

test/test_jekyll-toc.rb

@@ -24,7 +24,7 @@ def test_toc
 
   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 @@ def test_inject_anchors2
 
   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

test/test_toc_tag.rb

@@ -17,7 +17,7 @@ def test_toc_tag
       site: @stubbed_context1.new({ 'toc' => nil })
     )
     tag = Jekyll::TocTag.parse('toc_tag', '', Tokenizer.new(''), ParseContext.new)
-    assert_equal("<ul class=\"section-nav\">\n<li class=\"toc-entry toc-h1\"><a href=\"#test\">test</a></li>\n</ul>", tag.render(context))
+    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