authentik Docusaurus 文档站实战3 个目录、1 套配置10 分钟找到并跑起官方文档【免费下载链接】authentikThe authentication glue you need.项目地址: https://gitcode.com/GitHub_Trending/au/authentikauthentik 是一个开源身份认证平台Identity Provider它的官方文档站在同一个仓库里用 Docusaurus 拆成了三个独立站点。如果你只想查集成指南、改一条文档、或在本地把文档站跑起来只需记住 website/ 下的三个子目录和一个共享配置包——本文按“先查文档、再改文档、后本地调试”的顺序讲清楚每步该打开哪里。从一次查文档的动作开始先看三类最常见的读者动作再对应到目录使用者想知道“authentik 怎么接 GitHub SAML”文档入口在 website/integrations/按平台分类聊天协作、云厂商、监控、网络等。维护者要改一条“安装配置”说明正文在 website/docs/ 对应的主题目录里。开发者想看接口字段API 参考在 website/api/是单独的一个 Docusaurus 站点。三个站点各自独立构建、独立部署但共用一套主题和配置这是后面所有内容的核心。三个站点共用一套配置差异写在哪里以主题文档站为例配置入口是 website/docs/docusaurus.config.esm.mjs它本身不写死太多细节而是调用createDocusaurusConfig把三处东西合在一起基础预设createClassicPreset负责文档路由与侧边栏routeBasePath设为/说明这个站直接占根路径。共享配置包位于 packages/docusaurus-config/内含导航栏、路由、主题等公共逻辑和 CSSlib/与css/目录三个站点由此保持视觉一致。自研主题website/docusaurus-theme/ 提供搜索Algolia、旧链接重定向、版本化发布说明以及为 LLM 生成llms.txt的插件源码在主题目录下的llms-txt/、redirects/、releases/。如果你要调整“文档站长什么样”优先改共享配置包如果只是某个站点特有的行为改对应目录下的docusaurus.config.esm.mjs。快速查看文档目录结构website/docs/ 下每个顶层目录就是一个主题分区install-config/安装与配置add-secure-apps/接入并保护应用含流程、Outpost、Provider 教程users-sources/用户与数据源管理sys-mgmt/、troubleshooting/、security/系统管理、排障、安全releases/按版本存放的发布说明侧边栏不用手写——website/docs/sidebar.mjs 读取 website/docs/categories.mjs 里的目录映射用 Docusaurus 的autogenerated机制自动生成分区某分区存在index.mdx时分区标题会直接链接到该页。想确认“侧边栏为什么长这样”看这两个文件即可。定位多语言翻译文件仓库里的翻译目录和 Docusaurus 的 i18n 不是一回事容易混淆locale/gettext 风格的翻译目录每个语言如zh-Hans/、de_DE/下有.po源文件和编译后的.mo主要服务于后端界面文案。文档站的翻译工作流侧边栏里挂了一个专门的翻译说明页入口见 website/docs/developer-docs/ 下的translation条目sidebar.mjs中引用文档站多语言以它为准。验证翻译是否生效最直接的方式是本地把站点跑起来后切换语言查看而不是只翻文件。本地调试文档站的三条路径构建文档站点文档站是 pnpm workspace 的一部分包名goauthentik/docs-topics见 website/docs/package.json。进入 website/docs/ 后pnpm start # 启动本地开发服务即 docusaurus start pnpm build # 构建静态站产物复制到 website/build/build脚本实际是docusaurus build cp -r ./build/ ../build/也就是说三个站最终会汇合到 website/build/ 下的同一目录由外层容器或部署统一发布——这就是“三个站、一套发布产物”的实现方式。查看版本化发布说明的生成逻辑releases/目录里的 Markdown 不是手工拼进侧边栏的配置中的goauthentik/docusaurus-theme/releases/plugin会扫描该目录按版本生成侧边栏条目sidebar.mjs里的collectReleaseFiles与createReleaseSidebarEntries。新增一个版本的说明就是把文档放进 website/docs/releases/插件自动接管。用 VS Code 断点调试前端改动修改主题组件或插件逻辑时仓库自带调试文档配图如下位于developer-docs/setup/动手之前先记住的入口你要做的事打开的位置改主题文档正文website/docs/ 对应主题目录改 API 参考website/api/写集成教程website/integrations/参考其template/目录改外观与导航packages/docusaurus-config/ 与 website/docusaurus-theme/改侧边栏分区sidebar.mjscategories.mjs各站点目录下加版本发布说明website/docs/releases/需要拉取源码时执行git clone https://gitcode.com/GitHub_Trending/au/authentik然后按上表定位文件即可。整体记住一句话三个站点各自配置、共享主题、汇总发布目录即分区插件即行为。【免费下载链接】authentikThe authentication glue you need.项目地址: https://gitcode.com/GitHub_Trending/au/authentik创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考