File tree Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Expand file tree Collapse file tree 1 file changed +8
-4
lines changed Original file line number Diff line number Diff line change 10
10
[ ![ vitest] ( https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff )] ( https://vitest.dev/ )
11
11
[ ![ yarn] ( https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff )] ( https://yarnpkg.com/ )
12
12
13
- [ ** docast** ] [ docast ] utility that turns docblock comments into a syntax tree.
13
+ [ ** docast** ] [ docast ] utility that turns docblocks into a syntax tree.
14
14
15
15
## Contents
16
16
26
26
27
27
## What is this?
28
28
29
- This package is a utility that takes source documents and files containing [ docblock comments] [ docblock-comments ] and
30
- turns them into abstract syntax trees.
29
+ This package is a utility that takes [ docblock] [ docblock ] input and turns it into a [ docast] [ docast ] syntax tree.
30
+
31
+ This utility turns docblocks into tokens, and then turns those tokens into nodes. Markdown in docblocks is turned into
32
+ tokens using [ micromark] [ micromark ] , and turned into nodes using [ mdast-util-from-markdown] [ mdast-util-from-markdown ] .
31
33
32
34
## When should I use this?
33
35
@@ -79,6 +81,8 @@ This package is fully typed with [TypeScript][typescript].
79
81
See [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) .
80
82
81
83
[ docast ] : https://github.com/flex-development/docast
82
- [ docblock-comments ] : https://github.com/flex-development/docast#docblock-comment
84
+ [ docblock ] : https://github.com/flex-development/docast#docblock-comment
83
85
[ esm ] : https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
86
+ [ mdast-util-from-markdown ] : https://github.com/syntax-tree/mdast-util-from-markdown
87
+ [ micromark ] : https://github.com/micromark/micromark
84
88
[ typescript ] : https://www.typescriptlang.org
You can’t perform that action at this time.
0 commit comments