File tree Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -30,10 +30,15 @@ This package is a utility that takes [docblock][docblock] input and turns it int
30
30
31
31
This utility turns docblocks into tokens, and then turns those tokens into nodes. Markdown in docblocks is turned into
32
32
tokens using [ micromark] [ micromark ] , and turned into nodes using [ mdast-util-from-markdown] [ mdast-util-from-markdown ] .
33
+ This package is also the backbone of [ ` docast-parse ` ] [ docast-parse ] , a [ ** unified** ] [ unified ] compliant file parser that
34
+ focuses on making it easier to transform docblocks by abstracting these internals away.
33
35
34
36
## When should I use this?
35
37
36
- ** TODO** : when should i use this?
38
+ ** TODO** : ecosystem
39
+
40
+ If you want to handle syntax trees manually, use this. For an easier time processing docblocks, use
41
+ [ ` docast-parse ` ] [ docast-parse ] instead.
37
42
38
43
## Install
39
44
@@ -317,9 +322,11 @@ This package is fully typed with [TypeScript][typescript].
317
322
318
323
See [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) .
319
324
325
+ [ docast-parse ] : https://github.com/flex-development/docast-parse
320
326
[ docast ] : https://github.com/flex-development/docast
321
327
[ docblock ] : https://github.com/flex-development/docast#docblock-comment
322
328
[ esm ] : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
323
329
[ mdast-util-from-markdown ] : https://github.com/syntax-tree/mdast-util-from-markdown
324
330
[ micromark ] : https://github.com/micromark/micromark
325
331
[ typescript ] : https://www.typescriptlang.org
332
+ [ unified ] : https://github.com/unifiedjs/unified
You can’t perform that action at this time.
0 commit comments