Skip to content

Commit

Permalink
update links ; fix badge in remark-cite
Browse files Browse the repository at this point in the history
  • Loading branch information
benrbray committed May 8, 2021
1 parent 31886a8 commit 4d88bee
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 3 additions & 0 deletions remark-cite/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)

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.
Expand Down

0 comments on commit 4d88bee

Please sign in to comment.