Skip to content

Commit 32c0064

Browse files
committed
docs: what is this?
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent 6b031b3 commit 32c0064

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)
1111
[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)
1212

13-
[**docast**][docast] utility that turns docblock comments into a syntax tree.
13+
[**docast**][docast] utility that turns docblocks into a syntax tree.
1414

1515
## Contents
1616

@@ -26,8 +26,10 @@
2626

2727
## What is this?
2828

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].
3133

3234
## When should I use this?
3335

@@ -79,6 +81,8 @@ This package is fully typed with [TypeScript][typescript].
7981
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
8082

8183
[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
8385
[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
8488
[typescript]: https://www.typescriptlang.org

0 commit comments

Comments
 (0)