sdk navigation property to generate reference pages for your SDK libraries from the documentation tools you already run. Mintlify reads each tool’s build artifact and creates a page for every class, interface, module, and function, with navigation groups, cross-page links, and search indexing included.
Supported formats
Generate an artifact
Run your documentation tool with a machine-readable output format. If you already publish generated docs from CI, this is usually a one-flag change to the same command.Auto-populate SDK pages
Add ansdk property to a tab in your docs.json. Mintlify parses the artifact and creates navigation groups and pages for the library.
string
required
The documentation tool that produced the artifact:
typedoc, docfx, javadoc, sphinx, or phpdoc.string
required
Relative path to the artifact file or directory in your docs repository, or an HTTPS URL.
string
The URL path prefix for generated pages. Defaults to
sdk-reference.directory.
Use remote sources
Setsource to an HTTPS URL to fetch the artifact at build time instead of committing it to your docs repository.
Single-file formats (typedoc, phpdoc) accept a direct file URL. Directory formats (docfx, javadoc, sphinx) accept a zip archive. Javadoc jars published to Maven Central work without repackaging:
Keep references up to date
Regenerate the artifact whenever your SDK changes. A common pattern is a CI job in each SDK repository that runs the documentation tool on release and either commits the artifact to your docs repository or uploads it to a stable URL thatsource points to.