diff --git a/README.md b/README.md index 18c4657..15ad555 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,10 @@ # `remark-cite` -[![](https://img.shields.io/npm/v/@benrbray/remark-cite?style=flat-square)](https://www.npmjs.com/package/@benrbray/remark-cite) -![license](https://img.shields.io/github/license/benrbray/remark-cite?style=flat-square) - Following [convention](https://github.com/micromark/micromark/discussions/56), this repository contains **three separate `npm` packages** related to support for [`pandoc`-style](https://pandoc.org/MANUAL.html#extension-citations) citation syntax for the `remark` Markdown parser. -* `micromark-extension-cite` defines a new [syntax extension](https://github.com/micromark/micromark#syntaxextension) for `micromark`, which is responsible for converting markdown syntax to a token stream -* `mdast-util-cite` describes how to convert tokens output by `micromark-extension-cite` into either an HTML string or `mdast` syntax tree. -* `remark-cite` encapsulates the above functionality into a `remark` plugin. +* [`micromark-extension-cite`](https://www.npmjs.com/package/@benrbray/micromark-extension-cite) defines a new [syntax extension](https://github.com/micromark/micromark#syntaxextension) for `micromark`, which is responsible for converting markdown syntax to a token stream +* [`mdast-util-cite`](https://www.npmjs.com/package/@benrbray/mdast-util-cite) describes how to convert tokens output by `micromark-extension-cite` into either an HTML string or `mdast` syntax tree. +* [`remark-cite`](https://www.npmjs.com/package/@benrbray/remark-cite) encapsulates the above functionality into a `remark` plugin. For more information, see the individual folders for each package. diff --git a/remark-cite/README.md b/remark-cite/README.md index 1cf1625..68bbe36 100644 --- a/remark-cite/README.md +++ b/remark-cite/README.md @@ -1,5 +1,8 @@ # `remark-cite` +[![](https://img.shields.io/npm/v/@benrbray/remark-cite?style=flat-square)](https://www.npmjs.com/package/@benrbray/remark-cite) +![license](https://img.shields.io/github/license/benrbray/remark-cite?style=flat-square) + Plugin for [`remark`](https://github.com/remarkjs/remark) to support [`pandoc`-style](https://pandoc.org/MANUAL.html#extension-citations) citations. Relies on [`micromark-extension-cite`](https://github.com/benrbray/remark-cite/tree/master/micromark-extension-cite) for tokenization and [`mdast-util-cite`](https://github.com/benrbray/remark-cite/tree/master/mdast-util-cite) for converting markdown to/from abstract syntax trees. Note that this extension only parses the input -- it is up to you to assign meaning to these citations by looking up each key in a `.bibtex` file or other tagged citation database.