尧图网页设计 
Prowler 文档站点架构与本地开发实战基于 Mintlify 的 Prowler 官方文档工程指南【免费下载链接】prowlerProwler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment.项目地址: https://gitcode.com/GitHub_Trending/pr/prowler本文基于 Prowler 仓库内的docs/README.md展开讲清官方文档站点的三层内容架构Getting Started / User Guide / Developer Guide如何组织在docs/目录中并覆盖文档本地预览Mintlify CLImint dev、发布流程、写作风格规范docs/AGENTS.md与常见问题排查。读完后你将能够独立完成文档页面的新增、本地调试、导航注册与发布验证。一、Prowler 文档站点的定位与目录布局docs/README.md开宗明义该目录承载的是 Prowler 开源文档站点由 Mintlify 驱动。理解这一点的意义在于——整个docs/目录同时是内容源与站点配置而不是单纯的 Markdown 文件夹。从仓库实际目录结构看docs/顶层包含路径作用docs/docs.jsonMintlify 站点配置主题、导航树、页眉页脚、重定向规则docs/introduction.mdx文档首页H1 入口docs/getting-started/入门内容产品族、安装、基础用法、方案对比docs/user-guide/用户指南Prowler Cloud、CLI、Provider、合规docs/developer-guide/开发者指南Provider/Check 开发、测试、调试docs/security/安全合规说明加密、数据区域、网络、软件安全docs/snippets/可复用 MDX 组件VersionBadge、AppliesTo 等docs/style.css站点自定义样式如侧边栏 Cloud 标记docs/images/文档配图资源docs/AGENTS.md文档风格指南品牌语气、命名规范、排版规则docs/.mintlifyignoreMintlify 构建时忽略的文件如AGENTS.mdREADME 中描述的三层结构Getting Started / User Guide / Developer Guide与docs.json中的navigation.tabs一一对应但实际站点比 README 的概括更细从 docs/docs.json 可以看到导航树共定义了 8 个顶级 Tab——Getting Started、Guides、Developer Guide、Security、Support、Troubleshooting、Changelog外加一个外链About Us。也就是说README 的三段式描述是面向贡献者的概念地图而真正决定页面出现在哪里的是docs.json的 Tab/Group 嵌套结构。导航配置采用 Mintlify 的标准层级navigation.tabs[] - groups[] - pages[]pages中每个字符串对应docs/下去掉.mdx后缀的文件路径例如user-guide/providers/aws/authentication对应docs/user-guide/providers/aws/authentication.mdx。页面还可以是嵌套对象实现无限层级的分组。站点级配置要点除导航外docs/docs.json 还集中管理了若干影响全站行为的配置值得在修改文档前了解品牌与外观theme: mint、主色#10B981品牌绿、明暗两套 Logo/images/prowler-logo-black.png/prowler-logo-white.png全局横幅banner当前用于公告产品更名——Prowler App 现更名为 Prowler Local ServerProwler Enterprise 现更名为 Prowler Private Cloud并设为dismissible: false不可关闭Markdown 指令markdown.instructions向 LLM/搜索回答注入产品命名规范确保新旧产品名的准确使用反馈组件feedback开启点赞评分、建议编辑与提 Issue重定向表redirects迁移历史 URL 到新路径例如/contact - /support、/user-guide/tutorials/prowler-app-alerts - /user-guide/tutorials/prowler-alerts以及一大批旧 Read the Docs 风格路径/projects/prowler-open-source/en/latest/...到现行结构的通配重定向:slug*。新增或移动页面时应参照此模式补充重定向避免旧链接 404。二、本地开发安装 CLI 并启动预览docs/README.md给出的本地开发流程分三步这是文档贡献者最核心的实操路径1. 全局安装锁定版本的 Mintlify CLInpm install --global mint4.2.689注意 README 特意要求安装经过审阅的具体版本4.2.689而非latest目的是保证本地渲染行为与 CI/生产构建一致避免版本漂移导致的排版差异。2. 在文档根目录启动开发服务器mint dev该命令必须在包含docs.json的目录即本仓库的docs/下执行。Mintlify 以该文件作为站点定义的入口解析导航树、加载 MDX 页面并启动热更新服务器。3. 访问本地预览启动后在浏览器打开http://localhost:3000即可看到与线上一致的文档站点支持 MDX 修改后的即时热重载。配套细节.mintlifyignore与 CI 校验docs/.mintlifyignore 将AGENTS.md、.claude/、docs/scripts/等目录排除在构建之外。这意味着写给 AI 辅助工具看的风格指南docs/AGENTS.md不会成为线上页面也不会被 broken-links 检查当作导航缺失项。若你在docs/下新增了非页面文件需要考虑是否加入该忽略列表。仓库 CI 中对文档目录有独立的 PR 校验.github/workflows/docs-check-provider-cards.yml 在docs/user-guide/providers/**/getting-started-*.mdx、docs/snippets/provider-cards.mdx或 docs/scripts/generate_provider_cards.py 发生变化时自动校验 Provider 卡片 snippet 与源文件的一致性。这提示我们provider 的 getting-started 页面并非纯手工内容其卡片部分由脚本生成修改页面时需注意与该 workflow 的约定。三、可复用 MDX 组件VersionBadge 与 AppliesTo文档写作规范见下文第四节要求为新功能标注引入版本其实现载体位于docs/snippets/。以 docs/snippets/version-badge.mdx 为例VersionBadge是一个纯 MDX React 组件接收versionprop渲染一个指向对应 GitHub Release 的Added in: x.y.z徽章。在页面中的用法import { VersionBadge } from /snippets/version-badge.mdx ## New Feature Name VersionBadge version4.5.0 / Description of the feature...规范要求版本号使用语义化格式且不带v前缀徽章单独成行、紧跟小节标题之后其后空一行再写正文。另一个常用组件AppliesTodocs/snippets/applies-to.mdx用于声明某篇指南适用于哪些产品Prowler Cloud / Prowler Private Cloud / Prowler Local Server默认覆盖全部三者可通过productsprop 收窄范围。docs/AGENTS.md还规定了二者与Cloud 订阅标记绿色云图标 SVG经 docs/style.css 的::after规则注入侧边栏的互斥/叠加关系带订阅横幅的页面不需要再挂 AppliesTo侧边栏标记通过style.css中按页面路径的li[id...] a span::after选择器添加。四、写作规范docs/AGENTS.md风格指南docs/README.md的 Documentation Guidelines 一节要求贡献者遵循.claude目录中的风格指南在当前仓库中这份指南的实体内容位于 docs/AGENTS.md它是一份相当完整的品牌语气与排版手册核心规则包括产品命名Naming ConventionsProwler 功能名按专有名词处理产品分两个家族——Prowler ProductsProwler Cloud、Prowler Private Cloud、Prowler Hub、Prowler Lighthouse AI、Prowler MCP与 Open Source 项目Prowler CLI、Prowler Local Server、Prowler Local Dashboard、Prowler SDK。旧名 Prowler App / Prowler Enterprise 仅允许出现在产品族映射页与全站横幅中新文档禁止使用。无偏沟通避免性别化代词与名词如Businessman - businessperson、避免军事化措辞kill chain - cyberattack chain、明确 safety个体层面与 security宏观层面的区分。动词优于名词结构优先 The report was successfully created 而非 The creation of the report was successful更短且意图前置也利于 SEO 关键词布局。标题大小写章节标题使用 Title Case缩写展开形式不逐词大写CTI (cyber threat intelligence)但保留AWS (Amazon Web Services)。链接与 URLURL 中用连字符而非下划线this-is-an-URL因为下划线会被视为词边界。警示分级Note低/ Warning中/ Danger高每个警示必须写明忽略后果并尽量给出补救路径。交互动词桌面用 Click / Double-click / Right-click触屏用 Tap / Swipe且给出统一术语表。这份指南同时面向人类作者与 AI 辅助写作流程文件名AGENTS.md即面向 Agent 的说明配合docs.json中注入的markdown.instructions构成对文档一致性从写作到渲染两端的双重约束。五、发布流程与故障排查发布Publishing Changes按docs/README.md推送到main分支的变更会通过 Mintlify 的 GitHub 集成自动部署到生产环境。对贡献者而言这意味着文档 PR 合并即上线本地预览mint dev是唯一预检手段合并前务必完整走一遍预览移动/重命名页面时记得在 docs/docs.json 的redirects数组中登记旧路径映射沿用现有的source/destination结构支持:slug*通配符新增页面必须同时更新navigation中的对应pages列表否则页面存在但不出现在侧边栏这也正是官方 Troubleshooting 中 404 项的第二条原因。故障排查TroubleshootingREADME 给出两条官方排查路径可结合仓库结构进一步落地本地开发服务器起不来—— 执行mint update更新 CLI 至最新版本后重试若更新版本行为异常回退到 README 指定的锁定版本4.2.689以对齐生产构建。某页面 404—— 逐项核对两点执行mint dev的目录中是否存在合法的docs.json即是否位于仓库的docs/下该页面的相对路径不含.mdx后缀是否已正确写入docs.json的 navigation。排查时可以 grep 导航配置确认注册状态例如在docs/下搜索目标页面名若页面文件存在但未 404 也未出现在导航基本可判定是导航未注册。六、贡献文档的完整工作流小结综合docs/README.md与仓库证据一次完整的文档变更流程为定位归属根据内容类型确定目录入门 -docs/getting-started/功能教程/Provider/合规 -docs/user-guide/开发 -docs/developer-guide/安全 -docs/security/编写页面使用 MDX 语法为新功能加VersionBadge跨产品指南加AppliesTo文案遵循 docs/AGENTS.md 的命名与语气规则注册导航在 docs/docs.json 的对应 Tab/Group 中加入页面路径如需替换旧路径追加redirects条目本地验证npm install --global mint4.2.689后在docs/下mint dev访问http://localhost:3000检查渲染、侧边栏标记与重定向CI 校验涉及 provider getting-started 页面时注意 docs-check-provider-cards workflow 的卡片一致性检查合并发布推送到main后由 Mintlify 自动部署。这套README 定流程、docs.json定结构、AGENTS.md定风格、CI workflow 守一致性的文档工程模式是 Prowler 官方文档能长期保持多产品、多 Provider 内容规模下结构清晰的关键。【免费下载链接】prowlerProwler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment.项目地址: https://gitcode.com/GitHub_Trending/pr/prowler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Prowler 文档站点架构与本地开发实战：基于 Mintlify 的 Prowler 官方文档工程指南
Prowler 文档站点架构与本地开发实战基于 Mintlify 的 Prowler 官方文档工程指南【免费下载链接】prowlerProwler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment.项目地址: https://gitcode.com/GitHub_Trending/pr/prowler本文基于 Prowler 仓库内的docs/README.md展开讲清官方文档站点的三层内容架构Getting Started / User Guide / Developer Guide如何组织在docs/目录中并覆盖文档本地预览Mintlify CLImint dev、发布流程、写作风格规范docs/AGENTS.md与常见问题排查。读完后你将能够独立完成文档页面的新增、本地调试、导航注册与发布验证。一、Prowler 文档站点的定位与目录布局docs/README.md开宗明义该目录承载的是 Prowler 开源文档站点由 Mintlify 驱动。理解这一点的意义在于——整个docs/目录同时是内容源与站点配置而不是单纯的 Markdown 文件夹。从仓库实际目录结构看docs/顶层包含路径作用docs/docs.jsonMintlify 站点配置主题、导航树、页眉页脚、重定向规则docs/introduction.mdx文档首页H1 入口docs/getting-started/入门内容产品族、安装、基础用法、方案对比docs/user-guide/用户指南Prowler Cloud、CLI、Provider、合规docs/developer-guide/开发者指南Provider/Check 开发、测试、调试docs/security/安全合规说明加密、数据区域、网络、软件安全docs/snippets/可复用 MDX 组件VersionBadge、AppliesTo 等docs/style.css站点自定义样式如侧边栏 Cloud 标记docs/images/文档配图资源docs/AGENTS.md文档风格指南品牌语气、命名规范、排版规则docs/.mintlifyignoreMintlify 构建时忽略的文件如AGENTS.mdREADME 中描述的三层结构Getting Started / User Guide / Developer Guide与docs.json中的navigation.tabs一一对应但实际站点比 README 的概括更细从 docs/docs.json 可以看到导航树共定义了 8 个顶级 Tab——Getting Started、Guides、Developer Guide、Security、Support、Troubleshooting、Changelog外加一个外链About Us。也就是说README 的三段式描述是面向贡献者的概念地图而真正决定页面出现在哪里的是docs.json的 Tab/Group 嵌套结构。导航配置采用 Mintlify 的标准层级navigation.tabs[] - groups[] - pages[]pages中每个字符串对应docs/下去掉.mdx后缀的文件路径例如user-guide/providers/aws/authentication对应docs/user-guide/providers/aws/authentication.mdx。页面还可以是嵌套对象实现无限层级的分组。站点级配置要点除导航外docs/docs.json 还集中管理了若干影响全站行为的配置值得在修改文档前了解品牌与外观theme: mint、主色#10B981品牌绿、明暗两套 Logo/images/prowler-logo-black.png/prowler-logo-white.png全局横幅banner当前用于公告产品更名——Prowler App 现更名为 Prowler Local ServerProwler Enterprise 现更名为 Prowler Private Cloud并设为dismissible: false不可关闭Markdown 指令markdown.instructions向 LLM/搜索回答注入产品命名规范确保新旧产品名的准确使用反馈组件feedback开启点赞评分、建议编辑与提 Issue重定向表redirects迁移历史 URL 到新路径例如/contact - /support、/user-guide/tutorials/prowler-app-alerts - /user-guide/tutorials/prowler-alerts以及一大批旧 Read the Docs 风格路径/projects/prowler-open-source/en/latest/...到现行结构的通配重定向:slug*。新增或移动页面时应参照此模式补充重定向避免旧链接 404。二、本地开发安装 CLI 并启动预览docs/README.md给出的本地开发流程分三步这是文档贡献者最核心的实操路径1. 全局安装锁定版本的 Mintlify CLInpm install --global mint4.2.689注意 README 特意要求安装经过审阅的具体版本4.2.689而非latest目的是保证本地渲染行为与 CI/生产构建一致避免版本漂移导致的排版差异。2. 在文档根目录启动开发服务器mint dev该命令必须在包含docs.json的目录即本仓库的docs/下执行。Mintlify 以该文件作为站点定义的入口解析导航树、加载 MDX 页面并启动热更新服务器。3. 访问本地预览启动后在浏览器打开http://localhost:3000即可看到与线上一致的文档站点支持 MDX 修改后的即时热重载。配套细节.mintlifyignore与 CI 校验docs/.mintlifyignore 将AGENTS.md、.claude/、docs/scripts/等目录排除在构建之外。这意味着写给 AI 辅助工具看的风格指南docs/AGENTS.md不会成为线上页面也不会被 broken-links 检查当作导航缺失项。若你在docs/下新增了非页面文件需要考虑是否加入该忽略列表。仓库 CI 中对文档目录有独立的 PR 校验.github/workflows/docs-check-provider-cards.yml 在docs/user-guide/providers/**/getting-started-*.mdx、docs/snippets/provider-cards.mdx或 docs/scripts/generate_provider_cards.py 发生变化时自动校验 Provider 卡片 snippet 与源文件的一致性。这提示我们provider 的 getting-started 页面并非纯手工内容其卡片部分由脚本生成修改页面时需注意与该 workflow 的约定。三、可复用 MDX 组件VersionBadge 与 AppliesTo文档写作规范见下文第四节要求为新功能标注引入版本其实现载体位于docs/snippets/。以 docs/snippets/version-badge.mdx 为例VersionBadge是一个纯 MDX React 组件接收versionprop渲染一个指向对应 GitHub Release 的Added in: x.y.z徽章。在页面中的用法import { VersionBadge } from /snippets/version-badge.mdx ## New Feature Name VersionBadge version4.5.0 / Description of the feature...规范要求版本号使用语义化格式且不带v前缀徽章单独成行、紧跟小节标题之后其后空一行再写正文。另一个常用组件AppliesTodocs/snippets/applies-to.mdx用于声明某篇指南适用于哪些产品Prowler Cloud / Prowler Private Cloud / Prowler Local Server默认覆盖全部三者可通过productsprop 收窄范围。docs/AGENTS.md还规定了二者与Cloud 订阅标记绿色云图标 SVG经 docs/style.css 的::after规则注入侧边栏的互斥/叠加关系带订阅横幅的页面不需要再挂 AppliesTo侧边栏标记通过style.css中按页面路径的li[id...] a span::after选择器添加。四、写作规范docs/AGENTS.md风格指南docs/README.md的 Documentation Guidelines 一节要求贡献者遵循.claude目录中的风格指南在当前仓库中这份指南的实体内容位于 docs/AGENTS.md它是一份相当完整的品牌语气与排版手册核心规则包括产品命名Naming ConventionsProwler 功能名按专有名词处理产品分两个家族——Prowler ProductsProwler Cloud、Prowler Private Cloud、Prowler Hub、Prowler Lighthouse AI、Prowler MCP与 Open Source 项目Prowler CLI、Prowler Local Server、Prowler Local Dashboard、Prowler SDK。旧名 Prowler App / Prowler Enterprise 仅允许出现在产品族映射页与全站横幅中新文档禁止使用。无偏沟通避免性别化代词与名词如Businessman - businessperson、避免军事化措辞kill chain - cyberattack chain、明确 safety个体层面与 security宏观层面的区分。动词优于名词结构优先 The report was successfully created 而非 The creation of the report was successful更短且意图前置也利于 SEO 关键词布局。标题大小写章节标题使用 Title Case缩写展开形式不逐词大写CTI (cyber threat intelligence)但保留AWS (Amazon Web Services)。链接与 URLURL 中用连字符而非下划线this-is-an-URL因为下划线会被视为词边界。警示分级Note低/ Warning中/ Danger高每个警示必须写明忽略后果并尽量给出补救路径。交互动词桌面用 Click / Double-click / Right-click触屏用 Tap / Swipe且给出统一术语表。这份指南同时面向人类作者与 AI 辅助写作流程文件名AGENTS.md即面向 Agent 的说明配合docs.json中注入的markdown.instructions构成对文档一致性从写作到渲染两端的双重约束。五、发布流程与故障排查发布Publishing Changes按docs/README.md推送到main分支的变更会通过 Mintlify 的 GitHub 集成自动部署到生产环境。对贡献者而言这意味着文档 PR 合并即上线本地预览mint dev是唯一预检手段合并前务必完整走一遍预览移动/重命名页面时记得在 docs/docs.json 的redirects数组中登记旧路径映射沿用现有的source/destination结构支持:slug*通配符新增页面必须同时更新navigation中的对应pages列表否则页面存在但不出现在侧边栏这也正是官方 Troubleshooting 中 404 项的第二条原因。故障排查TroubleshootingREADME 给出两条官方排查路径可结合仓库结构进一步落地本地开发服务器起不来—— 执行mint update更新 CLI 至最新版本后重试若更新版本行为异常回退到 README 指定的锁定版本4.2.689以对齐生产构建。某页面 404—— 逐项核对两点执行mint dev的目录中是否存在合法的docs.json即是否位于仓库的docs/下该页面的相对路径不含.mdx后缀是否已正确写入docs.json的 navigation。排查时可以 grep 导航配置确认注册状态例如在docs/下搜索目标页面名若页面文件存在但未 404 也未出现在导航基本可判定是导航未注册。六、贡献文档的完整工作流小结综合docs/README.md与仓库证据一次完整的文档变更流程为定位归属根据内容类型确定目录入门 -docs/getting-started/功能教程/Provider/合规 -docs/user-guide/开发 -docs/developer-guide/安全 -docs/security/编写页面使用 MDX 语法为新功能加VersionBadge跨产品指南加AppliesTo文案遵循 docs/AGENTS.md 的命名与语气规则注册导航在 docs/docs.json 的对应 Tab/Group 中加入页面路径如需替换旧路径追加redirects条目本地验证npm install --global mint4.2.689后在docs/下mint dev访问http://localhost:3000检查渲染、侧边栏标记与重定向CI 校验涉及 provider getting-started 页面时注意 docs-check-provider-cards workflow 的卡片一致性检查合并发布推送到main后由 Mintlify 自动部署。这套README 定流程、docs.json定结构、AGENTS.md定风格、CI workflow 守一致性的文档工程模式是 Prowler 官方文档能长期保持多产品、多 Provider 内容规模下结构清晰的关键。【免费下载链接】prowlerProwler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment.项目地址: https://gitcode.com/GitHub_Trending/pr/prowler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考