Anydocs Documents
主题配置

atlas-docs 主题

了解 atlas-docs 主题的顶部导航与阅读体验配置。

`atlas-docs` 是当前内置的顶部导航型 reader 主题。它适合把内容分成几个主分组,并通过页头切换不同知识域。

布局与适用场景

这个主题把品牌区和主要分组放在页头,把当前分组下的导航放在侧边栏。它适合产品文档、开发者门户和需要把“指南 / API / 参考”分组展示的站点。

必须配合的配置

`atlas-docs` 的关键差异不只是把 `site.theme.id` 改成 `atlas-docs`,还要配置 `site.navigation.topNav`。当前 `topNav` 只支持两类项目:`nav-group` 和 `external`。其中 `nav-group.groupId` 必须指向每种启用语言导航文件里的顶层 `section` 或 `folder` id。

当前可配置项

它支持 reader 品牌字段 `siteTitle`、`logoSrc`、`logoAlt`,支持 `site.theme.chrome.showSearch`、`site.theme.codeTheme`,也支持一组共享颜色字段:`primary`、`primaryForeground`、`accent`、`accentForeground`。

运行时行为

`atlas-docs` 支持搜索和语言切换,不支持暗色模式。顶部导航标签可以按语言分别配置,外部链接也可以选择是否新开标签页。

Top Nav 范围: 只有支持顶部导航的主题才会使用 `site.navigation.topNav`。在当前内置主题中,这意味着 `atlas-docs` 会使用它,而 `classic-docs` 不会。
分组引用必须可解析: 如果 `topNav` 里的 `groupId` 指向不存在的顶层分组,项目校验或构建流程会报错。先在每种语言的导航树中建立对应的 `section` 或 `folder`,再把它接入顶部导航。