mdat-plugin-example 1.0.5 → 2.0.0
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/dist/index.js +1 -2
- package/package.json +11 -10
- package/readme.md +10 -9
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mdat-plugin-example",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0",
|
|
4
4
|
"description": "Mdat rule plugin example template.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"markdown",
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
"email": "eric@ericmika.com",
|
|
21
21
|
"url": "https://ericmika.com"
|
|
22
22
|
},
|
|
23
|
+
"sideEffects": false,
|
|
23
24
|
"type": "module",
|
|
24
25
|
"exports": {
|
|
25
26
|
".": {
|
|
@@ -33,19 +34,19 @@
|
|
|
33
34
|
"dist/*"
|
|
34
35
|
],
|
|
35
36
|
"dependencies": {
|
|
36
|
-
"type-fest": "^5.
|
|
37
|
+
"type-fest": "^5.5.0"
|
|
37
38
|
},
|
|
38
39
|
"devDependencies": {
|
|
39
|
-
"@kitschpatrol/shared-config": "^
|
|
40
|
-
"@types/node": "~20.19.
|
|
41
|
-
"bumpp": "^
|
|
42
|
-
"mdat": "^
|
|
43
|
-
"tsdown": "^0.
|
|
40
|
+
"@kitschpatrol/shared-config": "^7.0.0",
|
|
41
|
+
"@types/node": "~20.19.37",
|
|
42
|
+
"bumpp": "^11.0.1",
|
|
43
|
+
"mdat": "^2.0.0",
|
|
44
|
+
"tsdown": "^0.21.7",
|
|
44
45
|
"typescript": "~5.9.3",
|
|
45
|
-
"vitest": "^4.
|
|
46
|
+
"vitest": "^4.1.2"
|
|
46
47
|
},
|
|
47
48
|
"peerDependencies": {
|
|
48
|
-
"mdat": "^
|
|
49
|
+
"mdat": "^2.0.0"
|
|
49
50
|
},
|
|
50
51
|
"engines": {
|
|
51
52
|
"node": ">=20.19.0"
|
|
@@ -62,6 +63,6 @@
|
|
|
62
63
|
"fix": "ksc fix",
|
|
63
64
|
"lint": "ksc lint",
|
|
64
65
|
"release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
|
|
65
|
-
"test": "vitest --no-file-parallelism"
|
|
66
|
+
"test": "vitest run --no-file-parallelism"
|
|
66
67
|
}
|
|
67
68
|
}
|
package/readme.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
|
|
2
|
-
|
|
3
1
|
<!-- title -->
|
|
4
2
|
|
|
5
3
|
# mdat-plugin-example
|
|
@@ -10,6 +8,7 @@
|
|
|
10
8
|
|
|
11
9
|
[](https://npmjs.com/package/mdat-plugin-example)
|
|
12
10
|
[](https://opensource.org/licenses/MIT)
|
|
11
|
+
[](https://github.com/kitschpatrol/mdat-plugin-example/actions/workflows/ci.yml)
|
|
13
12
|
|
|
14
13
|
<!-- /badges -->
|
|
15
14
|
|
|
@@ -48,21 +47,19 @@ pnpm add -D mdat-plugin-example
|
|
|
48
47
|
Register the plugin in your mdat config file, e.g. `mdat.config.ts`:
|
|
49
48
|
|
|
50
49
|
```ts
|
|
51
|
-
import
|
|
50
|
+
import { defineConfig } from 'mdat'
|
|
52
51
|
import examplePlugin from 'mdat-plugin-example'
|
|
53
52
|
|
|
54
|
-
export default {
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
},
|
|
58
|
-
} satisfies Config
|
|
53
|
+
export default defineConfig({
|
|
54
|
+
...examplePlugin,
|
|
55
|
+
})
|
|
59
56
|
```
|
|
60
57
|
|
|
61
58
|
## Usage
|
|
62
59
|
|
|
63
60
|
_A basic demonstration of the plugin's functionality goes here._
|
|
64
61
|
|
|
65
|
-
|
|
62
|
+
Add the comment keyword to your Markdown file:
|
|
66
63
|
|
|
67
64
|
```markdown
|
|
68
65
|
<!-- example -->
|
|
@@ -78,6 +75,10 @@ Hello from the [mdat](https://github.com/kitschpatrol/mdat) example plugin!
|
|
|
78
75
|
<!-- /example -->
|
|
79
76
|
```
|
|
80
77
|
|
|
78
|
+
## Compatibility
|
|
79
|
+
|
|
80
|
+
This plugin is compatible with versions of `mdat` matching the semver range defined in `peerDependencies`.
|
|
81
|
+
|
|
81
82
|
## Maintainers
|
|
82
83
|
|
|
83
84
|
[@kitschpatrol](https://github.com/kitschpatrol)
|