Skip to main content
使用 sdk 导航属性，可以基于你已经在运行的文档工具，为你的 SDK 库生成参考页面。Mintlify 会读取每个工具生成的构建产物，为每个 class、interface、module 和 function 创建一个页面，并自动生成导航分组、跨页链接与搜索索引。

​
支持的格式

​
生成构建产物

以机器可读的输出格式运行你的文档工具。如果你已经在 CI 中发布生成的文档，通常只需在同一条命令上加一个参数即可。

​
自动填充 SDK 页面

在 docs.json 中的某个 tab 上添加 sdk 属性。Mintlify 会解析该构建产物，并为该库创建导航分组和页面。
你必须在 tab 上声明 sdk。包含 sdk 的 tab 可以包含 groups，但不能包含其他导航结构，例如 pages、versions 或 languages。它也不能包含 openapi、asyncapi 或 graphql 属性。
​
string
必填
生成构建产物的文档工具：typedoc、docfx、javadoc、sphinx 或 phpdoc。
​
string
必填
指向文档仓库中构建产物文件或目录的相对路径，或者一个 HTTPS URL。不接受 HTTP URL。
​
string
生成页面的 URL 路径前缀。默认值为 sdk-reference。
添加多个 tab 即可为多个库生成文档。为每个库使用唯一的 directory，以避免路由冲突。
将你的构建产物目录添加到 .mintignore，让 Mintlify 将这些产物视为构建输入，而不是作为静态资源发布。

​
生成的页面

Mintlify 会将生成的导航组添加到 tab 上任何 groups 之后。这些组因格式而异，可能表示模块、包、命名空间或符号类型。 每个生成的页面都记录了构建产物中的一个类、接口、函数、类型或其他符号，并链接到相关的生成页面。如果转换器生成的页面不属于任何组，Mintlify 会将它们归入 Reference 组。

​
使用远程源

将 source 设置为 HTTPS URL，即可在构建时获取构建产物，而无需将其提交到文档仓库中。 单文件格式 (typedoc、phpdoc) 可直接接受文件 URL。目录格式 (docfx、javadoc、sphinx) 接受 zip 压缩包。发布到 Maven Central 的 Javadoc jar 无需重新打包即可使用：
远程构建产物的下载大小上限为 50 MB，解压后大小上限为 200 MB。

​
保持参考文档最新

在你的 SDK 发生变化时，重新生成构建产物。常见做法是在每个 SDK 仓库中设置一个 CI 任务，在发布时运行文档工具，并将构建产物提交到文档仓库，或上传到 source 所指向的稳定 URL。