mdast-util-wikilink-syntax

mdast extensions to parse Obsidian-style wikilinks and embeds whose aliases/alt text can contain markdown. Intended to be used with micromark-extension-wikilink-syntax.

Since micromark-extension-wikilink-syntax is syntax-only, you will need to use something like unist-util-visit, to manually replace the outputted nodes in the syntax tree with ordinary markdown constructs.

Install

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

npm install micromark-extension-wikilink-syntax mdast-util-wikilink-syntax

In Deno with esm.sh:

import { wikilinkFromMarkdown } from "https://esm.sh/mdast-util-wikilink-syntax@1";

In browsers with esm.sh:

<script type="module">
	import { wikilinkFromMarkdown } from "https://esm.sh/mdast-util-wikilink-syntax12?bundle";
</script>

API

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

wikilinkFromMarkdown()

Create an extension for mdast-util-from-markdown to parse wikilink syntax in markdown.

Returns

Extension for mdast-util-from-markdown (FromMarkdownExtension).