# @fusebase/markdown-viewer 中文文档

规范地址：https://npmcn.com/package/%40fusebase/markdown-viewer/

版本：0\.1\.8
npm 元数据更新时间：2026-10-14T13:54:04.610Z
中文译文更新时间：2026-11-15T23:38:54.073Z
软件包许可：SEE LICENSE IN LICENSE

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fusebase/markdown-viewer
原文对照：https://npmcn.com/package/%40fusebase/markdown-viewer/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：276 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12
- 运行依赖：5 个
- peer 依赖：katex ^0\.16\.11，react \>=18，mermaid ^11\.16\.0，dompurify ^3\.0\.11，highlight\.js ^11\.11\.1
- 首次发布：2026-10-14T11:53:27.596Z
- 最新版本发布：2026-10-14T13:54:04.355Z
- 近 30 天下载量：1998（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

FuseBase v3 markdown note 编辑器的可移植半个: 在不知晓ProseMirror, DOM 或 Next 的情况下,知道我们指令语法的一切.

## 安装

```sh
npm install @fusebase/markdown-viewer
```

也可以使用：`pnpm add @fusebase/markdown-viewer`、`yarn add @fusebase/markdown-viewer`、`bun add @fusebase/markdown-viewer`

## README

# @ fusebase/ markdown- 查看器

FuseBase v3 mark down note 编辑器的可移植半个: 所有知道的东西 关于我们指令的语法 并不知道ProseMirror, DOM 或 Next.

## 住在这里的东西

-   `directive-widget-attrs.ts` ——每项指令的审定和正常化 属性。 有意免入,故从节点可使用.
-   `directive-mdast.ts` ——每条指令如何以平分写出.
-   `directive-dom.ts` 作为数据,每个指令是如何绘制的。 编辑的 ProseMiror节点把这些直接递回ProseMiror; `<MarkdownViewer>` 把它们变快 一个描述,两个渲染器.
-   `directive-hast.ts` + 键 `markdown-viewer.tsx` ——浏览器出入口.
-   `mermaid.ts` ——图解及其主题,后 `await import()`。 。 。 .

## 入境点

| 导入 | 这是什么 |
| --- | --- |
| `@fusebase/markdown-viewer` | 无依赖层:属性, mdast specs, DOM specs |
| `@fusebase/markdown-viewer` (节点条件) | 以上加数 `parseMarkdown()` 编号 : `serializeMarkdown()` |
| `@fusebase/markdown-viewer` (浏览器条件) | 以上加数 `<MarkdownViewer>` |

它们是三个独立的源文件(`src/index.ts`, (中文(简体) ), `src/node.ts`, (中文(简体) ), `src/browser.ts`)而不是一桶,所以消费者不会装入口语链,除非它进口需要的入口.

## `<MarkdownViewer>`

```tsx
import { MarkdownViewer } from '@fusebase/markdown-viewer';

<MarkdownViewer markdown={note.markdown} className="note-body" />;
```

唯读,而只读由建筑而非一面旗帜:没有 ProseMirror在这里,所以它的任何内容都是可以编辑的。 反应是一种 **端点 依赖性** (单位:千美元)`>=18`从来没有捆绑.

`<MarkdownEditor>` ——完全编辑模式——是后期的迭代.

### 三项东道国指令

`::fusebase-dashboard`, (中文(简体) ), `::fusebase-iframe` 财务报告和审定财务报表 `:fusebase-mention` 需要帮助 仪表板blot,用户搜索 API和 `next-intl`,所以他们留在 主机应用程序。 观众把他们当作占地者 `data-directive` 及其属性; 能够绘制它们的主机替换 元素通过 `components` 道具 (英语).

### 样式

```ts
import '@fusebase/markdown-viewer/viewer.css';
```

这是整个样式表 一个音符需要: `--md-*` 品牌地图,点名, 指令部件、语气表和取景者的发音基础 `md-note` 树根。 进口 `tokens.css` 所以东道主从来不需要两者.

每个部件规则被限制到 `:is(.markdown-note-editor .milkdown .ProseMirror, .md-note)` ——编辑器和取景器从同一种取出相同的部件 `DomSpec`,所以一个文件样式都一样。 传教基础是 `.md-note` 单枪匹马,因为Crepe编辑会提供它 Crepe 帧覆盖主机编辑器中停留, 它导入 这个;部件设置铅笔及其弹出器在这里,因为 弹出式挂载 `<body>` 并读出同样的地图.

一个使 **数学** 还需要 KaTeX 自己的样式表 – 查看器呼叫 `katex.renderToString` 但不运送其CSS:

```ts
import 'katex/dist/katex.min.css';
```

### 公众观点

```tsx
import { MarkdownViewer, PUBLIC_VIEW_COMPONENTS } from '@fusebase/markdown-viewer';

<MarkdownViewer markdown={note.markdown} components={PUBLIC_VIEW_COMPONENTS} />;
```

当读者匿名时 链接,一个门户,一个已公布的网站. 仪表板变成静态占位符,一个 iframe 仅为 https URL 设定框架 `PUBLIC_EMBED_HOSTS` 其他情况 显示为链接,并注明显示名称为文本,没有查找. 见 `public-components.tsx`。 。 。 .

## 什么故意没有

编辑器节点定义和三个主机绑定 指令(`::fusebase-dashboard`, (中文(简体) ), `::fusebase-iframe`, (中文(简体) ), `:fusebase-mention`(中文(简体) ) 留在主机应用程序中——它们拉入仪表板blot,用户搜索 API 财务报告和审定财务报表 `next-intl`。 。 。 .

## 常见问题

### @fusebase/markdown-viewer 是什么？

FuseBase v3 markdown note 编辑器的可移植半个: 在不知晓ProseMirror, DOM 或 Next 的情况下,知道我们指令语法的一切\.

### 如何安装 @fusebase/markdown-viewer？

在项目目录运行 npm install @fusebase/markdown-viewer，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fusebase/markdown-viewer 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fusebase/markdown-viewer 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fusebase/markdown-viewer 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @fusebase/markdown-viewer 可以商用吗？

@fusebase/markdown-viewer 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @fusebase/markdown-viewer 的下载量有多少？

根据 npm 官方下载统计，@fusebase/markdown-viewer 在 2026/10/16 – 2026/11/14 这 30 天内被下载 1,998 次，日均约 67 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fusebase/markdown-viewer 还在维护吗？

最新版本 0\.1\.8 发布于 2026/10/14（1 个月前）；至今共发布 6 个版本，其中过去 12 个月发布了 6 个；首次发布于 2026/10/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

