Skip to content

Commit 7b44858

Browse files
committed
docs: "when should i use this?"
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 4ea7b78 commit 7b44858

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,15 @@ tree][2].
3030

3131
## When should I use this?
3232

33-
**TODO**: Update documentation.
33+
This plugin adds support to [unified][1] for parsing docblock comments.
34+
35+
Unlike [JSDoc][3], [TSDoc][4], or [typedoc][5], this plugin **does not enforce tag semantics** &mdash; the user does.
36+
Tag specifications can be left to an [ESLint][6] rule or setting akin to [`jsdoc/check-tag-names`][7] or
37+
[`jsdoc.structuredTags`][8].
3438

3539
## Install
3640

37-
This package is [ESM only][3].
41+
This package is [ESM only][9].
3842

3943
```sh
4044
yarn add @flex-development/docast-parse
@@ -123,8 +127,7 @@ async function dblLinear(n: number): Promise<number> {
123127
export default dblLinear
124128
```
125129

126-
We just discovered [VitePress][4]. We want to [create a documentation site
127-
without duplicating documentation][5]:
130+
We just discovered [VitePress][10]. We want to [create a documentation site without duplicating documentation][11]:
128131

129132
```typescript
130133
import type { Root } from '@flex-development/docast'
@@ -272,15 +275,21 @@ The syntax tree format is [docast][2].
272275

273276
## Types
274277

275-
This package is fully typed with [TypeScript][6].
278+
This package is fully typed with [TypeScript][12].
276279

277280
## Contribute
278281

279282
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
280283

281284
[1]: https://github.com/unifiedjs/unified
282285
[2]: https://github.com/flex-development/docast
283-
[3]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
284-
[4]: https://vitepress.vuejs.org
285-
[5]: https://github.com/vuejs/vitepress/issues/1316
286-
[6]: https://www.typescriptlang.org
286+
[3]: https://jsdoc.app/
287+
[4]: https://tsdoc.org/
288+
[5]: https://github.com/TypeStrong/typedoc
289+
[6]: https://eslint.org/
290+
[7]: https://github.com/gajus/eslint-plugin-jsdoc#check-tag-names
291+
[8]: https://github.com/gajus/eslint-plugin-jsdoc#structuredtags
292+
[9]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
293+
[10]: https://vitepress.vuejs.org
294+
[11]: https://github.com/vuejs/vitepress/issues/1316
295+
[12]: https://www.typescriptlang.org

0 commit comments

Comments
 (0)