@franken-suite/franken-markdown

中文文档
0.5.0发布于 2026/10/08LicenseRef-MIT-OpenAI-Anthropic-RiderTypeScriptES Module零依赖近 30 天下载 5342

Browser/WASM package for franken_markdown Markdown to HTML/PDF rendering.

原始使用文档
文档目录3 节
  1. Build
  2. Demo
  3. Browser Usage

franken_markdown WASM Package

This directory contains the source wrapper for the browser package. Generated wasm-bindgen glue is intentionally not committed here; scripts/check-wasm-package.sh builds it into target/fmd-checks/wasm-package/.

Build

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

The assembled package contains:

  • franken_markdown.js - ergonomic hand-written ESM wrapper,
  • franken_markdown.d.ts - exact TypeScript API contract,
  • demo/ - static browser demo that uses the public package wrapper,
  • package.json - package metadata and exports,
  • pkg/ - generated wasm-bindgen glue and .wasm binary.

Demo

After scripts/check-wasm-package.sh, serve the assembled package directory with any static file server and open demo/index.html:

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

Then open http://127.0.0.1:8787/demo/. The demo is plain HTML/CSS/ESM and does not require a bundler or network access for normal rendering. It imports ../franken_markdown.js, renders the HTML preview through renderHtml, and downloads PDF bytes through renderPdf.

Browser Usage

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());

Every render result has:

  • format: html or pdf,
  • mimeType: browser Blob MIME type,
  • extension: default download extension,
  • sourceLength: Markdown source byte length,
  • bytes: Uint8Array,
  • diagnostics: recoverable parser diagnostics,
  • text(), blob(), and filename() helpers.

版本与发布记录

@franken-suite/franken-markdown 共发布 6 个版本,首次发布于 2026/07/08;过去 12 个月发布了 6 个版本。

版本发布日期距今
0.5.0latest2026/10/081 个月前
0.4.42026/09/162 个月前
0.4.22026/08/292 个月前
0.3.22026/07/084 个月前
0.3.12026/07/084 个月前
0.3.02026/07/084 个月前

关于 @franken-suite/franken-markdown 的常见问题

@franken-suite/franken-markdown 是什么?

Browser/WASM package for franken_markdown Markdown to HTML/PDF rendering.

如何安装 @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 和提交记录判断。