Add TOC feature to articles (#2554)

sinonjs · Oct 18, 2023 · f0d250b · f0d250b
1 parent 737736f
commit f0d250b
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 1 deletion.
diff --git a/Gemfile b/Gemfile
@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 gem 'github-pages', group: :jekyll_plugins
 gem "jekyll", "~> 3.7"
 gem 'jekyll-sitemap'
+gem 'jekyll-toc'
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -190,6 +190,9 @@ GEM
       jekyll-seo-tag (~> 2.0)
     jekyll-titles-from-headings (0.5.3)
       jekyll (>= 3.3, < 5.0)
+    jekyll-toc (0.18.0)
+      jekyll (>= 3.9)
+      nokogiri (~> 1.12)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     jemoji (0.12.0)
@@ -262,6 +265,7 @@ DEPENDENCIES
   github-pages
   jekyll (~> 3.7)
   jekyll-sitemap
+  jekyll-toc
 
 BUNDLED WITH
    1.17.3
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -17,6 +17,7 @@ plugins:
   - jekyll-feed
   - jekyll-redirect-from
   - jekyll-sitemap
+  - jekyll-toc
 keep_files:
   - assets
   - releases

diff --git a/docs/_howto/typescript-swc.md b/docs/_howto/typescript-swc.md
@@ -1,6 +1,7 @@
 ---
 layout: page
 title: "Case study: real world dependency stubbing"
+toc: true
 ---
 
 Sinon is a simple tool that only tries to do a few things and do them well: creating and injecting test doubles (spies, fakes, stubs) into objects. Unfortunately, in todays world of build pipelines, complex tooling, transpilers and different module systems, doing the simple thing quickly becomes difficult.

diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
@@ -21,7 +21,7 @@ <h1 class="post-title">{{ page.title }}</h1>
             <div>{% include carbonads.html %}</div>
         {% endif %}
 
-        {{ content }}
+        {{ content | toc }}
     </div>
 
 </article>