# @docubook/flame 中文文档

规范地址：https://npmcn.com/package/%40docubook/flame/

版本：2\.8\.2
npm 元数据更新时间：2026-11-11T01:29:49.281Z
中文译文更新时间：2026-11-12T16:37:25.579Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40docubook/flame
原文对照：https://npmcn.com/package/%40docubook/flame/?lang=original
项目主页：https://github.com/DocuBook/docubook/tree/main/packages/flame
源码仓库：https://github.com/DocuBook/docubook

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

- 包体积（解压后）：1.4 MB，152 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^20\.19\.0 \|\| \>=22\.12\.0
- 运行依赖：15 个
- peer 依赖：@sentry/bun ^10\.0\.0 \|\| ^11\.0\.0
- 首次发布：2026-05-24T14:08:10.723Z
- 最新版本发布：2026-11-11T01:29:48.810Z
- 近 30 天下载量：2486（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：75（近 12 个月 75 个）

## 中文简介

由Bun提供动力的发光-快速反应+MDX框架,为现代文献体验所建.

## 安装

```sh
npm install @docubook/flame
```

也可以使用：`pnpm add @docubook/flame`、`yarn add @docubook/flame`、`bun add @docubook/flame`

## README

# DocuBook Flame # # #######################################################################################################################################################################################################################################################

**编译记分. 部署任何东西.**

没有运行时间,没有服务器运行,没有锁定. 一种可读的平分格式 编成平整的静态HTML——部署在任何地方.

* * *

## 快速启动

**阿宝**

```bash
mkdir my-docs && cd my-docs
bun add @docubook/flame
bunx flame init
bun run dev
```

**节点.js**

```bash
mkdir my-docs && cd my-docs
npm install @docubook/flame
npx flame init
npm run dev
```

**德诺**

```bash
mkdir my-docs && cd my-docs
deno run -A npm:@docubook/flame init
deno task dev
```

* * *

## 文档

完整文件请访问 **[软件包/火焰/文档](https://github.com/DocuBook/docubook/tree/main/packages/flame/docs)** 或读取官方网站 [docubook.pro (英语)](https://docubook.pro/)

* * *

## 许可证

麻省理工学院

## 常见问题

### @docubook/flame 是什么？

由Bun提供动力的发光-快速反应\+MDX框架,为现代文献体验所建\.

### 如何安装 @docubook/flame？

在项目目录运行 npm install @docubook/flame，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 flame，可以用 npx flame 直接运行。

### @docubook/flame 支持 TypeScript 吗？

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

### @docubook/flame 支持 ESM 还是 CommonJS？

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

### @docubook/flame 需要什么版本的 Node\.js？

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

### @docubook/flame 可以商用吗？

@docubook/flame 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @docubook/flame 的下载量有多少？

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

### @docubook/flame 还在维护吗？

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