ArcKit /arckit:pages教程把架构文档发布为可交互的GOV.UK风格文档站【免费下载链接】arc-kitThe Enterprise Architecture Governance Harness — strategy, architecture, delivery, and assurance using AI coding assistants项目地址: https://gitcode.com/GitHub_Trending/ar/arc-kitArcKit 是一个企业架构治理工具包Enterprise Architecture Governance Harness它的/arckit:pages命令可以把仓库中所有架构文档一键发布为免费、可交互的 GOV.UK 风格文档站自带治理仪表盘、Mermaid 图表渲染和文档依赖图谱无需任何后端部署到 GitHub Pages 或任意静态托管即可上线。为什么需要架构文档站用 ArcKit 做架构治理时仓库里会积累大量标准文档需求REQ、风险登记册RISK、架构决策记录ADR、Wardley 地图WARD……它们分散在projects/各目录中靠文件管理器或 IDE 逐一翻找效率很低。/arckit:pages的价值就在于零后端生成的是纯静态站点文档由浏览器按需加载零依赖仪表盘与图谱使用原生 SVG无构建步骤政府级视觉采用英国 GOV.UK Frontend 设计系统专业、可访问、移动端自适应随处可部署GitHub Pages、Netlify、Vercel、S3 均可完整玩法见官方指南docs/guides/pages.md一键生成步骤/arckit:pages 如何工作在支持 ArcKit 插件的 AI 编程助手中只需执行一条命令/arckit:pages Generate documentation site for this repository命令背后的 sync-guides hook 会在后台自动完成全部工作你不需要写任何代码步骤Hook 自动做的事产出文件1同步插件内全部指南到docs/guides/并提取标题—2读取仓库信息owner、名称、分支—3处理 pages 站点模板docs/index.html4扫描所有项目、工件、供应商文档docs/manifest.json5生成面向 LLM 的文档索引docs/llms.txt执行完毕后助手会直接输出一份统计摘要发现多少个项目、索引了多少份文档、图 / 决策记录 / 供应商文档各有多少方便你立刻核对。命令的完整定义可参考 plugins/arckit-claude/commands/pages.md独立版不装完整插件也可用在 plugins/arckit-claude/commands-standalone/pages.md。生成的文档站长什么样治理仪表盘文档站的默认首页打开站点默认进入仪表盘Dashboard所有数据完全由manifest.json客户端计算KPI 卡片项目总数、文档总数、架构决策数、平均工件覆盖率文档分类环形图按 Discovery、Planning、Architecture、Governance 等分类分布项目覆盖率条形图每个项目按绿≥80%/ 黄≥50%/ 红50%着色缺口一目了然治理覆盖清单检查关键工件类型在组合层面是否存在会话遥测面板若仓库有docs/telemetry.json还会展示最近 10 次 AI 会话的工具调用与延迟统计Mermaid 图表自动渲染文档中所有 Mermaid 代码块都会被自动渲染——流程图、时序图、C4 图、ER 图、甘特图等开箱即用架构师再也不用先写图、再截图、再贴进文档。Document Map让文档依赖关系可视化 ️这是站点最惊艳的功能每份文档变成一个节点文档间的交叉引用变成连线按治理域分层着色。几个细节非常实用孤儿检测没有任何引用关系的文档会显示虚线边框——孤立的风险登记册意味着没人把风险关联回需求新鲜度指示节点右上角绿点 7 天内修改黄点 7~30 天无点 超过一个月治理评审时扫一眼就知道哪些文档过期了时间线视图切换后文档沿时间轴排布自动按周 / 月 / 季度选粒度直观看到文档是怎么演进的交互探索悬停高亮连接、点击直接打开文档、按项目过滤详细原理与效果见 Document Map 文章。GitHub Pages 发布5 步上线生成完成后把docs/提交推送然后进入仓库 Settings打开Pages设置区Source 选择 Deploy from a branchBranch 选main文件夹选/docs保存站点随即上线于https://{owner}.github.io/{repo}/。URL 采用哈希路由#dashboard、#projects/001-name/ARC-001-REQ-v1.0.md浏览器前进后退正常可用单份文档也能分享直达链接无需任何服务器配置。进阶技巧健康检查、SEO 与隐私控制 接入健康评分先运行/arckit:health JSONtrue生成docs/health.json再重跑/arckit:pages仪表盘即显示项目健康度数据。指南docs/guides/health.md 自带 SEO生成的docs/index.html包含唯一title、meta description、Open Graph 卡片、Schema.org 结构化数据和 canonical 链接。绑了自定义域名在docs/CNAME写入域名Hook 会自动把 canonical 和 og:url 解析为你的正式 URL。 敏感内容不上搜索引擎治理文档可能含敏感信息可通过.arckit/templates-custom/pages-template.html模板覆盖注入meta namerobots contentnoindex让站点公开可访问但不被索引。♻️ 保留手写 llms.txtdocs/llms.txt每次生成都会重写但如果你已手写了不带 ArcKit 生成标记的版本会被自动保留——AI 助手发现文档的索引和人类维护的清单互不打架。常见问题不装完整插件能用吗可以独立版命令 单独放置适合只想生成文档站的轻量场景。支持中文文档吗Markdown 全文渲染与 Mermaid 均支持GOV.UK 样式对中英文排版均可用。文档改了会自动更新吗站点通过相对路径从仓库实时读取文档推送新的 Markdown 后刷新页面即见最新内容无需重新生成站点。除了 GitHub Pages 还能发在哪站点使用相对路径Netlify / Vercel 需把发布目录设为仓库根目录任意静态服务器直接托管整个仓库目录即可。总结/arckit:pages把架构文档库升级为架构文档站一条命令生成 GOV.UK 风格的可交互站点仪表盘量化治理缺口Document Map 让文档依赖关系和过期文档无处遁形五步即可上线 GitHub Pages。对于希望文档可浏览、可度量、可分享的架构团队这是零成本获得专业文档站的最快路径。【免费下载链接】arc-kitThe Enterprise Architecture Governance Harness — strategy, architecture, delivery, and assurance using AI coding assistants项目地址: https://gitcode.com/GitHub_Trending/ar/arc-kit创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考