sdk 导航属性,可以基于你已经在使用的文档工具,为 SDK 库生成参考页面。Mintlify 会读取每个工具生成的构建产物,为每个 class、interface、module 和 function 创建一个页面,并自动生成导航分组、跨页链接与搜索索引。
支持的格式
生成构建产物
自动填充 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。directory,以避免路由冲突。
生成的页面
groups 之后。这些组因格式而异,可能表示模块、包、命名空间或符号类型。
每个生成的页面都记录了构建产物中的一个类、接口、函数、类型或其他符号,并链接到相关的生成页面。如果转换器生成的页面不属于任何组,Mintlify 会将它们归入 Reference 组。
使用远程源
source 设置为 HTTPS URL,即可在构建时获取构建产物,而无需将其提交到文档仓库中。
单文件格式(typedoc、phpdoc)可直接接受文件 URL。目录格式(docfx、javadoc、sphinx)接受 zip 压缩包。发布到 Maven Central 的 Javadoc jar 无需重新打包即可使用:
保持参考文档最新
source 所指向的稳定 URL。
仓库设置
SDK 和文档位于同一仓库
source 指向其相对路径。任何在 push 或 release 时生成构建产物的工作流都可以将其提交回仓库,并在下一次文档站点部署时发布更新。
SDK 位于单独的仓库
-
将构建产物提交到文档仓库。 在 SDK 仓库中设置一个在发布时运行的 CI 任务。该任务生成构建产物,并向文档仓库发起拉取请求(或推送提交),其中包含更新后的文件。将此更改合并到部署分支以触发站点部署。将
source指向已提交的路径,与单仓库设置相同。 -
托管构建产物并在构建时获取。 将构建产物上传到稳定的 HTTPS URL,例如 S3 存储桶、GitHub Releases 资源或 Maven Central 上的 Javadoc jar。将
source设置为该 URL。每次更新构建产物时,触发文档站点部署以获取新构建产物。发布构建产物后,从 SDK 发布流水线调用触发部署端点。