用途:指导在 Elixir 项目中配置 ExDoc 文档生成,覆盖 mix.exs 设置、extras 页面、模块与 extras 分组、速查表(.cheatmd)和 Livebook(.livemd)等场景。
主要能力:在 deps 中加入 {:ex_doc, "~> 0.34", only: :dev, runtime: false};在 project/0 中配置 name、source_url、homepage_url 及 docs()。docs/0 支持 main(落地页,默认 "api-reference",可设为 "readme" 或某模块名)、logo、output(默认 "doc")、formatters(["html"],可加 "epub")、source_ref、assets、deps 等键。extras/0 列出额外页面路径,可用 {路径, [title: "..."]} 覆盖标题,顺序即侧栏顺序。groups_for_modules/0 与 groups_for_extras/0 支持列表或正则分组;groups_for_docs/0 通过 @doc section: :xxx 元数据分组函数。deps 可配置依赖文档链接以支持交叉引用。
使用方式:先运行 mix deps.get 确认依赖;确保 extras 中每个路径真实存在;再运行 mix docs,确认输出目录下存在 index.html。速查表、Livebook 及自定义 head/body 资源同样遵循“列出前路径须存在”原则。
适用场景:为 Elixir 库或应用搭建 API 文档站点、组织指南与教程侧栏、生成 HTML 或 EPUB。
限制:速查表、Livebook、自定义 CSS/JS、语法高亮与模块嵌套等进阶配置,资料指向 references/extras-formats.md 与 references/advanced-config.md,此处暂未提供其详细内容。