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

Update docs

Browse source
This commit is contained in:
Titus Wormer 2021-10-26 22:24:44 +02:00
parent bddb81b066
commit c369fcb50b
No known key found for this signature in database
GPG key ID: E6E581152ED04E2E
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
readme.md
View file

@ -39,12 +39,13 @@ one syntax for arbitrary extensions in markdown.
You can use this with some more code to match your specific needs, to allow for You can use this with some more code to match your specific needs, to allow for
anything from callouts, citations, styled blocks, forms, embeds, spoilers, etc. anything from callouts, citations, styled blocks, forms, embeds, spoilers, etc.
unified is an AST (abstract syntax tree) based transform project. **unified** is a project that transforms content with abstract syntax trees
**remark** is everything unified that relates to markdown. (ASTs).
The layer under remark is called mdast, which is only concerned with syntax **remark** adds support for markdown to unified.
trees. **mdast** is the markdown AST that remark uses.
Another layer underneath is micromark, which is only concerned with parsing. **micromark** is the markdown parser we use.
This package is a small wrapper to integrate all of these. This is a remark plugin that adds support for the directives syntax and AST to
remark.
## When should I use this? ## When should I use this?
@ -63,7 +64,7 @@ and static site generators.
## Install ## Install
This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
In Node.js (12.20+, 14.14+, 16.0+), install with [npm][]: In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
```sh ```sh
npm install remark-directive npm install remark-directive
@ -327,7 +328,7 @@ versions of Node.js.
As of now, that is Node.js 12.20+, 14.14+, and 16.0+. As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
Our projects sometimes work with older versions, but this is not guaranteed. Our projects sometimes work with older versions, but this is not guaranteed.
This plugin works with unified 9+ and remark 14+. This plugin works with unified version 9+ and remark version 14+.
## Security ## Security