feat: TOC (#184)

sigwinhq · Dec 8, 2023 · e07feb5 · e07feb5
1 parent 117fbf4
commit e07feb5
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 8 deletions.
diff --git a/config/services.yaml b/config/services.yaml
@@ -102,6 +102,8 @@ services:
     League\CommonMark\Extension\Table\TableExtension: ~
     League\CommonMark\Extension\Footnote\FootnoteExtension: ~
     League\CommonMark\Extension\Attributes\AttributesExtension: ~
+    League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension: ~
+    League\CommonMark\Extension\TableOfContents\TableOfContentsExtension: ~
 
     Spatie\CommonMarkHighlighter\FencedCodeRenderer: ~
     Spatie\CommonMarkHighlighter\IndentedCodeRenderer: ~
@@ -114,6 +116,10 @@ services:
                 addExtension: [ '@League\CommonMark\Extension\FrontMatter\FrontMatterExtension' ]
             -
                 addExtension: [ '@League\CommonMark\Extension\Table\TableExtension' ]
+            -
+                addExtension: [ '@League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension' ]
+            -
+                addExtension: [ '@League\CommonMark\Extension\TableOfContents\TableOfContentsExtension' ]
             -
                 addExtension: [ '@League\CommonMark\Extension\Footnote\FootnoteExtension' ]
             -

diff --git a/tests/functional/site/fixtures/en/article/lists/index.html b/tests/functional/site/fixtures/en/article/lists/index.html
@@ -16,13 +16,21 @@
         <div class="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10 prose">
             <h1>Lists!</h1>
             <p>19.07.2022. 12:13</p>
-            <h2>Ordered lists</h2>
+            <ul class="table-of-contents">
+<li>
+<a href="#content-ordered-lists">Ordered lists</a>
+</li>
+<li>
+<a href="#content-unordered-lists">Unordered lists</a>
+</li>
+</ul>
+<h2><a id="content-ordered-lists" href="#content-ordered-lists" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Ordered lists</h2>
 <ol>
 <li>one</li>
 <li>two</li>
 <li>three</li>
 </ol>
-<h2>Unordered lists</h2>
+<h2><a id="content-unordered-lists" href="#content-unordered-lists" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Unordered lists</h2>
 <ul>
 <li>a thing</li>
 <li>another thing</li>

diff --git a/tests/functional/site/fixtures/en/article/titles/index.html b/tests/functional/site/fixtures/en/article/titles/index.html
@@ -16,12 +16,42 @@
         <div class="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10 prose">
             <h1>Titles!</h1>
             <p>19.07.2022. 12:11</p>
-            <h1>Title 1</h1>
-<h2>Title 2</h2>
-<h3>Title 3</h3>
-<h4>Title 4</h4>
-<h5>Title 5</h5>
-<h6>Title 6</h6>
+            <ul class="table-of-contents">
+<li>
+<a href="#content-title-1">Title 1</a>
+<ul>
+<li>
+<a href="#content-title-2">Title 2</a>
+<ul>
+<li>
+<a href="#content-title-3">Title 3</a>
+<ul>
+<li>
+<a href="#content-title-4">Title 4</a>
+<ul>
+<li>
+<a href="#content-title-5">Title 5</a>
+<ul>
+<li>
+<a href="#content-title-6">Title 6</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<h1><a id="content-title-1" href="#content-title-1" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Title 1</h1>
+<h2><a id="content-title-2" href="#content-title-2" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Title 2</h2>
+<h3><a id="content-title-3" href="#content-title-3" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Title 3</h3>
+<h4><a id="content-title-4" href="#content-title-4" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Title 4</h4>
+<h5><a id="content-title-5" href="#content-title-5" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Title 5</h5>
+<h6><a id="content-title-6" href="#content-title-6" class="heading-permalink" aria-hidden="true" title="Permalink">¶</a>Title 6</h6>
 
         </div>
     </div>