pretty-toc 0.1.5 → 0.1.6

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.
Files changed (2) hide show
  1. package/README.md +19 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,20 +11,13 @@ npm install pretty-toc --save-dev
11
11
  ```javascript
12
12
  import prettyToc from 'pretty-toc';
13
13
 
14
+ // example
14
15
  satteri({
15
16
  hastPlugins: [prettyToc({title: "Table of Contents", listStyle: "decimal"})]
16
17
  })
17
- ```
18
-
19
- ## options
20
18
 
21
- ```javascript
22
- // config file
19
+ // Full example
23
20
  processor: satteri({
24
- features: {
25
- directive: true,
26
- math: true,
27
- },
28
21
  hastPlugins: [
29
22
  prettyToc({
30
23
  title: "Table of Contents",
@@ -74,3 +67,20 @@ processor: satteri({
74
67
  ],
75
68
  }),
76
69
  ```
70
+
71
+ ## options
72
+
73
+ |Property‌|Type|Info|
74
+ |:---|:---|:---|
75
+ |title|string|-|
76
+ |listStyle|string|eg. disc, circle, decimal, none... or icon and image|
77
+ |icon|string or string[]|-|
78
+ |image|string or string[]|-|
79
+ |markerCssSize|string|CSS property value|
80
+ |lightThemeHighlightColor|string|eg. "oklch(0.75 0.1229 12.71)"|
81
+ |darkThemeHighlightColor|string|eg. "oklch(0.81 0.1004 305.04)"|
82
+ |class|{summary?: string, ul?: string, li?: string, a?: string}|eg. {summary: "pb-2", li: "py-1"}|
83
+ |globalStyle|string|-|
84
+ |style|Object{summary?: string, ul?: string, li?: string, a?: string}||
85
+ |locale|string|eg. "zh-CN" // **Note: The case of the locale variable should match the locale in your page URL.**|
86
+ |languageMap|Record<string, string>|eg. {"en-US": "Table of Contents", "ja-JP": "目次"}|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pretty-toc",
3
- "version": "0.1.5",
3
+ "version": "0.1.6",
4
4
  "type": "module",
5
5
  "description": "A Table of Contents generation plugin for the Satteri markdown parser library.",
6
6
  "keywords": [