@file-viewer/renderer-typst

中文文档
3.3.3发布于 2026/10/31Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 3.5万

Standalone Typst renderer plugin for File Viewer powered by browser WASM.

原始使用文档
文档目录5 节
  1. 用法
  2. 能力边界
  3. 离线资产
  4. CSP 与 Trusted Types
  5. 迁移说明

@file-viewer/renderer-typst

English · 简体中文

Flyfish File Viewer 的独立 Typst renderer 包。它直接读取 .typ / .typst 源文件,并使用 @myriaddreamin/typst.ts 的浏览器 WASM compiler / renderer 输出按页 SVG,避免用源码视图冒充预览成功。

用法

import FileViewer from '@file-viewer/vue3'
import { typstRenderer } from '@file-viewer/renderer-typst'

const options = {
  rendererMode: 'replace',
  renderers: typstRenderer,
}

也可以和其他 renderer 一起组合:

import { pdfRenderer } from '@file-viewer/renderer-pdf'
import { typstRenderer } from '@file-viewer/renderer-typst'

const options = {
  rendererMode: 'replace',
  renderers: [pdfRenderer, typstRenderer],
}

能力边界

  • 支持 .typ、.typst。
  • 浏览器端真实编译 Typst 源文件并输出 SVG 页面。
  • 支持页面尺寸识别、缩放、打印和 HTML 导出。
  • 支持 options.typst.renderTimeoutMs 加载 / 编译超时控制。
  • WASM 缺失、MIME 错误、网络错误或编译错误会给出明确诊断。

离线资产

默认会从 viewer assets 下读取:

  • wasm/typst/typst_ts_web_compiler_bg.wasm
  • wasm/typst/typst_ts_renderer_bg.wasm
  • wasm/typst/fonts/

私有化部署时可以通过 options.typst.compilerWasmUrl、options.typst.rendererWasmUrl 和 options.typst.fontAssetsUrl 覆盖。默认字体资产随本包发布并由 file-viewer-copy-assets / @file-viewer/vite-plugin 复制到本地静态目录,预览运行时不会访问公共 CDN。

CSP 与 Trusted Types

Typst SVG 通过受控的 XML 解析、结构化净化和 DOM 节点导入渲染,不使用 innerHTML。如果站点启用了 require-trusted-types-for 'script',请在 trusted-types 指令中允许 file-viewer-typst-svg(DOMPurify 的导出/打印路径还需要 dompurify)。

迁移说明

Typst 渲染已经从 @file-viewer/core 迁移到本包。core 只保留 renderFileViewerTypst() 兼容导出并给出明确安装提示,不再默认安装 @myriaddreamin/*。需要 Typst 真实预览时,请显式安装本包,或直接使用 @file-viewer/preset-all。

版本与发布记录

@file-viewer/renderer-typst 共发布 57 个版本,首次发布于 2026/06/23;过去 12 个月发布了 57 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.3.3latest2026/10/3114 天前
3.3.12026/10/3015 天前
3.3.02026/10/2718 天前
3.2.22026/10/1827 天前
3.2.12026/10/1530 天前
3.2.02026/10/1530 天前

关于 @file-viewer/renderer-typst 的常见问题

@file-viewer/renderer-typst 是什么?

Standalone Typst renderer plugin for File Viewer powered by browser WASM.

如何安装 @file-viewer/renderer-typst?

在项目目录运行 npm install @file-viewer/renderer-typst,或使用 pnpm add / yarn add / bun add。

@file-viewer/renderer-typst 支持 TypeScript 吗?

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

@file-viewer/renderer-typst 支持 ESM 还是 CommonJS?

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

@file-viewer/renderer-typst 可以商用吗?

@file-viewer/renderer-typst 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@file-viewer/renderer-typst 的下载量有多少?

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

@file-viewer/renderer-typst 还在维护吗?

最新版本 3.3.3 发布于 2026/10/31(14 天前);至今共发布 57 个版本,其中过去 12 个月发布了 57 个;首次发布于 2026/06/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。