Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
micromark-extension-wiki-link
Advanced tools
This micromark extension parses and renders [[Wiki Links]]
.
[[Real Page:Page Alias]]
Using remark? You might want to use
remark-wiki-link
instead of using this package directly.
import { syntax, html } from 'micromark-extension-wiki-link';
let serialized = micromark('[[Wiki Link]]', {
extensions: [syntax()],
htmlExtensions: [html()]
});
console.log(serialized);
// <p><a href="#/page/wiki_link" class="internal">Wiki Link</a></p>
Both the syntax extension and html extension can be configured by passing an object.
For example, one may configure the syntax extension like so:
let serialized = micromark('[[Wiki Link]]', {
extensions: [syntax({ aliasDivider: "|" })],
htmlExtensions: [html()]
});
syntax
options.aliasDivider [String]
: a string to be used as the divider for aliases. See the section below on Aliasing pages. Defaults to ":"
.html
options.permalinks [String]
: An array of permalinks that should be considered existing pages. If a wiki link is parsed and its permalink matches one of these permalinks, node.data.exists
will be true.
options.pageResolver (pageName: String) -> [String]
: A function that maps a page name to an array of possible permalinks. These possible permalinks are cross-referenced with options.permalinks
to determine whether a page exists. If a page doesn't exist, the first element of the array is considered the permalink.
The default pageResolver
is:
(name) => [name.replace(/ /g, '_').toLowerCase()]
options.hrefTemplate (permalink: String) -> String
: A function that maps a permalink to some path. This path is used as the href
for the rendered a
.
The default hrefTemplate
is:
(permalink) => `#/page/${permalink}`
options.wikiLinkClassName [String]
: a class name that is attached to any rendered wiki links. Defaults to "internal"
.options.newClassName [String]
: a class name that is attached to any rendered wiki links that do not exist. Defaults to "new"
.Aliased pages are supported with the following markdown syntax:
[[Real Page:Page Alias]]
And will produce this HTML when rendered:
<a class="internal new" href="#/page/real_page">Page Alias</a>
FAQs
Parse and render wiki-style links
The npm package micromark-extension-wiki-link receives a total of 1,887 weekly downloads. As such, micromark-extension-wiki-link popularity was classified as popular.
We found that micromark-extension-wiki-link demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.