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.
mdast-util-wiki-link
Advanced tools
Extension for mdast-util-from-markdown
and
mdast-util-to-markdown
to support [[Wiki Links]]
.
[[Real Page:Page Alias]]
Using remark? You might want to use
remark-wiki-link
instead of using this package directly.
import fromMarkdown from 'mdast-util-from-markdown'
import { syntax } from 'micromark-extension-wiki-link'
import * as wikiLink from 'mdast-util-wiki-link'
let ast = fromMarkdown('[[Test Page]]', {
extensions: [syntax()],
mdastExtensions: [wikiLink.fromMarkdown()]
})
The AST node will look like this:
{
value: 'Test Page',
data: {
alias: 'Test Page',
permalink: 'test_page',
exists: false,
hName: 'a',
hProperties: {
className: 'internal new',
href: '#/page/test_page'
},
hChildren: [{
type: 'text',
value: 'Test Page'
}]
}
}
data.alias
: The display name for this linkdata.permalink
: The permalink for this page. This permalink is computed from node.value
using options.pageResolver
, which can be passed in when initializing the plugin.data.exists
: Whether the page exists. A page exists if its permalink is found in options.permalinks
, passed when initializing the plugin.data.hProperties.className
: Classes that are automatically attached to the a
when it is rendered as HTML. These are configurable with options.wikiLinkClassName
and options.newClassName
. options.newClassName
is attached when data.exists
is false.data.hProperties.href
: href
value for the rendered a
. This href
is computed using options.hrefTemplate
.The hName
and other h
fields provide compatibility with rehype
.
Taking the ast
from the prior example, let's go back to markdown:
import { fromMarkdown } from 'mdast-util-from-markdown'
import * as wikiLink from 'mdast-util-wiki-link'
let markdownString = toMarkdown(ast, { extensions: [wikiLink.toMarkdown()] }).trim()
console.log(markdownString)
// [[Wiki Link]]
Both fromMarkdown
and toMarkdown
accept configuration as an object.
For example, one may configure fromMarkdown
like so:
let ast = fromMarkdown('[[Test Page]]', {
extensions: [syntax()],
mdastExtensions: [wikiLink.fromMarkdown({ permalinks: ['wiki_page'] })] // <--
})
fromMarkdown
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"
.toMarkdown
options.aliasDivider [String]
: a string to be used as the divider for aliases. See the section below on Aliasing pages. Defaults to ":"
.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 mdast-util-wiki-link receives a total of 1,999 weekly downloads. As such, mdast-util-wiki-link popularity was classified as popular.
We found that mdast-util-wiki-link demonstrated a healthy version release cadence and project activity because the last version was released less than 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.