From c369fcb50bc5f0103fec220ddce43a385eeb6123 Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Tue, 26 Oct 2021 22:24:44 +0200 Subject: [PATCH] Update docs --- readme.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/readme.md b/readme.md index 700f94e..31a73a3 100644 --- a/readme.md +++ b/readme.md @@ -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 anything from callouts, citations, styled blocks, forms, embeds, spoilers, etc. -unified is an AST (abstract syntax tree) based transform project. -**remark** is everything unified that relates to markdown. -The layer under remark is called mdast, which is only concerned with syntax -trees. -Another layer underneath is micromark, which is only concerned with parsing. -This package is a small wrapper to integrate all of these. +**unified** is a project that transforms content with abstract syntax trees +(ASTs). +**remark** adds support for markdown to unified. +**mdast** is the markdown AST that remark uses. +**micromark** is the markdown parser we use. +This is a remark plugin that adds support for the directives syntax and AST to +remark. ## When should I use this? @@ -63,7 +64,7 @@ and static site generators. ## Install 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 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+. 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