@ cloudflare/ create-nimbus-docs (英语)
创建一个 烟花 文献网站.
需要22.12.0节点或晚点.
npx @cloudflare/create-nimbus-docs@latest my-docs
cd my-docs
npm run dev
它将一个Astro Docs网站写入 my-docs:布局,组件,样式,路由和示例页,作为您可以编辑的平面文件. 它询问网站是否有API的参考文献,您将在哪里部署,是否包括示例页.
选项
--yes, (中文(简体) ), -y:跳过问题. 你得到了实例页,一个为Cloudflare设置的静态站点,一个git寄存器和已安装的依赖性.
--content <starter|empty>:示例页,或无.
--api [spec]: 在 /api,来自您的 OpenAPI 3.x 文件(.yaml, (中文(简体) ), .yml, (中文(简体) ), .json)或样本. 先放目录 : my-docs --api。 。 。 .
--template <docs|api>: 根部何为( 默认) docs(三); api 创建仅是一个 API 引用的站点, at /。 。 。 .
--deploy <cloudflare|other>:静态站点的部署(默认) cloudflare) (中文(简体) ).
--adapter <cloudflare|netlify|vercel|node>: 使用适配器按请求提供页面,而不是 --deploy。 。 。 .
--package-manager <npm|pnpm|yarn|bun>: 推翻运行命令的操作.
--skip-install, (中文(简体) ), --no-git: 跳过安装依赖或创建 git 寄存器 .
--template-dir <path>: 脚手架从本地文件夹中取出,而不是下载模板.
模板
此软件包的每个版本都从匹配中下载其模板 templates-v<version> gitHub 上的标记,所以一个版本总是从同一个文件开始。 该下载需要访问 GitHub; --template-dir 跳过它.
文档
nimbus-docs.com/快速启动
许可证
麻省理工学院
关于 @cloudflare/create-nimbus-docs 的常见问题
@cloudflare/create-nimbus-docs 是什么?
脚手架 一个新的Nimbus Docs网站。 通过 npx @cloudflare/create-nimbus-docs@latest。 。 。 .
如何安装 @cloudflare/create-nimbus-docs?
在项目目录运行 npm install @cloudflare/create-nimbus-docs,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 create-nimbus-docs,可以用 npx create-nimbus-docs 直接运行。
@cloudflare/create-nimbus-docs 支持 TypeScript 吗?
该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cloudflare__create-nimbus-docs 是否存在。
@cloudflare/create-nimbus-docs 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@cloudflare/create-nimbus-docs 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=22.12.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@cloudflare/create-nimbus-docs 可以商用吗?
@cloudflare/create-nimbus-docs 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@cloudflare/create-nimbus-docs 的下载量有多少?
根据 npm 官方下载统计,@cloudflare/create-nimbus-docs 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,585 次,日均约 86 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@cloudflare/create-nimbus-docs 还在维护吗?
最新版本 0.8.3 发布于 2026/11/05(4 天前);至今共发布 29 个版本,其中过去 12 个月发布了 29 个;首次发布于 2026/07/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。