HidemaruOwO/remark-directive
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add syntax, syntax tree sections

Browse source
This commit is contained in:
Titus Wormer 2021-10-24 09:47:19 +02:00
parent 46e9c26ff5
commit 9dad415458
No known key found for this signature in database
GPG key ID: E6E581152ED04E2E
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
readme.md
View file

@ -23,6 +23,8 @@ such).
* [Examples](#examples) * [Examples](#examples)
* [Example: YouTube](#example-youtube) * [Example: YouTube](#example-youtube)
* [Example: Styled blocks](#example-styled-blocks) * [Example: Styled blocks](#example-styled-blocks)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Security](#security) * [Security](#security)
* [Related](#related) * [Related](#related)
* [Contribute](#contribute) * [Contribute](#contribute)
@ -285,6 +287,20 @@ Now, running `node example` yields:
</div> </div>
``` ```
## Syntax
This plugin applies a micromark extensions to parse the syntax.
See its readme for parse details:
* [`micromark-extension-directive`](https://github.com/micromark/micromark-extension-directive#syntax)
## Syntax tree
This plugin applies a mdast utility to build and serialize the AST.
See its readme for the node types supported in the tree:
* [`mdast-util-directive`](https://github.com/syntax-tree/mdast-util-directive#syntax-tree)
## Security ## Security
Use of `remark-directive` does not involve [**rehype**][rehype] Use of `remark-directive` does not involve [**rehype**][rehype]