@atom-forge/bookmd

中文文档
0.1.15发布于 2026/10/16MITES Module构建来源已验证近 30 天下载 2309

Static course portals from Markdown: local and Git-hosted courses, local browser preview and change-based publishing.

原始使用文档

@atom-forge/bookmd

Static book collections from Markdown. A collection (a config file, a book list and content) runs the bookmd CLI, which owns the SvelteKit app, the Markdown generator and renderer, a browser-safe content core, a local preview (/@dev), Git book sources and change-based publishing. The output is a folder of static files, so it can be hosted anywhere (GitHub Pages included).

Quick start

The fastest start is the bookmd-starter template repository: Use this template, switch GitHub Pages to GitHub Actions, edit the Markdown in content/. Details: docs/deploy-a-book.md.

To run it locally (Bun 1.4.0+, Node 22.12+) see docs/cli.md.

Documentation

User documentation, in docs/:

Release notes: CHANGELOG.md.

版本与发布记录

@atom-forge/bookmd 共发布 17 个版本,首次发布于 2026/10/09;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.15latest2026/10/1622 天前
0.1.142026/10/1523 天前
0.1.132026/10/1523 天前
0.1.122026/10/1523 天前
0.1.112026/10/1523 天前
0.1.102026/10/1325 天前

关于 @atom-forge/bookmd 的常见问题

@atom-forge/bookmd 是什么?

Static course portals from Markdown: local and Git-hosted courses, local browser preview and change-based publishing.

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