@cloudflare/nimbus-docs (英语)
Astro一体化和CLI促进 烟花,用于编写文件的工具.
与脚手架创建站点, 安装和配置此软件包 :
npx @cloudflare/create-nimbus-docs@latest my-docs
一体化
新站点呼叫 nimbus(config) 内 astro.config.ts。集成过程为 MDX, 验证构建过程中的配置和内容, 索引搜索, 并为帮助者提供您的路由调用 。 脚手架将内容集、路线、布局和UI组件复制到您的Repo中。 共享组件,如 NimbusHead 财务报告和审定财务报表 Icon 来自这个包裹.
国家行动倡议
在站点内运行命令 npx nimbus-docs <command>。 。 。 .
添加到您的网站
add 复制组件及其作为源代码的依赖性。 特征是Markdown食谱:运行命令的编码代理直接接收食谱,以及 --print 写出来给任何探员 或者让你跟随.
npx nimbus-docs add tabs
npx nimbus-docs add new-version --print
add 仅列出登记册. add source github --print 或者说 add source notion --print 从另一个寄存器或Notion打印用于加载页面的指南. add adapter-<cloudflare|netlify|vercel|node> 安装和配置服务器适配器.
检查您的页面
check 找到问题,没有建筑. lint 抓取写入错误; 首先建立网站, 因此它有链接地图 。 两个都拿 --fix。 。 。 . check --json 财务报告和审定财务报表 lint --format json 给出一个特工的发现 它可以采取行动.
npx nimbus-docs check
npx nimbus-docs lint --fix
跟紧尼姆布斯
在更新复制到您的 repo 的启动文件之前, 审查上游更改 . outdated 列出后面的启动文件、组件和软件包更改. diff <file> 显示启动文件的上游变化,以及 --apply 当你没有编辑文件时就把它拿走. migrate 应用编辑新版本的需要并列出需要审查的版本.
npx nimbus-docs outdated
npx nimbus-docs migrate
以前创建的网站 nimbus.json 存在的起始 npx nimbus-docs init。 。 。 .
进口
| 导入 | 对于 |
|---|---|
@cloudflare/nimbus-docs | nimbus() 财务报告和审定财务报表 defineConfig |
@cloudflare/nimbus-docs/runtime | 路径中的页面数据:侧边栏、面包屑、上下行 |
@cloudflare/nimbus-docs/content | 内容集 |
@cloudflare/nimbus-docs/client | 您组件的浏览器行为 |
@cloudflare/nimbus-docs/react | 无头交互式图表 |
这个 软件包 API 覆盖您将使用最多的助手; TypeScript 声明列出每个导出项 .
文档
nimbus-docs.com 页面存档备份,存于互联网档案馆时,在 nimbus-docs.com/cli (英语)。 。 。 .
许可证
麻省理工学院