ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

10分钟摸清 authentik 文档系统:从目录结构到多语言发布

10分钟摸清 authentik 文档系统:从目录结构到多语言发布 10分钟摸清 authentik 文档系统从目录结构到多语言发布【免费下载链接】authentikThe authentication glue you need.项目地址: https://gitcode.com/GitHub_Trending/au/authentik第一次克隆下 authentik 仓库的人经常会在根目录看到website/、locale/、packages/一堆文件夹一时不知道文档到底在哪、怎么改、怎么发。这篇带你按「先看长什么样 → 再分清目录 → 最后跑通一条多语言构建链路」的顺序10 分钟摸清 authentik 文档系统的门路。全程不需要改一行配置只需要知道每个文件夹是干什么的。上面是 authentik 管理界面的浅色模式文档里所有「去管理界面做某事」的步骤配图风格都和它一致。支持深浅两种主题深色版长这样三个目录看懂文档分区authentik 的文档站基于Docusaurus构建内容全部放在website/下分成三个互不干扰的站点website/docs/主文档站安装配置、核心概念、用户与源管理都在这里也是日常更新最多的地方website/api/API 参考文档website/integrations/第三方应用集成教程三者各有独立的docusaurus.config.*配置文件构建后合并成同一个文档站用路径区分。为什么拆三份因为主文档更新频繁而 API 文档由接口定义生成、集成文档相对独立分开配置可以各改各的互不牵连。主文档内部按主题再分目录install-config/讲部署users-sources/讲账号与身份源sys-mgmt/讲运维customize/讲界面定制。写新文档时先找到对应主题目录放进去侧边栏会自动按目录组织。一份配置看懂导航与搜索每个站点的路由、侧边栏、导航栏都靠一个入口文件定义主文档站的是 website/docs/docusaurus.config.esm.mjs。新手不用逐行读抓住三点就行预设通过createClassicPreset声明使用经典布局自动获得文档路由、侧边栏、搜索框主题themes里挂入了自研的goauthentik/docusaurus-theme和 Mermaid 图表主题所以文档里能直接画流程图插件版本发布插件、重定向插件、搜索配置都在这挂上也就是说界面长什么样、搜索走哪个服务、旧链接怎么跳转最终都能在这份配置和它引用的 packages/docusaurus-config/ 公共库里找到答案。一条链路跑通多语言构建本地化部分最容易让人摸不着头脑其实就是一条完整链路提取 → 翻译 → 构建 → 上线四个环节各归各的文件夹。提取跑pnpm docusaurus write-translations从文档源文件里抽出生成的待翻译条目翻译翻译结果放在仓库根目录的 locale/ 下按语言分子目录每种语言一个LC_MESSAGES目录存放 PO 文件。目前已有 zh-Hans、ja-JP、ko-KR、de_DE、fr_FR 等 27 个语言目录构建Docusaurus 的 i18n 机制读取这些 PO 文件生成对应语言版本构建命令带上语言参数如pnpm build -- --locale zh-Hans上线website/docs/package.json 里的build脚本会执行docusaurus build并把产物拷到build/目录静态文件即可交给 Nginx、Netlify 或任何对象存储托管动手清单与常见坑准备上手改文档时照这份清单走先装对依赖仓库用 pnpm 管理pnpm-workspace.yaml定义了 workspace装完依赖后pnpm start在website/docs/下起本地预览图片用相对路径截图放对应主题的目录里如website/docs/sys-mgmt/下已有dashboard.png这类示例引用时用相对路径别丢到站点根目录乱堆图表直接写 Mermaid主题已内置 mermaid 支持Markdown 里直接贴代码块就能出图三个高频坑改完文档本地正常、构建后链接错乱——通常是链接跨站了Docusaurus 对/api、/integrations这类路径做了重写手动写绝对路径容易踩雷新增语言目录但页面不生效——忘了跑提取命令PO 文件里没有对应语言的条目构建产物找不到——build脚本会把website/docs/build/拷贝到website/build/部署的是后者延伸阅读目录分区与侧边栏website/docs/sidebar.mjs全站公共样式与主题packages/docusaurus-config/、website/docusaurus-theme/本地语言目录locale/构建入口与脚本website/docs/package.json把这三个目录和一条构建链路记住你就已经能独立维护 authentik 的任意一篇文档了。【免费下载链接】authentikThe authentication glue you need.项目地址: https://gitcode.com/GitHub_Trending/au/authentik创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表