diff --git a/api-playground/asyncapi-setup.mdx b/api-playground/asyncapi-setup.mdx index 19fba239c..447164e97 100644 --- a/api-playground/asyncapi-setup.mdx +++ b/api-playground/asyncapi-setup.mdx @@ -98,7 +98,46 @@ To automatically generate pages for all channels in your AsyncAPI schema, add an The `directory` field is optional. If not specified, Mintlify adds the files to the **api-reference** folder of the docs repository. -## Channel page +## Customize channel pages + +### Custom MDX content + +Add custom MDX content below the frontmatter in your `asyncapi:` page to render it above the auto-generated channel documentation. This works the same way as [custom content for OpenAPI pages](/api-playground/openapi-setup#content). + +```mdx +--- +title: "Websocket Channel" +asyncapi: "/path/to/asyncapi.json channelName" +--- + +## Prerequisites + +You must authenticate before connecting to this channel. + +This channel requires a valid API key passed as a query parameter. +``` + +### x-mint extension + +You can add content to auto-generated channel pages directly in your AsyncAPI spec using the `x-mint` extension. Add `x-mint: content` to a channel to include MDX content above the channel documentation without creating a separate MDX file. + +```yaml {6-8} +channels: + userEvents: + address: /events/users + description: Real-time user events + x-mint: + content: | + ## Overview + Subscribe to this channel to receive real-time user activity events. + messages: + userEvent: + $ref: '#/components/messages/UserEvent' +``` + +The `x-mint: content` extension supports all Mintlify MDX components and formatting. + +### Channel page If you want more control over how you order your channels or if you want to reference only specific channels, create an MDX file with the `asyncapi` property in the frontmatter. diff --git a/es/api-playground/asyncapi-setup.mdx b/es/api-playground/asyncapi-setup.mdx index 9454bbfd6..2ac98408a 100644 --- a/es/api-playground/asyncapi-setup.mdx +++ b/es/api-playground/asyncapi-setup.mdx @@ -110,9 +110,46 @@ Para generar automáticamente páginas para todos los canales de tu esquema Asyn -
- ## Página de canal -
+## Personalizar páginas de canales + +### Contenido MDX personalizado + +Agrega contenido MDX personalizado debajo del frontmatter en tu página `asyncapi:` para mostrarlo encima de la documentación de canal generada automáticamente. Esto funciona de la misma manera que el [contenido personalizado para páginas OpenAPI](/es/api-playground/openapi-setup#content). + +```mdx +--- +title: "Canal WebSocket" +asyncapi: "/path/to/asyncapi.json channelName" +--- + +## Requisitos previos + +Debes autenticarte antes de conectarte a este canal. + +Este canal requiere una clave de API válida pasada como parámetro de consulta. +``` + +### Extensión x-mint + +Puedes agregar contenido a las páginas de canal generadas automáticamente directamente en tu especificación AsyncAPI usando la extensión `x-mint`. Agrega `x-mint: content` a un canal para incluir contenido MDX encima de la documentación del canal sin crear un archivo MDX separado. + +```yaml {6-8} +channels: + userEvents: + address: /events/users + description: Eventos de usuario en tiempo real + x-mint: + content: | + ## Descripción general + Suscríbete a este canal para recibir eventos de actividad de usuario en tiempo real. + messages: + userEvent: + $ref: '#/components/messages/UserEvent' +``` + +La extensión `x-mint: content` es compatible con todos los componentes y el formato MDX de Mintlify. + +### Página de canal Si quieres tener más control sobre el orden de tus canales o necesitas referirte solo a canales específicos, crea un archivo MDX con la propiedad `asyncapi` en el frontmatter. diff --git a/fr/api-playground/asyncapi-setup.mdx b/fr/api-playground/asyncapi-setup.mdx index b9d520740..125793161 100644 --- a/fr/api-playground/asyncapi-setup.mdx +++ b/fr/api-playground/asyncapi-setup.mdx @@ -110,11 +110,48 @@ Pour générer automatiquement des pages pour tous les canaux de votre schéma A -
- ## Page de canal -
+## Personnaliser les pages de canaux + +### Contenu MDX personnalisé + +Ajoutez du contenu MDX personnalisé sous le frontmatter de votre page `asyncapi:` pour l'afficher au-dessus de la documentation de canal générée automatiquement. Cela fonctionne de la même manière que le [contenu personnalisé pour les pages OpenAPI](/fr/api-playground/openapi-setup#content). + +```mdx +--- +title: "Canal WebSocket" +asyncapi: "/path/to/asyncapi.json channelName" +--- + +## Prérequis + +Vous devez vous authentifier avant de vous connecter à ce canal. + +Ce canal nécessite une clé API valide passée en paramètre de requête. +``` + +### Extension x-mint + +Vous pouvez ajouter du contenu aux pages de canal générées automatiquement directement dans votre spécification AsyncAPI à l'aide de l'extension `x-mint`. Ajoutez `x-mint: content` à un canal pour inclure du contenu MDX au-dessus de la documentation du canal sans créer de fichier MDX séparé. + +```yaml {6-8} +channels: + userEvents: + address: /events/users + description: Événements utilisateur en temps réel + x-mint: + content: | + ## Aperçu + Abonnez-vous à ce canal pour recevoir les événements d'activité utilisateur en temps réel. + messages: + userEvent: + $ref: '#/components/messages/UserEvent' +``` + +L'extension `x-mint: content` est compatible avec tous les composants et le formatage MDX de Mintlify. + +### Page de canal -Si vous souhaitez mieux contrôler l’ordre de vos canaux ou ne référencer que certains canaux, créez un fichier MDX avec la propriété `asyncapi` dans le frontmatter. +Si vous souhaitez mieux contrôler l'ordre de vos canaux ou ne référencer que certains canaux, créez un fichier MDX avec la propriété `asyncapi` dans le frontmatter. ```mdx --- diff --git a/zh/api-playground/asyncapi-setup.mdx b/zh/api-playground/asyncapi-setup.mdx index ea31c2018..f1c39a84f 100644 --- a/zh/api-playground/asyncapi-setup.mdx +++ b/zh/api-playground/asyncapi-setup.mdx @@ -110,9 +110,46 @@ keywords: ["asyncapi", "websocket"] -
- ## 频道页面 -
+## 自定义频道页面 + +### 自定义 MDX 内容 + +在 `asyncapi:` 页面的 frontmatter 下方添加自定义 MDX 内容,使其显示在自动生成的频道文档上方。这与 [OpenAPI 页面的自定义内容](/zh/api-playground/openapi-setup#content)工作方式相同。 + +```mdx +--- +title: "WebSocket 频道" +asyncapi: "/path/to/asyncapi.json channelName" +--- + +## 前提条件 + +连接此频道前必须先进行身份验证。 + +此频道要求将有效的 API 密钥作为查询参数传递。 +``` + +### x-mint 扩展 + +你可以使用 `x-mint` 扩展直接在 AsyncAPI 规范中为自动生成的频道页面添加内容。在频道上添加 `x-mint: content`,无需创建单独的 MDX 文件即可在频道文档上方包含 MDX 内容。 + +```yaml {6-8} +channels: + userEvents: + address: /events/users + description: 实时用户事件 + x-mint: + content: | + ## 概述 + 订阅此频道以接收实时用户活动事件。 + messages: + userEvent: + $ref: '#/components/messages/UserEvent' +``` + +`x-mint: content` 扩展支持所有 Mintlify MDX 组件和格式。 + +### 频道页面 如果你需要更灵活地控制频道的排序,或只想引用特定频道,请创建一个在前言区(frontmatter)中包含 `asyncapi` 属性的 MDX 文件。