# @atom-forge/bookmd 中文文档

规范地址：https://npmcn.com/package/%40atom-forge/bookmd/

版本：0\.1\.15
npm 元数据更新时间：2026-10-16T14:23:29.115Z
中文译文更新时间：2026-11-07T03:28:30.485Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：244 kB，75 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12\.0
- 运行依赖：31 个
- 首次发布：2026-10-09T14:11:53.025Z
- 最新版本发布：2026-10-16T14:23:28.591Z
- 近 30 天下载量：2309（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

来自Markdown的静态课程门户网站:本地和Git主办的课程,本地浏览器预览和基于更改的出版.

## 安装

```sh
npm install @atom-forge/bookmd
```

也可以使用：`pnpm add @atom-forge/bookmd`、`yarn add @atom-forge/bookmd`、`bun add @atom-forge/bookmd`

## README

# @ atom-forge/ bookmd (英语)

Markdown的静态图书收藏. 收藏( 配置文件、 书籍列表和内容) 运行 `bookmd` CLI,拥有SvelteKit应用程序,Markdown生成器和渲染器,浏览器安全内容核心,本地预览(`/@dev`),"Git"书出处和以更迭为主的出版. 输出是静态文件的文件夹,因此可以在任何地方主机(包含GitHub Pages).

## 快开始

最快的开始是 [`bookmd-starter`](https://github.com/atom-forge/bookmd-starter) 模板仓库 : _使用此模板_,将 GitHub 页面切换为 _GitHub 动作_,编辑 Markdown 在 `content/`细节 : [文件/部署手册](https://npmcn.com/package/%40atom-forge/bookmd/docs/deploy-a-book.md)。 。 。 .

在当地运行(Bun 1.4.0+,节点22.12+)见 [文件/目录](https://npmcn.com/package/%40atom-forge/bookmd/docs/cli.md)。 。 。 .

## 文档

用户文档, in [文档/](https://npmcn.com/package/%40atom-forge/bookmd/docs)数字 :

-   [写书](https://npmcn.com/package/%40atom-forge/bookmd/docs/authoring.md):结构,元数据,支持的内容.
-   [在 GitHub 页面上发表](https://npmcn.com/package/%40atom-forge/bookmd/docs/deploy-a-book.md)。 。 。 .
-   [其他 GitHub 存储器的书籍](https://npmcn.com/package/%40atom-forge/bookmd/docs/remote-books.md)包括私家侦探.
-   [自控静态输出](https://npmcn.com/package/%40atom-forge/bookmd/docs/self-hosted.md)。 。 。 .
-   [命令和配置](https://npmcn.com/package/%40atom-forge/bookmd/docs/cli.md)数字 : `bookmd` 命令, `portal.config.ts`,本地预览, `bookmd plan`。 。 。 .

释放注释 : [变动情况](https://npmcn.com/package/%40atom-forge/bookmd/CHANGELOG.md)。 。 。 .

## 常见问题

### @atom-forge/bookmd 是什么？

来自Markdown的静态课程门户网站:本地和Git主办的课程,本地浏览器预览和基于更改的出版\.

### 如何安装 @atom-forge/bookmd？

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

### @atom-forge/bookmd 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/atom-forge\_\_bookmd 是否存在。

### @atom-forge/bookmd 支持 ESM 还是 CommonJS？

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

### @atom-forge/bookmd 需要什么版本的 Node\.js？

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

### @atom-forge/bookmd 可以商用吗？

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

### @atom-forge/bookmd 的下载量有多少？

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

### @atom-forge/bookmd 还在维护吗？

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