We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 992fcfa commit 764a2c9Copy full SHA for 764a2c9
readme.md
@@ -3,3 +3,29 @@
3
A table of contents for use with [bit-docs-generate-html](https://github.com/bit-docs/bit-docs-generate-html).
4
5

6
+
7
+## Use
8
9
+To use, add bit-docs-html-toc to your bit-docs dependencies in package.json:
10
11
+```json
12
+{
13
+ ...
14
15
+ "bit-docs": {
16
+ "dependencies": {
17
+ "bit-docs-html-toc": "$VERSION"
18
+ }
19
20
+}
21
+```
22
23
+Where `$VERSION` is the latest version on npm.
24
25
+In your template add a class **on-this-page-container**:
26
27
+```js
28
+<div class="on-this-page-container"></div>
29
30
31
+The table of contents will be injected into this element at run time.
0 commit comments