Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
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.
remark-wiki-link
Advanced tools
⚠️ This plugin is affected by the new parser in remark (micromark
, see remarkjs/remark#536
). For remark 12, use v0.0.x of this package. For remark 13+, use v1.0.0 or above.
This remark plugin parses and renders [[Wiki Links]]
.
[[Real Page:Page Alias]]
Looking for lower level packages? Check out mdast-util-wiki-link for working with ASTs and micromark-extension-wiki-link for working with tokens.
const unified = require('unified')
const markdown = require('remark-parse')
const wikiLinkPlugin = require('remark-wiki-link');
let processor = unified()
.use(markdown, { gfm: true })
.use(wikiLinkPlugin)
When the processor is run, wiki links will be parsed to a wikiLink
node.
If we have this markdown string:
[[Test Page]]
A node will be created that looks 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
.When rendered to HTML, we get:
<a class="internal new" href="#/page/test_page">Test Page</a>
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
: a class name that is attached to any rendered wiki links. Defaults to "internal"
.options.newClassName
: a class name that is attached to any rendered wiki links that do not exist. Defaults to "new"
.options.aliasDivider
: a string for aliased pages
.Aliased pages are supported with the following markdown syntax:
[[Real Page:Page Alias]]
The AST node will look like:
{
value: 'Real Page',
data: {
alias: 'Page Alias',
permalink: 'real_page',
exists: false,
hName: 'a',
hProperties: {
className: 'internal new',
href: '#/page/real_page'
},
hChildren: [{
type: 'text',
value: '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 remark-wiki-link receives a total of 2,340 weekly downloads. As such, remark-wiki-link popularity was classified as popular.
We found that remark-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
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.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.