pretty-toc 1.3.2 → 1.3.3
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 +24 -24
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,19 +31,19 @@ deno add -D pretty-toc
|
|
|
31
31
|
## Screenshots
|
|
32
32
|
|
|
33
33
|
- icon
|
|
34
|
-

|
|
34
|
+

|
|
35
35
|
|
|
36
36
|
- image
|
|
37
|
-

|
|
37
|
+

|
|
38
38
|
|
|
39
39
|
- dot
|
|
40
|
-

|
|
40
|
+

|
|
41
41
|
|
|
42
42
|
- decimal
|
|
43
|
-

|
|
43
|
+

|
|
44
44
|
|
|
45
45
|
- nested image
|
|
46
|
-

|
|
46
|
+

|
|
47
47
|
|
|
48
48
|
## Example
|
|
49
49
|
|
|
@@ -117,22 +117,22 @@ processor: satteri({
|
|
|
117
117
|
|
|
118
118
|
## Options
|
|
119
119
|
|
|
120
|
-
|Property
|
|
121
|
-
|
|
122
|
-
|title|string|Table of Contents|Table of Contents
|
|
123
|
-
|openedMarker|string or undefined|undefined
|
|
124
|
-
|closedMarker|string or undefined|undefined
|
|
125
|
-
|titleMarkerType|string or undefined|undefined|icon|Value can only be "icon" or "image"
|
|
126
|
-
|titleMarkerCssSize|string or undefined|undefined|fit-content
|
|
127
|
-
|listStyle|string or undefined|undefined|decimal|eg. disc, circle, decimal, none... or icon and image|
|
|
128
|
-
|icon|string or string[] or undefined|undefined|decimal|listStyle must already be set
|
|
129
|
-
|image|string or string[] or undefined|undefined|404 image|listStyle must already be set
|
|
130
|
-
|liMarkerCssSize|string or undefined|undefined|1rem|CSS property value|
|
|
131
|
-
|lightThemeHighlightColor|string or undefined|undefined|oklch(0.75 0.1229 12.71)
|
|
132
|
-
|darkThemeHighlightColor|string or undefined|undefined|oklch(0.81 0.1004 305.04)
|
|
133
|
-
|animation|boolean or { duration: string, timingFunction: string } or undefined|undefined|{ duration: "0.8s", timingFunction: 'ease-in-out' }
|
|
134
|
-
|class|{title?: string, ul?: string, li?: string, a?: string} or or undefined|undefined|undefined|eg. {li: "py-1"}|
|
|
135
|
-
|globalStyle|string or or undefined|undefined|undefined|eg. "ul {background-color: yellow;}"|
|
|
136
|
-
|style|Object{title?: string, ul?: string, li?: string, a?: string} or or undefined|undefined|undefined|eg. {a: "font-style: italic;"}|
|
|
137
|
-
|locale|string or undefined|undefined|en-US|eg. "zh-CN" // **Note: The case of the locale variable should match the locale in your page URL
|
|
138
|
-
|languageMap|Record<string, string> or undefined|undefined|{"de-DE": "Inhaltsverzeichnis","el-GR": "Περιεχόμενα","en-US": "Contents","es-ES": "Índice","fr-FR": "Sommaire","it-IT": "Indice","ja-JP": "目次","ko-KR": "목차","ru-RU": "Оглавление","th-TH": "สารบัญ","tr-TR": "İçindekiler","zh-CN": "目录","zh-Hant": "目錄"}|eg. {"en-US": "Table of Contents", "ja-JP": "目次"}|
|
|
120
|
+
| Property | Type | Default Value | Preset Value | Description |
|
|
121
|
+
| :----------------------- | :--------------------------------------------------------------------------- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------- |
|
|
122
|
+
| title | string | Table of Contents | Table of Contents | - |
|
|
123
|
+
| openedMarker | string or undefined | undefined | ▼ | _**Note: titleMarkerType must already be set.**_ |
|
|
124
|
+
| closedMarker | string or undefined | undefined | ▶︎ | _**Note: titleMarkerType must already be set.**_ |
|
|
125
|
+
| titleMarkerType | string or undefined | undefined | icon | Value can only be "icon" or "image". |
|
|
126
|
+
| titleMarkerCssSize | string or undefined | undefined | fit-content | - |
|
|
127
|
+
| listStyle | string or undefined | undefined | decimal | eg. disc, circle, decimal, none... or icon and image |
|
|
128
|
+
| icon | string or string[] or undefined | undefined | decimal | _**Note: listStyle must already be set.**_ |
|
|
129
|
+
| image | string or string[] or undefined | undefined | 404 image | _**Note: listStyle must already be set.**_ |
|
|
130
|
+
| liMarkerCssSize | string or undefined | undefined | 1rem | CSS property value |
|
|
131
|
+
| lightThemeHighlightColor | string or undefined | undefined | oklch(0.75 0.1229 12.71) | - |
|
|
132
|
+
| darkThemeHighlightColor | string or undefined | undefined | oklch(0.81 0.1004 305.04) | - |
|
|
133
|
+
| animation | boolean or { duration: string, timingFunction: string } or undefined | undefined | { duration: "0.8s", timingFunction: 'ease-in-out' } | - |
|
|
134
|
+
| class | {title?: string, ul?: string, li?: string, a?: string} or or undefined | undefined | undefined | eg. {li: "py-1"} |
|
|
135
|
+
| globalStyle | string or or undefined | undefined | undefined | eg. "ul {background-color: yellow;}" |
|
|
136
|
+
| style | Object{title?: string, ul?: string, li?: string, a?: string} or or undefined | undefined | undefined | eg. {a: "font-style: italic;"} |
|
|
137
|
+
| locale | string or undefined | undefined | en-US | eg. "zh-CN" // **Note: The case of the locale variable should match the locale in your page URL.** |
|
|
138
|
+
| languageMap | Record<string, string> or undefined | undefined | {"de-DE": "Inhaltsverzeichnis","el-GR": "Περιεχόμενα","en-US": "Contents","es-ES": "Índice","fr-FR": "Sommaire","it-IT": "Indice","ja-JP": "目次","ko-KR": "목차","ru-RU": "Оглавление","th-TH": "สารบัญ","tr-TR": "İçindekiler","zh-CN": "目录","zh-Hant": "目錄"} | eg. {"en-US": "Table of Contents", "ja-JP": "目次"} |
|
package/dist/index.mjs
CHANGED