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
3030
3131This utility turns docblocks into tokens, and then turns those tokens into nodes. Markdown in docblocks is turned into
3232tokens 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.
3335
3436## When should I use this?
3537
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.
3742
3843## Install
3944
@@ -317,9 +322,11 @@ This package is fully typed with [TypeScript][typescript].
317322
318323See [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) .
319324
325+ [ docast-parse ] : https://github.com/flex-development/docast-parse
320326[ docast ] : https://github.com/flex-development/docast
321327[ docblock ] : https://github.com/flex-development/docast#docblock-comment
322328[ esm ] : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
323329[ mdast-util-from-markdown ] : https://github.com/syntax-tree/mdast-util-from-markdown
324330[ micromark ] : https://github.com/micromark/micromark
325331[ typescript ] : https://www.typescriptlang.org
332+ [ unified ] : https://github.com/unifiedjs/unified
You can’t perform that action at this time.
0 commit comments