Skip to content

Commit

Permalink
add npm badges to READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
benrbray committed May 8, 2021
1 parent 7b000b6 commit 31886a8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

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
Expand Down
3 changes: 3 additions & 0 deletions mdast-util-cite/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# `mdast-util-cite`

[![](https://img.shields.io/npm/v/@benrbray/mdast-util-cite?style=flat-square)](https://www.npmjs.com/package/@benrbray/mdast-util-cite)
![license](https://img.shields.io/github/license/benrbray/remark-cite?style=flat-square)

Extension for [`mdast-util-from-markdown`](https://github.com/syntax-tree/mdast-util-from-markdown) and
[`mdast-util-to-markdown`](https://github.com/syntax-tree/mdast-util-to-markdown) to support [`pandoc`-style](https://pandoc.org/MANUAL.html#extension-citations) citations. Converts the token stream produced by [`micromark-extension-cite`](https://github.com/benrbray/remark-cite/tree/master/micromark-extension-cite) into an abstract syntax tree.

Expand Down
3 changes: 3 additions & 0 deletions micromark-extension-cite/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# `micromark-extension-cite`

[![](https://img.shields.io/npm/v/@benrbray/micromark-extension-cite?style=flat-square)](https://www.npmjs.com/package/@benrbray/micromark-extension-cite)
![license](https://img.shields.io/github/license/benrbray/remark-cite?style=flat-square)

A **[`micromark`](https://github.com/micromark/micromark)** syntax extension for [`pandoc`-style](https://pandoc.org/MANUAL.html#extension-citations) citations, providing the low-level modules for integrating with the micromark tokenizer and the micromark HTML compiler.

You probably shouldn’t use this package directly, but instead use [`mdast-util-cite`](https://github.com/benrbray/remark-cite/tree/master/mdast-util-cite) with [mdast](https://github.com/syntax-tree/mdast) or [`remark-cite`](https://github.com/benrbray/remark-cite/tree/master/remark-cite) with [remark](https://github.com/remarkjs/remark).
Expand Down

0 comments on commit 31886a8

Please sign in to comment.