pretty-toc 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,13 +3,13 @@ A Table of Contents generation plugin for the Satteri markdown parser library.
|
|
|
3
3
|
## Install
|
|
4
4
|
|
|
5
5
|
```
|
|
6
|
-
npm install pretty-toc
|
|
6
|
+
npm install pretty-toc --save-dev
|
|
7
7
|
```
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
11
11
|
```javascript
|
|
12
|
-
import prettyToc from 'pretty-toc'
|
|
12
|
+
import prettyToc from 'pretty-toc';
|
|
13
13
|
|
|
14
14
|
satteri({
|
|
15
15
|
hastPlugins: [prettyToc({title: "Table of Contents", listStyle: "decimal"})]
|
|
@@ -29,9 +29,15 @@ processor: satteri({
|
|
|
29
29
|
prettyToc({
|
|
30
30
|
title: "Table of Contents",
|
|
31
31
|
listStyle: "image", // disc, circle, decimal, none... icon, image...
|
|
32
|
-
icon: ["🐶", "🦁", "🐷", "🐸", "🐥", "🐞"],
|
|
33
|
-
image:
|
|
34
|
-
"
|
|
32
|
+
icon: ["🐶", "🦁", "🐷", "🐸", "🐥", "🐞"], // or just a string, eg. "🐥"
|
|
33
|
+
image: [
|
|
34
|
+
"/svg/unjs--automd.svg",
|
|
35
|
+
"/svg/unjs--hookable.svg",
|
|
36
|
+
"/svg/unjs--knitwork.svg",
|
|
37
|
+
"/svg/unjs--mongoz.svg",
|
|
38
|
+
"/svg/unjs--ofetch.svg",
|
|
39
|
+
"/svg/unjs--uncrypto.svg",
|
|
40
|
+
], // or just a string, eg. "/svg/unjs--automd.svg"
|
|
35
41
|
markerCssSize: "1rem",
|
|
36
42
|
lightThemeHighlightColor: "oklch(0.75 0.1229 12.71)",
|
|
37
43
|
darkThemeHighlightColor: "oklch(0.81 0.1004 305.04)",
|