# @braindb/micromark-extension-wiki-link 中文文档
规范地址：https://npmcn.com/package/%40braindb/micromark-extension-wiki-link/
版本：0\.1\.0
npm 元数据更新时间：2024-05-13T17:07:46.626Z
中文译文更新时间：2026-11-08T13:42:02.697Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40braindb/micromark-extension-wiki-link
原文对照：https://npmcn.com/package/%40braindb/micromark-extension-wiki-link/?lang=original
项目主页：https://github.com/stereobooster/braindb#readme
源码仓库：https://github.com/stereobooster/braindb
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：12.6 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-05-13T17:07:46.100Z
- 最新版本发布：2024-05-13T17:07:46.328Z
- 近 30 天下载量：10808（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）
## 中文简介
解析和渲染wiki风格链接
## 安装
```sh
npm install @braindb/micromark-extension-wiki-link
```
也可以使用：`pnpm add @braindb/micromark-extension-wiki-link`、`yarn add @braindb/micromark-extension-wiki-link`、`bun add @braindb/micromark-extension-wiki-link`
## README
# @braindb/micromark-extension-wiki-link (英语)
叉数 [https://github.com/landakram/micromark-extension-wiki-link 页面存档备份,存于互联网档案馆](https://github.com/landakram/micromark-extension-wiki-link)
* * *
# 旧读取器
这个 [微标记](https://github.com/micromark/micromark) 扩展解析并制作 `[[Wiki Links]]`。 。 。 .
- 解析 wiki 风格的链接并使其成为锚
- 通过给解析器一个已存在的永久链接列表来区分"新"和"已存在的"维基链接
- 解析别名维基链接 : `[[Real Page:Page Alias]]`
使用 [评论](https://github.com/remarkjs/remark)您也许想要使用 [`remark-wiki-link`](https://github.com/landakram/remark-wiki-link) 而不是直接使用此软件包.
## 使用量
```javascript
import { syntax, html } from "@braindb/micromark-extension-wiki-link";
let serialized = micromark("[[Wiki Link]]", {
extensions: [syntax()],
htmlExtensions: [html()],
});
console.log(serialized);
// Wiki Link
```
### 配置选项
语法扩展和html扩展都可以通过传递对象来配置.
例如,人们可能会像这样配置语法扩展:
```javascript
let serialized = micromark("[[Wiki Link]]", {
extensions: [syntax({ aliasDivider: ":" })],
htmlExtensions: [html()],
});
```
#### `syntax`
- `options.aliasDivider [String]`:作为别名分词的字符串. 见下文关于 [异形页面](https://npmcn.com/package/%40braindb/micromark-extension-wiki-link/#readme-aliasing-pages)默认为 `"|"`。 。 。 .
#### `html`
- `options.permalinks [String]`: 应被视为已存在的页面的一连串通。 如果一个维基链接被解析 并且它的永久链接匹配这些永久链接之一, `node.data.exists` 将是真的.
- `options.pageResolver (pageName: String) -> [String]`: 将页面名称映射到一系列可能的永久链接的函数。 这些可能的永久链接与 `options.permalinks` 以确定是否有页面。 如果一页不存在,则数组的第一个元素被认为是permalink.
默认 `pageResolver` 为:
```javascript
(name) => [name.replace(/ /g, "_").toLowerCase()];
```
- `options.hrefTemplate (permalink: String) -> String`: 将永久链接映射到某种路径的函数。 此路径被用作 `href` 裁定赔偿额 `a`。 。 。 .
默认 `hrefTemplate` 为:
```javascript
(permalink) => `#/page/${permalink}`;
```
- `options.wikiLinkClassName [String]`: 任何已渲染的wiki链接所附加的类名. 默认为 `"internal"`。 。 。 .
- `options.newClassName [String]`:一个类名,该类名附在任何已实现的不存在的wiki链接上. 默认为 `"new"`。 。 。 .
### 异形页面
异名页面以下列标记下语法支持:
```md
[[Real Page|Page Alias]]
```
并在渲染时生成此 HTML :
```html
Page Alias
```
## 常见问题
### @braindb/micromark-extension-wiki-link 是什么？
解析和渲染wiki风格链接
### 如何安装 @braindb/micromark-extension-wiki-link？
在项目目录运行 npm install @braindb/micromark-extension-wiki-link，或使用 pnpm add / yarn add / bun add。
### @braindb/micromark-extension-wiki-link 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @braindb/micromark-extension-wiki-link 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。
### @braindb/micromark-extension-wiki-link 可以商用吗？
@braindb/micromark-extension-wiki-link 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @braindb/micromark-extension-wiki-link 的下载量有多少？
根据 npm 官方下载统计，@braindb/micromark-extension-wiki-link 在 2026/10/09 – 2026/11/07 这 30 天内被下载 10,808 次，日均约 360 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @braindb/micromark-extension-wiki-link 还在维护吗？
最新版本 0\.1\.0 发布于 2024/05/14（2 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/05/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。