# @franken-suite/franken-markdown 中文文档

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

版本：0\.5\.0
npm 元数据更新时间：2026-10-07T19:05:42.843Z
中文译文更新时间：2026-11-15T13:07:31.472Z
软件包许可：LicenseRef-MIT-OpenAI-Anthropic-Rider

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

原始 npm 页面：https://www.npmjs.com/package/%40franken-suite/franken-markdown
原文对照：https://npmcn.com/package/%40franken-suite/franken-markdown/?lang=original
项目主页：https://github.com/Dicklesworthstone/franken_markdown#readme
源码仓库：https://github.com/Dicklesworthstone/franken_markdown

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

- 包体积（解压后）：9.2 MB，117 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-07-07T22:15:22.246Z
- 最新版本发布：2026-10-07T19:05:42.618Z
- 近 30 天下载量：5342（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

浏览器/ WASM 包用于franten markdown Markdown 到 HTML/PDF 渲染.

## 安装

```sh
npm install @franken-suite/franken-markdown
```

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

## README

# 弗兰肯- 马克下 软件包

此目录包含浏览器包的源包包. 已生成 `wasm-bindgen` 此处故意不使用胶水; `scripts/check-wasm-package.sh` 把它建起来 `target/fmd-checks/wasm-package/`。 。 。 .

## 构建

```bash
rustup target add wasm32-unknown-unknown
cargo install wasm-bindgen-cli --version 0.2.126 --locked
scripts/check-wasm-package.sh
```

组装的软件包包括:

-   `franken_markdown.js` - 人类基因组手写的无害环境管理包装器,
-   `franken_markdown.d.ts` - 准确的TypeScript API合同,
-   `demo/` - 使用公共软件包包装的静态浏览器演示,
-   `package.json` - 元数据包和出口,
-   `pkg/` - 生成的先天胶和 `.wasm` 二进制.

## 演示

之后 `scripts/check-wasm-package.sh`软件包目录 使用任何静态文件服务器并打开 `demo/index.html`数字 :

```bash
python3 -m http.server 8787 --directory target/fmd-checks/wasm-package
```

然后打开 `http://127.0.0.1:8787/demo/`演示为 Plain HTML/CSS/ESM 并 不需要捆绑器或网络访问才能正常渲染。 进口 `../franken_markdown.js`,使 HTML 预览通过 `renderHtml`,以及 下载 PDF 字节通过 `renderPdf`。 。 。 .

## 浏览器使用

```js
import { createRenderer } from "./franken_markdown.js";

const fmd = await createRenderer();
const html = await fmd.renderHtml("# Hello", { font: "sans", darkMode: "auto" });
document.body.innerHTML = html.text();

const pdf = await fmd.renderPdf("# Report", {
  title: "Report",
  metadataEpochSeconds: 1700000000
});
const url = URL.createObjectURL(pdf.blob());
```

每个结果都:

-   `format`数字 : `html` 或者说 `pdf`, (中文(简体) ),
-   `mimeType`:浏览器 Blob MIME 类型,
-   `extension`: 默认下载扩展名,
-   `sourceLength`: 标记下源字节长度,
-   `bytes`数字 : `Uint8Array`, (中文(简体) ),
-   `diagnostics`:可回收的剖面诊断,
-   `text()`, (中文(简体) ), `blob()`,以及 `filename()` 帮手.

## 常见问题

### @franken-suite/franken-markdown 是什么？

浏览器/ WASM 包用于franten markdown Markdown 到 HTML/PDF 渲染\.

### 如何安装 @franken-suite/franken-markdown？

在项目目录运行 npm install @franken-suite/franken-markdown，或使用 pnpm add / yarn add / bun add。

### @franken-suite/franken-markdown 支持 TypeScript 吗？

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

### @franken-suite/franken-markdown 支持 ESM 还是 CommonJS？

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

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

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

### @franken-suite/franken-markdown 可以商用吗？

@franken-suite/franken-markdown 使用 LicenseRef-MIT-OpenAI-Anthropic-Rider 许可。声明的许可为 LicenseRef-MIT-OpenAI-Anthropic-Rider，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @franken-suite/franken-markdown 的下载量有多少？

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

### @franken-suite/franken-markdown 还在维护吗？

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