do11y 0.2.3 → 0.2.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 +5 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
A bare-bones tool to document Vue components.
|
|
4
4
|
|
|
5
|
+
> [!WARNING]
|
|
6
|
+
> This is a small personal project! I make a lot of component libraries for personal projects and I absolutely love, love, love writing documentation for components, and I intend for this to be a mix of some of the features I love from [VitePress](https://vitepress.dev) and [Histoire](https://histoire.dev). Issues and thoughts and contributions are very welcome! But it is, again, a _personal_ project 😊
|
|
7
|
+
|
|
5
8
|
## Features
|
|
6
9
|
|
|
7
10
|
### Markdown components with [@mdit-vue](https://github.com/mdit-vue/mdit-vue).
|
|
@@ -44,10 +47,10 @@ Document components through meta imports (`Button.vue?meta`) which give a simpli
|
|
|
44
47
|
|
|
45
48
|
## Options
|
|
46
49
|
|
|
47
|
-
Expected
|
|
50
|
+
Expected as the default export in `docs/do11y/do11y.ts`.
|
|
48
51
|
|
|
49
52
|
```ts
|
|
50
|
-
|
|
53
|
+
interface Options {
|
|
51
54
|
/**
|
|
52
55
|
* The home page.
|
|
53
56
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "do11y",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.4",
|
|
4
4
|
"description": "A bare-bones tool to document Vue components.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs-generator",
|
|
@@ -33,6 +33,7 @@
|
|
|
33
33
|
"@shikijs/langs": "^3.22.0",
|
|
34
34
|
"@shikijs/themes": "^3.22.0",
|
|
35
35
|
"@shikijs/transformers": "^3.22.0",
|
|
36
|
+
"@types/markdown-it": "^14.1.2",
|
|
36
37
|
"front-matter": "^4.0.2",
|
|
37
38
|
"jsdom": "^28.1.0",
|
|
38
39
|
"markdown-it": "^14.1.1",
|
|
@@ -46,7 +47,6 @@
|
|
|
46
47
|
"devDependencies": {
|
|
47
48
|
"@tsconfig/node24": "^24.0.4",
|
|
48
49
|
"@types/jsdom": "^27.0.0",
|
|
49
|
-
"@types/markdown-it": "^14.1.2",
|
|
50
50
|
"@types/markdown-it-attrs": "^4.1.3",
|
|
51
51
|
"@types/node": "24.10.3",
|
|
52
52
|
"@vue/tsconfig": "^0.8.1",
|