From 9dad415458d18cfe7f120631e67f87757fa98dfa Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sun, 24 Oct 2021 09:47:19 +0200 Subject: [PATCH] Add syntax, syntax tree sections --- readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/readme.md b/readme.md index 96f3bd1..f684d60 100644 --- a/readme.md +++ b/readme.md @@ -23,6 +23,8 @@ such). * [Examples](#examples) * [Example: YouTube](#example-youtube) * [Example: Styled blocks](#example-styled-blocks) +* [Syntax](#syntax) +* [Syntax tree](#syntax-tree) * [Security](#security) * [Related](#related) * [Contribute](#contribute) @@ -285,6 +287,20 @@ Now, running `node example` yields: ``` +## 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 Use of `remark-directive` does not involve [**rehype**][rehype]