micromark-extension-gfm-strikethrough

Syntax-only micromark extension for parsing Obsidian-style inline footnotes.

Sentence.^[Footnote]

Note this extension does not extend the html compiler. Instead, this is intended to be used together with mdast-util-inline-footnote which includes a utility for converting inline footnotes to GFM footnote reference/definition pairs.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install micromark-extension-inline-footnote

In Deno with esm.sh:

import { inlineFootnote } from "https://esm.sh/micromark-extension-inline-footnote@1";

In browsers with esm.sh:

<script type="module">
	import { inlineFootnote } from "https://esm.sh/micromark-extension-gfm-strikethrough@1?bundle";
</script>

API

This package exports the identifier inlineFootnote. There is no default export.

The export map supports the development condition. Run node --conditions development module.js to get instrumented dev code. Without this condition, production code is loaded.

inlineFootnote()

Create an extension for micromark to enable inline footnote syntax.

Returns

Extension for micromark that can be passed in extensions, to enable inline footnotes (Extension).

Security

This package is safe.