pretty-toc 1.3.4 → 1.3.5

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 +37 -18
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,5 +1,10 @@
1
1
  [![CodeQL Advanced](https://github.com/Virgil-N/pretty-toc/actions/workflows/codeql.yml/badge.svg)](https://github.com/Virgil-N/pretty-toc/actions/workflows/codeql.yml)
2
+ [![Coverage](https://github.com/Virgil-N/pretty-toc/actions/workflows/coverage.yml/badge.svg)](https://github.com/Virgil-N/pretty-toc/actions/workflows/coverage.yml)
2
3
  [![Verify and Release](https://github.com/Virgil-N/pretty-toc/actions/workflows/verify-and-release.yml/badge.svg)](https://github.com/Virgil-N/pretty-toc/actions/workflows/verify-and-release.yml)
4
+ ![GitHub repo size](https://img.shields.io/github/repo-size/Virgil-N/pretty-toc)
5
+ ![NPM Downloads](https://img.shields.io/npm/dm/pretty-toc)
6
+ ![NPM Downloads](https://img.shields.io/npm/d18m/pretty-toc)
7
+ ![GitHub License](https://img.shields.io/github/license/Virgil-N/pretty-toc)
3
8
 
4
9
  A Table of Contents generation plugin for the Satteri markdown parser library.
5
10
 
@@ -24,26 +29,10 @@ deno add -D pretty-toc
24
29
 
25
30
  ## Table of Contents
26
31
 
27
- - [Screenshots](#Screenshots)
28
32
  - [Example](#Example)
33
+ - [Screenshots](#Screenshots)
29
34
  - [Options](#Options)
30
-
31
- ## Screenshots
32
-
33
- - icon
34
- ![](https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/with-icon.png)
35
-
36
- - image
37
- ![](https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/with-image.png)
38
-
39
- - dot
40
- ![](https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/use-dot.png)
41
-
42
- - decimal
43
- ![](https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/use-decimal.png)
44
-
45
- - nested image
46
- ![](https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/use-multiple-image.png)
35
+ - [Contribution](#Contribution)
47
36
 
48
37
  ## Example
49
38
 
@@ -115,6 +104,32 @@ processor: satteri({
115
104
  }),
116
105
  ```
117
106
 
107
+ <details id="Screenshots">
108
+ <summary>Screenshots</summary>
109
+ <ol>
110
+ <li>
111
+ <p>icon</p>
112
+ <img src="https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/with-icon.png" />
113
+ </li>
114
+ <li>
115
+ <p>image</p>
116
+ <img src="https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/with-image.png" />
117
+ </li>
118
+ <li>
119
+ <p>dot</p>
120
+ <img src="https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/use-dot.png" />
121
+ </li>
122
+ <li>
123
+ <p>decimal</p>
124
+ <img src="https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/use-decimal.png" />
125
+ </li>
126
+ <li>
127
+ <p>nested image</p>
128
+ <img src="https://github.com/Virgil-N/resource/blob/main/image/pretty-toc/use-multiple-image.png" />
129
+ </li>
130
+ </ol>
131
+ </details>
132
+
118
133
  ## Options
119
134
 
120
135
  | Property‌ | Type | Default Value | Preset Value | Description |
@@ -136,3 +151,7 @@ processor: satteri({
136
151
  | style | Object{title?: string, ul?: string, li?: string, a?: string} or or undefined | undefined | undefined | eg. {a: "font-style: italic;"} |
137
152
  | 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
153
  | 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": "目次"} |
154
+
155
+ ## Contribution
156
+
157
+ If you see any errors or room for improvement on this plugin, feel free to open an [issues](https://github.com/Virgil-N/pretty-toc/issues) or [pull request](https://github.com/Virgil-N/pretty-toc/pulls) . Thank you in advance for contributing!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pretty-toc",
3
- "version": "1.3.4",
3
+ "version": "1.3.5",
4
4
  "type": "module",
5
5
  "description": "A Table of Contents generation plugin for the Satteri markdown parser library.",
6
6
  "keywords": [
@@ -56,9 +56,10 @@
56
56
  "@rollup/plugin-url": "^8.0.2",
57
57
  "@types/hast": "^3.0.5",
58
58
  "@types/node": "^26.4.1",
59
+ "@vitest/coverage-v8": "^4.1.12",
59
60
  "bumpp": "^11.1.0",
60
61
  "tsdown": "^0.22.5",
61
62
  "typescript": "^7.0.2",
62
- "vitest": "^4.1.10"
63
+ "vitest": "^4.1.12"
63
64
  }
64
65
  }