@braindb/micromark-extension-wiki-link (英语)
叉数 https://github.com/landakram/micromark-extension-wiki-link 页面存档备份,存于互联网档案馆
旧读取器
这个 微标记 扩展解析并制作 [[Wiki Links]]。 。 。 .
- 解析 wiki 风格的链接并使其成为锚
- 通过给解析器一个已存在的永久链接列表来区分"新"和"已存在的"维基链接
- 解析别名维基链接 :
[[Real Page:Page Alias]]
使用 评论您也许想要使用
remark-wiki-link 而不是直接使用此软件包.
使用量
import { syntax, html } from "@braindb/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>
配置选项
语法扩展和html扩展都可以通过传递对象来配置.
例如,人们可能会像这样配置语法扩展:
let serialized = micromark("[[Wiki Link]]", {
extensions: [syntax({ aliasDivider: ":" })],
htmlExtensions: [html()],
});
syntax
options.aliasDivider [String]:作为别名分词的字符串. 见下文关于 异形页面默认为"|"。 。 。 .
html
-
options.permalinks [String]: 应被视为已存在的页面的一连串通。 如果一个维基链接被解析 并且它的永久链接匹配这些永久链接之一,node.data.exists将是真的. -
options.pageResolver (pageName: String) -> [String]: 将页面名称映射到一系列可能的永久链接的函数。 这些可能的永久链接与options.permalinks以确定是否有页面。 如果一页不存在,则数组的第一个元素被认为是permalink.默认
pageResolver为:(name) => [name.replace(/ /g, "_").toLowerCase()]; -
options.hrefTemplate (permalink: String) -> String: 将永久链接映射到某种路径的函数。 此路径被用作href裁定赔偿额a。 。 。 .默认
hrefTemplate为:(permalink) => `#/page/${permalink}`; -
options.wikiLinkClassName [String]: 任何已渲染的wiki链接所附加的类名. 默认为"internal"。 。 。 . -
options.newClassName [String]:一个类名,该类名附在任何已实现的不存在的wiki链接上. 默认为"new"。 。 。 .
异形页面
异名页面以下列标记下语法支持:
[[Real Page|Page Alias]]
并在渲染时生成此 HTML :
<a class="internal new" href="#/page/real_page">Page Alias</a>