From 31886a89ea4367842967835164e926b3653d1a09 Mon Sep 17 00:00:00 2001 From: Benjamin Bray Date: Sat, 8 May 2021 20:11:58 +0900 Subject: [PATCH] add npm badges to READMEs --- README.md | 3 +++ mdast-util-cite/README.md | 3 +++ micromark-extension-cite/README.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/README.md b/README.md index aa9830a..18c4657 100644 --- a/README.md +++ b/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) + 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 diff --git a/mdast-util-cite/README.md b/mdast-util-cite/README.md index f4a085c..5be1793 100644 --- a/mdast-util-cite/README.md +++ b/mdast-util-cite/README.md @@ -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. diff --git a/micromark-extension-cite/README.md b/micromark-extension-cite/README.md index 64957f5..88601ee 100644 --- a/micromark-extension-cite/README.md +++ b/micromark-extension-cite/README.md @@ -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).