diff --git a/es.json b/es.json
index 47e0a17491..5353ac6dc3 100644
--- a/es.json
+++ b/es.json
@@ -157,6 +157,7 @@
"es/api-playground/mdx-setup",
"es/api-playground/asyncapi-setup",
"es/api-playground/graphql-setup",
+ "es/api-playground/sdk-reference-setup",
"es/api-playground/troubleshooting"
]
},
diff --git a/es/api-playground/sdk-reference-setup.mdx b/es/api-playground/sdk-reference-setup.mdx
new file mode 100644
index 0000000000..c43b2f9ed8
--- /dev/null
+++ b/es/api-playground/sdk-reference-setup.mdx
@@ -0,0 +1,116 @@
+---
+title: "Configuración de referencias de SDK"
+description: "Genera páginas de referencia de SDK a partir de tus herramientas de documentación existentes: TypeDoc, DocFX, Javadoc, Sphinx o phpDocumentor."
+keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
+---
+
+Usa la propiedad de navegación `sdk` para generar páginas de referencia para tus bibliotecas de SDK a partir de las herramientas de documentación que ya utilizas. Mintlify lee el artefacto de compilación de cada herramienta y crea una página para cada clase, interfaz, módulo y función, con grupos de navegación, enlaces entre páginas e indexación de búsqueda incluidos.
+
+
+ ## Formatos compatibles
+
+
+| `format` | Tool | Artifact |
+| --- | --- | --- |
+| `typedoc` | [TypeDoc](https://typedoc.org) (TypeScript/JavaScript) | Archivo de exportación JSON |
+| `docfx` | [DocFX](https://dotnet.github.io/docfx/) (.NET) | Directorio de salida de `docfx metadata` (YAML de ManagedReference) |
+| `javadoc` | [Javadoc](https://docs.oracle.com/en/java/javase/17/javadoc/javadoc.html) (Java) | Directorio HTML del doclet estándar |
+| `sphinx` | [Sphinx](https://www.sphinx-doc.org) (Python) | Directorio de salida del builder JSON |
+| `phpdoc` | [phpDocumentor](https://phpdoc.org) (PHP) | Archivo `structure.xml` |
+
+
+ ## Generar un artefacto
+
+
+Ejecuta tu herramienta de documentación con un formato de salida legible por máquina. Si ya publicas documentación generada desde CI, normalmente basta con cambiar un solo flag en el mismo comando.
+
+
+
+```bash TypeDoc
+npx typedoc --json typedoc.json src/index.ts
+```
+
+```bash DocFX
+docfx metadata docfx.json
+```
+
+```bash Javadoc
+javadoc -d javadoc-output -sourcepath src/main/java -subpackages com.example
+# O descarga el jar de javadoc publicado desde Maven Central
+```
+
+```bash Sphinx
+python -m sphinx -b json docs/source artifacts/json
+```
+
+```bash phpDocumentor
+phpdoc -d src -t artifacts --template=xml
+```
+
+
+
+
+ ## Generar automáticamente páginas de SDK
+
+
+Agrega una propiedad `sdk` a una pestaña en tu `docs.json`. Mintlify analiza el artefacto y crea grupos de navegación y páginas para la biblioteca.
+
+```json
+"navigation": {
+ "tabs": [
+ {
+ "tab": "SDK Reference",
+ "sdk": {
+ "format": "typedoc",
+ "source": "sdk-artifacts/typedoc.json",
+ "directory": "sdk/typescript"
+ }
+ }
+ ]
+}
+```
+
+
+ La herramienta de documentación que produjo el artefacto: `typedoc`, `docfx`, `javadoc`, `sphinx` o `phpdoc`.
+
+
+
+ Ruta relativa al archivo o directorio del artefacto en tu repositorio de documentación, o una URL HTTPS.
+
+
+
+ El prefijo de la ruta URL para las páginas generadas. El valor predeterminado es `sdk-reference`.
+
+
+Agrega varias pestañas para documentar varias bibliotecas. Cada pestaña necesita un `directory` único.
+
+
+ Agrega tu directorio de artefactos a [`.mintignore`](/es/organize/mintignore) para que Mintlify trate los artefactos como entradas de compilación en lugar de publicarlos como activos estáticos.
+
+
+
+ ## Usar fuentes remotas
+
+
+Establece `source` como una URL HTTPS para obtener el artefacto en tiempo de compilación en lugar de incluirlo en tu repositorio de documentación.
+
+Los formatos de archivo único (`typedoc`, `phpdoc`) aceptan una URL directa al archivo. Los formatos de directorio (`docfx`, `javadoc`, `sphinx`) aceptan un archivo zip. Los jars de Javadoc publicados en Maven Central funcionan sin necesidad de reempaquetarlos:
+
+```json
+{
+ "tab": "Java SDK",
+ "sdk": {
+ "format": "javadoc",
+ "source": "https://repo1.maven.org/maven2/com/example/my-library/1.0.0/my-library-1.0.0-javadoc.jar",
+ "directory": "sdk/java"
+ }
+}
+```
+
+Los artefactos remotos tienen un límite de descarga de 50 MB y un límite de tamaño extraído de 200 MB.
+
+
+ ## Mantener las referencias actualizadas
+
+
+Regenera el artefacto siempre que tu SDK cambie. Un patrón común es un trabajo de CI en cada repositorio de SDK que ejecuta la herramienta de documentación al publicar una nueva versión y luego confirma el artefacto en tu repositorio de documentación o lo sube a una URL estable a la que apunta `source`.
diff --git a/es/organize/navigation.mdx b/es/organize/navigation.mdx
index 291d242e71..615884615d 100644
--- a/es/organize/navigation.mdx
+++ b/es/organize/navigation.mdx
@@ -604,6 +604,33 @@ Para obtener más información sobre cómo hacer referencia a endpoints de OpenA
```
+
+ ## Referencias de SDK
+
+
+Genera páginas de referencia de SDK a partir de los artefactos de compilación de tus herramientas de documentación. Agrega una propiedad `sdk` a una pestaña con el `format` del artefacto (`typedoc`, `docfx`, `javadoc`, `sphinx` o `phpdoc`), una ruta `source` o URL HTTPS, y un `directory` opcional para el prefijo de URL de las páginas generadas.
+
+Mintlify analiza el artefacto y genera grupos de navegación y páginas para cada clase, interfaz, módulo y función de la biblioteca.
+
+Para obtener más información sobre cómo generar artefactos y configurar fuentes, consulta la [Configuración de referencias de SDK](/es/api-playground/sdk-reference-setup).
+
+```json
+{
+ "navigation": {
+ "tabs": [
+ {
+ "tab": "TypeScript SDK",
+ "sdk": {
+ "format": "typedoc",
+ "source": "sdk-artifacts/typedoc.json",
+ "directory": "sdk/typescript"
+ }
+ }
+ ]
+ }
+}
+```
+
## Versiones
diff --git a/fr.json b/fr.json
index 6ab030d142..362f9091c6 100644
--- a/fr.json
+++ b/fr.json
@@ -157,6 +157,7 @@
"fr/api-playground/mdx-setup",
"fr/api-playground/asyncapi-setup",
"fr/api-playground/graphql-setup",
+ "fr/api-playground/sdk-reference-setup",
"fr/api-playground/troubleshooting"
]
},
diff --git a/fr/api-playground/sdk-reference-setup.mdx b/fr/api-playground/sdk-reference-setup.mdx
new file mode 100644
index 0000000000..adaf5d5ef0
--- /dev/null
+++ b/fr/api-playground/sdk-reference-setup.mdx
@@ -0,0 +1,116 @@
+---
+title: "Configuration des références SDK"
+description: "Générez des pages de référence SDK à partir de votre outillage de documentation existant : TypeDoc, DocFX, Javadoc, Sphinx ou phpDocumentor."
+keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
+---
+
+Utilisez la propriété de navigation `sdk` pour générer des pages de référence pour vos bibliothèques SDK à partir des outils de documentation que vous exécutez déjà. Mintlify lit l’artefact de build de chaque outil et crée une page pour chaque classe, interface, module et fonction, avec les groupes de navigation, les liens entre les pages et l’indexation pour la recherche inclus.
+
+
+ ## Formats pris en charge
+
+
+| `format` | Tool | Artifact |
+| --- | --- | --- |
+| `typedoc` | [TypeDoc](https://typedoc.org) (TypeScript/JavaScript) | Fichier d’export JSON |
+| `docfx` | [DocFX](https://dotnet.github.io/docfx/) (.NET) | Répertoire de sortie de `docfx metadata` (YAML ManagedReference) |
+| `javadoc` | [Javadoc](https://docs.oracle.com/en/java/javase/17/javadoc/javadoc.html) (Java) | Répertoire HTML du doclet standard |
+| `sphinx` | [Sphinx](https://www.sphinx-doc.org) (Python) | Répertoire de sortie du builder JSON |
+| `phpdoc` | [phpDocumentor](https://phpdoc.org) (PHP) | Fichier `structure.xml` |
+
+
+ ## Générer un artefact
+
+
+Exécutez votre outil de documentation avec un format de sortie lisible par machine. Si vous publiez déjà des docs générées depuis votre CI, il s’agit généralement de l’ajout d’un seul flag à la même commande.
+
+
+
+```bash TypeDoc
+npx typedoc --json typedoc.json src/index.ts
+```
+
+```bash DocFX
+docfx metadata docfx.json
+```
+
+```bash Javadoc
+javadoc -d javadoc-output -sourcepath src/main/java -subpackages com.example
+# Ou téléchargez le jar javadoc publié depuis Maven Central
+```
+
+```bash Sphinx
+python -m sphinx -b json docs/source artifacts/json
+```
+
+```bash phpDocumentor
+phpdoc -d src -t artifacts --template=xml
+```
+
+
+
+
+ ## Remplir automatiquement les pages SDK
+
+
+Ajoutez une propriété `sdk` à un onglet dans votre `docs.json`. Mintlify analyse l’artefact et crée des groupes de navigation et des pages pour la bibliothèque.
+
+```json
+"navigation": {
+ "tabs": [
+ {
+ "tab": "SDK Reference",
+ "sdk": {
+ "format": "typedoc",
+ "source": "sdk-artifacts/typedoc.json",
+ "directory": "sdk/typescript"
+ }
+ }
+ ]
+}
+```
+
+
+ L’outil de documentation qui a produit l’artefact : `typedoc`, `docfx`, `javadoc`, `sphinx` ou `phpdoc`.
+
+
+
+ Chemin relatif vers le fichier ou le répertoire de l’artefact dans votre dépôt de documentation, ou une URL HTTPS.
+
+
+
+ Le préfixe de chemin d’URL pour les pages générées. Par défaut, `sdk-reference`.
+
+
+Ajoutez plusieurs onglets pour documenter plusieurs bibliothèques. Chaque onglet doit avoir un `directory` unique.
+
+
+ Ajoutez le répertoire de votre artefact à [`.mintignore`](/fr/organize/mintignore) afin que Mintlify traite les artefacts comme des entrées de build plutôt que de les publier comme des ressources statiques.
+
+
+
+ ## Utiliser des sources distantes
+
+
+Définissez `source` sur une URL HTTPS pour récupérer l’artefact au moment du build au lieu de le committer dans votre dépôt de documentation.
+
+Les formats à fichier unique (`typedoc`, `phpdoc`) acceptent une URL de fichier directe. Les formats à répertoire (`docfx`, `javadoc`, `sphinx`) acceptent une archive zip. Les jars Javadoc publiés sur Maven Central fonctionnent sans reconditionnement :
+
+```json
+{
+ "tab": "Java SDK",
+ "sdk": {
+ "format": "javadoc",
+ "source": "https://repo1.maven.org/maven2/com/example/my-library/1.0.0/my-library-1.0.0-javadoc.jar",
+ "directory": "sdk/java"
+ }
+}
+```
+
+Les artefacts distants ont une limite de téléchargement de 50 Mo et une limite de taille extraite de 200 Mo.
+
+
+ ## Maintenir les références à jour
+
+
+Régénérez l’artefact chaque fois que votre SDK change. Un pattern courant est un job CI dans chaque dépôt de SDK qui exécute l’outil de documentation à chaque publication et, soit commite l’artefact dans votre dépôt de documentation, soit le téléverse vers une URL stable référencée par `source`.
diff --git a/fr/organize/navigation.mdx b/fr/organize/navigation.mdx
index 5e2a23a87c..8495b25acb 100644
--- a/fr/organize/navigation.mdx
+++ b/fr/organize/navigation.mdx
@@ -604,6 +604,33 @@ Pour plus d'informations sur la manière de référencer des endpoints OpenAPI d
```
+
+ ## Références SDK
+
+
+Générez des pages de référence SDK à partir des artefacts de build de vos outils de documentation. Ajoutez une propriété `sdk` à un onglet avec le `format` de l’artefact (`typedoc`, `docfx`, `javadoc`, `sphinx` ou `phpdoc`), un chemin `source` ou une URL HTTPS, et un `directory` optionnel pour le préfixe d’URL des pages générées.
+
+Mintlify analyse l’artefact et génère des groupes de navigation et des pages pour chaque classe, interface, module et fonction de la bibliothèque.
+
+Pour plus d’informations sur la génération d’artefacts et la configuration des sources, consultez [Configuration des références SDK](/fr/api-playground/sdk-reference-setup).
+
+```json
+{
+ "navigation": {
+ "tabs": [
+ {
+ "tab": "TypeScript SDK",
+ "sdk": {
+ "format": "typedoc",
+ "source": "sdk-artifacts/typedoc.json",
+ "directory": "sdk/typescript"
+ }
+ }
+ ]
+ }
+}
+```
+
## Versions
diff --git a/zh.json b/zh.json
index 277681565f..21fd853c06 100644
--- a/zh.json
+++ b/zh.json
@@ -154,6 +154,7 @@
"zh/api-playground/mdx-setup",
"zh/api-playground/asyncapi-setup",
"zh/api-playground/graphql-setup",
+ "zh/api-playground/sdk-reference-setup",
"zh/api-playground/troubleshooting"
]
},
diff --git a/zh/api-playground/sdk-reference-setup.mdx b/zh/api-playground/sdk-reference-setup.mdx
new file mode 100644
index 0000000000..7d512a25b6
--- /dev/null
+++ b/zh/api-playground/sdk-reference-setup.mdx
@@ -0,0 +1,116 @@
+---
+title: "SDK 参考设置"
+description: "使用你已有的文档工具 TypeDoc、DocFX、Javadoc、Sphinx 或 phpDocumentor 生成 SDK 参考页面。"
+keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
+---
+
+使用 `sdk` 导航属性，可以基于你已经在运行的文档工具，为你的 SDK 库生成参考页面。Mintlify 会读取每个工具生成的构建产物，为每个 class、interface、module 和 function 创建一个页面，并自动生成导航分组、跨页链接与搜索索引。
+
+
+ ## 支持的格式
+
+
+| `format` | Tool | Artifact |
+| --- | --- | --- |
+| `typedoc` | [TypeDoc](https://typedoc.org) (TypeScript/JavaScript) | JSON 导出文件 |
+| `docfx` | [DocFX](https://dotnet.github.io/docfx/) (.NET) | `docfx metadata` 输出目录 (ManagedReference YAML) |
+| `javadoc` | [Javadoc](https://docs.oracle.com/en/java/javase/17/javadoc/javadoc.html) (Java) | 标准 doclet HTML 目录 |
+| `sphinx` | [Sphinx](https://www.sphinx-doc.org) (Python) | JSON builder 输出目录 |
+| `phpdoc` | [phpDocumentor](https://phpdoc.org) (PHP) | `structure.xml` 文件 |
+
+
+ ## 生成构建产物
+
+
+以机器可读的输出格式运行你的文档工具。如果你已经在 CI 中发布生成的文档，通常只需在同一条命令上加一个参数即可。
+
+
+
+```bash TypeDoc
+npx typedoc --json typedoc.json src/index.ts
+```
+
+```bash DocFX
+docfx metadata docfx.json
+```
+
+```bash Javadoc
+javadoc -d javadoc-output -sourcepath src/main/java -subpackages com.example
+# Or download the published javadoc jar from Maven Central
+```
+
+```bash Sphinx
+python -m sphinx -b json docs/source artifacts/json
+```
+
+```bash phpDocumentor
+phpdoc -d src -t artifacts --template=xml
+```
+
+
+
+
+ ## 自动填充 SDK 页面
+
+
+在 `docs.json` 中的某个 tab 上添加 `sdk` 属性。Mintlify 会解析该构建产物，并为该库创建导航分组和页面。
+
+```json
+"navigation": {
+ "tabs": [
+ {
+ "tab": "SDK Reference",
+ "sdk": {
+ "format": "typedoc",
+ "source": "sdk-artifacts/typedoc.json",
+ "directory": "sdk/typescript"
+ }
+ }
+ ]
+}
+```
+
+
+ 生成构建产物的文档工具：`typedoc`、`docfx`、`javadoc`、`sphinx` 或 `phpdoc`。
+
+
+
+ 指向文档仓库中构建产物文件或目录的相对路径，或者一个 HTTPS URL。
+
+
+
+ 生成页面的 URL 路径前缀。默认值为 `sdk-reference`。
+
+
+添加多个 tab 即可为多个库生成文档。每个 tab 都需要一个唯一的 `directory`。
+
+
+ 将你的构建产物目录添加到 [`.mintignore`](/zh/organize/mintignore)，让 Mintlify 将这些产物视为构建输入，而不是作为静态资源发布。
+
+
+
+ ## 使用远程源
+
+
+将 `source` 设置为 HTTPS URL，即可在构建时获取构建产物，而无需将其提交到文档仓库中。
+
+单文件格式 (`typedoc`、`phpdoc`) 可直接接受文件 URL。目录格式 (`docfx`、`javadoc`、`sphinx`) 接受 zip 压缩包。发布到 Maven Central 的 Javadoc jar 无需重新打包即可使用：
+
+```json
+{
+ "tab": "Java SDK",
+ "sdk": {
+ "format": "javadoc",
+ "source": "https://repo1.maven.org/maven2/com/example/my-library/1.0.0/my-library-1.0.0-javadoc.jar",
+ "directory": "sdk/java"
+ }
+}
+```
+
+远程构建产物的下载大小上限为 50 MB，解压后大小上限为 200 MB。
+
+
+ ## 保持参考文档最新
+
+
+在你的 SDK 发生变化时，重新生成构建产物。常见做法是在每个 SDK 仓库中设置一个 CI 任务，在发布时运行文档工具，并将构建产物提交到文档仓库，或上传到 `source` 所指向的稳定 URL。
diff --git a/zh/organize/navigation.mdx b/zh/organize/navigation.mdx
index 7774676c8a..ed9af22a7c 100644
--- a/zh/organize/navigation.mdx
+++ b/zh/organize/navigation.mdx
@@ -571,6 +571,33 @@ boost: 3
```
+
+ ## SDK 参考
+
+
+基于文档工具的构建产物生成 SDK 参考页面。在某个 tab 上添加 `sdk` 属性，包括构建产物的 `format` (`typedoc`、`docfx`、`javadoc`、`sphinx` 或 `phpdoc`)、`source` 路径或 HTTPS URL，以及可选的 `directory`，用作生成页面的 URL 前缀。
+
+Mintlify 会解析构建产物，为库中的每个 class、interface、module 和 function 生成导航分组与页面。
+
+有关生成构建产物和配置源的更多信息，请参阅 [SDK 参考设置](/zh/api-playground/sdk-reference-setup)。
+
+```json
+{
+ "navigation": {
+ "tabs": [
+ {
+ "tab": "TypeScript SDK",
+ "sdk": {
+ "format": "typedoc",
+ "source": "sdk-artifacts/typedoc.json",
+ "directory": "sdk/typescript"
+ }
+ }
+ ]
+ }
+}
+```
+
## 版本