Support for readme TOC

m-ld · Aug 1, 2020 · 90b4d34 · 90b4d34
1 parent dd9bd2f
commit 90b4d34
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -46,6 +46,7 @@
   "keywords": [
     "typescript",
     "documentation",
-    "generator"
+    "generator",
+    "typedocplugin"
   ]
 }
diff --git a/src/minimal/layouts/default.hbs b/src/minimal/layouts/default.hbs
@@ -14,6 +14,12 @@
 
 <nav class="tsd-navigation secondary">
     <ul>
+        {{#if settings.readmeToc}}
+            {{#each settings.readmeToc}}
+                {{> toc}}
+            {{/each}}
+            <hr>
+        {{/if}}
         {{#each toc.children}}
             {{> toc}}
         {{/each}}

diff --git a/src/plugin.js b/src/plugin.js
@@ -0,0 +1,7 @@
+module.exports = host => {
+  host.owner.options.addDeclaration({
+    help: 'Readme TOC',
+    name: 'readmeToc',
+    type: 4 // Mixed (no conversion)
+  });
+};