diff --git a/es/api-playground/sdk-reference-setup.mdx b/es/api-playground/sdk-reference-setup.mdx index c43b2f9ed..4dae9e05f 100644 --- a/es/api-playground/sdk-reference-setup.mdx +++ b/es/api-playground/sdk-reference-setup.mdx @@ -70,24 +70,36 @@ Agrega una propiedad `sdk` a una pestaña en tu `docs.json`. Mintlify analiza el } ``` - + + Debes declarar `sdk` en una [pestaña](/es/organize/navigation#tabs). Una pestaña con `sdk` puede incluir `groups`, pero no otras estructuras de navegación, como `pages`, `versions` o `languages`. Tampoco puede incluir una propiedad `openapi`, `asyncapi` o `graphql`. + + + 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. - + + Ruta relativa al archivo o directorio del artefacto en tu repositorio de documentación, o una URL HTTPS. No admite URLs HTTP. + - + 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 varias pestañas para documentar varias bibliotecas. Usa un `directory` único para cada biblioteca para evitar colisiones de rutas. 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. +
+ ## Páginas generadas +
+ +Mintlify agrega los grupos de navegación generados después de cualquier `groups` en la pestaña. Los grupos varían según el formato y pueden representar módulos, paquetes, espacios de nombres o tipos de símbolos. + +Cada página generada documenta una clase, interfaz, función, tipo u otro símbolo del artefacto y enlaza con las páginas generadas relacionadas. Si un convertidor produce páginas que no pertenecen a ningún grupo, Mintlify las recopila en un grupo `Reference`. +
## Usar fuentes remotas
diff --git a/fr/api-playground/sdk-reference-setup.mdx b/fr/api-playground/sdk-reference-setup.mdx index adaf5d5ef..9bb65681c 100644 --- a/fr/api-playground/sdk-reference-setup.mdx +++ b/fr/api-playground/sdk-reference-setup.mdx @@ -70,24 +70,36 @@ Ajoutez une propriété `sdk` à un onglet dans votre `docs.json`. Mintlify anal } ``` - + + Vous devez déclarer `sdk` sur un [onglet](/fr/organize/navigation#tabs). Un onglet avec `sdk` peut inclure `groups`, mais aucune autre structure de navigation, telle que `pages`, `versions` ou `languages`. Il ne peut pas non plus inclure une propriété `openapi`, `asyncapi` ou `graphql`. + + + 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. - + + Chemin relatif vers le fichier ou le répertoire de l’artefact dans votre dépôt de documentation, ou une URL HTTPS. N’accepte pas les URL HTTP. + - + 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 plusieurs onglets pour documenter plusieurs bibliothèques. Utilisez un `directory` unique pour chaque bibliothèque afin d’éviter les collisions de routes. 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. +
+ ## Pages générées +
+ +Mintlify ajoute les groupes de navigation générés après les éventuels `groups` de l’onglet. Les groupes varient selon le format et peuvent représenter des modules, des packages, des espaces de noms ou des types de symboles. + +Chaque page générée documente une classe, une interface, une fonction, un type ou un autre symbole de l’artefact et renvoie vers les pages générées associées. Si un convertisseur produit des pages qui n’appartiennent à aucun groupe, Mintlify les regroupe sous un groupe `Reference`. +
## Utiliser des sources distantes
diff --git a/zh/api-playground/sdk-reference-setup.mdx b/zh/api-playground/sdk-reference-setup.mdx index 7d512a25b..726032a76 100644 --- a/zh/api-playground/sdk-reference-setup.mdx +++ b/zh/api-playground/sdk-reference-setup.mdx @@ -70,24 +70,36 @@ phpdoc -d src -t artifacts --template=xml } ``` - + + 你必须在 [tab](/zh/organize/navigation#tabs) 上声明 `sdk`。包含 `sdk` 的 tab 可以包含 `groups`，但不能包含其他导航结构，例如 `pages`、`versions` 或 `languages`。它也不能包含 `openapi`、`asyncapi` 或 `graphql` 属性。 + + + 生成构建产物的文档工具：`typedoc`、`docfx`、`javadoc`、`sphinx` 或 `phpdoc`。 - + - - 指向文档仓库中构建产物文件或目录的相对路径，或者一个 HTTPS URL。 - + + 指向文档仓库中构建产物文件或目录的相对路径，或者一个 HTTPS URL。不接受 HTTP URL。 + - + 生成页面的 URL 路径前缀。默认值为 `sdk-reference`。 - + -添加多个 tab 即可为多个库生成文档。每个 tab 都需要一个唯一的 `directory`。 +添加多个 tab 即可为多个库生成文档。为每个库使用唯一的 `directory`，以避免路由冲突。 将你的构建产物目录添加到 [`.mintignore`](/zh/organize/mintignore)，让 Mintlify 将这些产物视为构建输入，而不是作为静态资源发布。 +
+ ## 生成的页面 +
+ +Mintlify 会将生成的导航组添加到 tab 上任何 `groups` 之后。这些组因格式而异，可能表示模块、包、命名空间或符号类型。 + +每个生成的页面都记录了构建产物中的一个类、接口、函数、类型或其他符号，并链接到相关的生成页面。如果转换器生成的页面不属于任何组，Mintlify 会将它们归入 `Reference` 组。 +
## 使用远程源