Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions cli/mdx-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The extension reports problems in the Problems panel and underlines them in your
- Unknown or duplicate properties.
- Invalid values for enumerated properties.
- Missing required properties.
- Unclosed or mismatched tags.
- Unclosed or mismatched tags, including plain HTML elements like `<div>`.
- Unresolved snippet imports.

These classes of error cause build failures, so fix them as you write to avoid failed deployments.
Expand All @@ -67,6 +67,16 @@ Hold <kbd>CMD</kbd> (macOS) or <kbd>CTRL</kbd> (Windows) and click to navigate t

The extension finds your docs root by walking up from the open file until it finds `docs.json`, so absolute imports like `/snippets/example.mdx` resolve correctly. The detected project appears in the status bar. To check which root the extension is using, run **Mintlify: Show detected docs root** from the command palette.

## Folding

Use the gutter chevrons to collapse regions of a page:

- Component and HTML tag regions, like `<Accordion>…</Accordion>`.
- Heading sections.
- Frontmatter.
- Code blocks.
- JSX comments.

## Configuration validation

The extension validates `docs.json` against the [Mintlify schema](https://mintlify.com/docs.json).
Expand All @@ -75,7 +85,13 @@ The extension validates `docs.json` against the [Mintlify schema](https://mintli

Open an `.mdx` file and select the preview icon in the editor title bar, or right-click the file and select **Preview Mintlify**. A preview panel opens beside your editor and renders the page.

In-editor previews require the [Mintlify CLI](/cli/install). The URL of the running server appears in the status bar. Select it to stop the server, or run **Mintlify: Stop preview server**.
The preview toolbar has back, forward, and reload buttons, an address box, and a **Follow editor** toggle. Type a path like `/quickstart` in the address box and press <kbd>Enter</kbd> to navigate to that page. With **Follow editor** on, the preview switches pages as you change files in your editor.

The in-editor preview renders in an iframe, so browser find and dev tools can't reach it. Select the **Open in browser** button in the preview toolbar, or run **Mintlify: Open preview in browser**, to open the page in your browser instead.

In-editor previews require the [Mintlify CLI](/cli/install). The preview server runs on port `3939` by default so it doesn't collide with apps on port 3000. Change the port with the `mintlify.preview.port` setting.

The URL of the running server appears in the status bar. Select it to stop the server, or run **Mintlify: Stop preview server**.

To see the output of the underlying `mint dev` process, open the **Mintlify Preview** output channel.

Expand All @@ -96,7 +112,8 @@ To use them, select the content you want to wrap, then run **Snippets: Surround
| `mintlify.diagnostics.enabled` | `true` | Report unknown components, unknown properties, missing required properties, and unresolved snippet imports. |
| `mintlify.warnAboutConflictingExtensions` | `true` | Warn when you have another MDX extension installed alongside the Mintlify MDX extension. |
| `mintlify.preview.command` | `mint dev --no-open` | Command used to start the preview server, run from your project root. |
| `mintlify.preview.followScroll` | `true` | Scroll the preview to the heading nearest the top of your editor. |
| `mintlify.preview.followEditor` | `true` | Switch the preview to the page of the active editor when you change files. Also toggled from the preview toolbar. |
| `mintlify.preview.port` | `3939` | Port for the preview server. Appended to the preview command as `--port` unless that command already sets one. |

`mintlify.preview.command` is a user setting, so a workspace cannot override it. This prevents a cloned repository from running an arbitrary command on your machine when you open a preview.

Expand All @@ -108,6 +125,7 @@ Run these from the command palette:
| --- | --- |
| **Mintlify: Preview Mintlify** | Open the preview panel for the current file. |
| **Mintlify: Stop preview server** | Stop the running preview server. |
| **Mintlify: Open preview in browser** | Open the previewed page in your browser. |
| **Mintlify: Show detected docs root** | Show which `docs.json` file the extension resolved. |
| **Mintlify: Open component docs** | Open the documentation for the component at your cursor. |
| **Mintlify: Restart language server** | Restart the language server. |
Expand Down
26 changes: 23 additions & 3 deletions es/cli/mdx-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ La extensión reporta problemas en el panel de Problemas y los subraya en tu arc
- Propiedades desconocidas o duplicadas.
- Valores inválidos para propiedades enumeradas.
- Propiedades requeridas faltantes.
- Etiquetas sin cerrar o mal emparejadas.
- Etiquetas sin cerrar o mal emparejadas, incluidos elementos HTML simples como `<div>`.
- Importaciones de snippets sin resolver.

Estas clases de errores causan fallos de compilación, así que corrígelos mientras escribes para evitar despliegues fallidos.
Expand All @@ -79,6 +79,18 @@ Mantén presionado <kbd>CMD</kbd> (macOS) o <kbd>CTRL</kbd> (Windows) y haz clic

La extensión encuentra la raíz de tu documentación subiendo desde el archivo abierto hasta encontrar `docs.json`, por lo que las importaciones absolutas como `/snippets/example.mdx` se resuelven correctamente. El proyecto detectado aparece en la barra de estado. Para comprobar qué raíz está usando la extensión, ejecuta **Mintlify: Show detected docs root** desde la paleta de comandos.

<div id="folding">
## Plegado
</div>

Usa los chevrones del margen para plegar regiones de una página:

- Regiones de etiquetas de componentes y HTML, como `<Accordion>…</Accordion>`.
- Secciones de encabezados.
- Frontmatter.
- Bloques de código.
- Comentarios JSX.

<div id="configuration-validation">
## Validación de configuración
</div>
Expand All @@ -91,7 +103,13 @@ La extensión valida `docs.json` contra el [esquema de Mintlify](https://mintlif

Abre un archivo `.mdx` y selecciona el icono de previsualización en la barra de título del editor, o haz clic derecho en el archivo y selecciona **Preview Mintlify**. Un panel de previsualización se abre junto a tu editor y renderiza la página.

Las previsualizaciones en el editor requieren la [CLI de Mintlify](/es/cli/install). La URL del servidor en ejecución aparece en la barra de estado. Selecciónala para detener el servidor, o ejecuta **Mintlify: Stop preview server**.
La barra de herramientas de la previsualización tiene botones de atrás, adelante y recargar, un cuadro de dirección y un interruptor **Follow editor**. Escribe una ruta como `/quickstart` en el cuadro de dirección y presiona <kbd>Enter</kbd> para navegar a esa página. Con **Follow editor** activado, la previsualización cambia de página a medida que cambias de archivo en tu editor.

La previsualización en el editor se renderiza en un iframe, por lo que la búsqueda del navegador y las herramientas de desarrollo no pueden acceder a ella. Selecciona el botón **Open in browser** en la barra de herramientas de la previsualización, o ejecuta **Mintlify: Open preview in browser**, para abrir la página en tu navegador.

Las previsualizaciones en el editor requieren la [CLI de Mintlify](/es/cli/install). El servidor de previsualización se ejecuta en el puerto `3939` de forma predeterminada para no entrar en conflicto con aplicaciones en el puerto 3000. Cambia el puerto con la configuración `mintlify.preview.port`.

La URL del servidor en ejecución aparece en la barra de estado. Selecciónala para detener el servidor, o ejecuta **Mintlify: Stop preview server**.

Para ver la salida del proceso `mint dev` subyacente, abre el canal de salida **Mintlify Preview**.

Expand All @@ -116,7 +134,8 @@ Para usarlos, selecciona el contenido que quieres envolver, luego ejecuta **Snip
| `mintlify.diagnostics.enabled` | `true` | Reporta componentes desconocidos, propiedades desconocidas, propiedades requeridas faltantes e importaciones de snippets sin resolver. |
| `mintlify.warnAboutConflictingExtensions` | `true` | Advierte cuando tienes otra extensión MDX instalada junto a la extensión Mintlify MDX. |
| `mintlify.preview.command` | `mint dev --no-open` | Comando usado para iniciar el servidor de previsualización, ejecutado desde la raíz de tu proyecto. |
| `mintlify.preview.followScroll` | `true` | Desplaza la previsualización hasta el encabezado más cercano a la parte superior de tu editor. |
| `mintlify.preview.followEditor` | `true` | Cambia la previsualización a la página del editor activo cuando cambias de archivo. También se puede alternar desde la barra de herramientas de la previsualización. |
| `mintlify.preview.port` | `3939` | Puerto del servidor de previsualización. Se agrega al comando de previsualización como `--port` a menos que ese comando ya establezca uno. |

`mintlify.preview.command` es una configuración de usuario, por lo que un espacio de trabajo no puede sobrescribirla. Esto evita que un repositorio clonado ejecute un comando arbitrario en tu máquina cuando abres una previsualización.

Expand All @@ -130,6 +149,7 @@ Ejecútalos desde la paleta de comandos:
| --- | --- |
| **Mintlify: Preview Mintlify** | Abre el panel de previsualización para el archivo actual. |
| **Mintlify: Stop preview server** | Detiene el servidor de previsualización en ejecución. |
| **Mintlify: Open preview in browser** | Abre la página previsualizada en tu navegador. |
| **Mintlify: Show detected docs root** | Muestra qué archivo `docs.json` resolvió la extensión. |
| **Mintlify: Open component docs** | Abre la documentación del componente en tu cursor. |
| **Mintlify: Restart language server** | Reinicia el servidor de lenguaje. |
Expand Down
26 changes: 23 additions & 3 deletions fr/cli/mdx-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ L'extension signale les problèmes dans le panneau Problèmes et les souligne da
- Propriétés inconnues ou en double.
- Valeurs invalides pour les propriétés énumérées.
- Propriétés requises manquantes.
- Balises non fermées ou mal appariées.
- Balises non fermées ou mal appariées, y compris les éléments HTML simples comme `<div>`.
- Imports de snippets non résolus.

Ces classes d'erreurs provoquent des échecs de build, corrigez-les donc au fil de la rédaction pour éviter des déploiements en échec.
Expand All @@ -79,6 +79,18 @@ Maintenez <kbd>CMD</kbd> (macOS) ou <kbd>CTRL</kbd> (Windows) et cliquez pour ac

L'extension trouve la racine de votre documentation en remontant depuis le fichier ouvert jusqu'à trouver `docs.json`, de sorte que les imports absolus comme `/snippets/example.mdx` se résolvent correctement. Le projet détecté apparaît dans la barre d'état. Pour vérifier quelle racine l'extension utilise, exécutez **Mintlify: Show detected docs root** depuis la palette de commandes.

<div id="folding">
## Repli de code
</div>

Utilisez les chevrons de la gouttière pour replier des régions d'une page :

- Les régions de balises de composants et HTML, comme `<Accordion>…</Accordion>`.
- Les sections de titres.
- Le frontmatter.
- Les blocs de code.
- Les commentaires JSX.

<div id="configuration-validation">
## Validation de la configuration
</div>
Expand All @@ -91,7 +103,13 @@ L'extension valide `docs.json` par rapport au [schéma Mintlify](https://mintlif

Ouvrez un fichier `.mdx` et sélectionnez l'icône de prévisualisation dans la barre de titre de l'éditeur, ou faites un clic droit sur le fichier et sélectionnez **Preview Mintlify**. Un panneau de prévisualisation s'ouvre à côté de votre éditeur et affiche le rendu de la page.

Les prévisualisations dans l'éditeur nécessitent la [CLI Mintlify](/fr/cli/install). L'URL du serveur en cours d'exécution apparaît dans la barre d'état. Sélectionnez-la pour arrêter le serveur, ou exécutez **Mintlify: Stop preview server**.
La barre d'outils de la prévisualisation comporte des boutons précédent, suivant et recharger, une zone d'adresse et un bouton bascule **Follow editor**. Saisissez un chemin comme `/quickstart` dans la zone d'adresse et appuyez sur <kbd>Entrée</kbd> pour accéder à cette page. Avec **Follow editor** activé, la prévisualisation change de page à mesure que vous changez de fichier dans votre éditeur.

La prévisualisation dans l'éditeur s'affiche dans une iframe, donc la recherche du navigateur et les outils de développement ne peuvent pas y accéder. Sélectionnez le bouton **Open in browser** dans la barre d'outils de la prévisualisation, ou exécutez **Mintlify: Open preview in browser**, pour ouvrir la page dans votre navigateur.

Les prévisualisations dans l'éditeur nécessitent la [CLI Mintlify](/fr/cli/install). Le serveur de prévisualisation s'exécute par défaut sur le port `3939` afin de ne pas entrer en conflit avec des applications sur le port 3000. Modifiez le port avec le paramètre `mintlify.preview.port`.

L'URL du serveur en cours d'exécution apparaît dans la barre d'état. Sélectionnez-la pour arrêter le serveur, ou exécutez **Mintlify: Stop preview server**.

Pour voir la sortie du processus `mint dev` sous-jacent, ouvrez le canal de sortie **Mintlify Preview**.

Expand All @@ -116,7 +134,8 @@ Pour les utiliser, sélectionnez le contenu à encadrer, puis exécutez **Snippe
| `mintlify.diagnostics.enabled` | `true` | Signale les composants inconnus, les propriétés inconnues, les propriétés requises manquantes et les imports de snippets non résolus. |
| `mintlify.warnAboutConflictingExtensions` | `true` | Avertit lorsqu'une autre extension MDX est installée aux côtés de l'extension Mintlify MDX. |
| `mintlify.preview.command` | `mint dev --no-open` | Commande utilisée pour démarrer le serveur de prévisualisation, exécutée depuis la racine de votre projet. |
| `mintlify.preview.followScroll` | `true` | Fait défiler la prévisualisation jusqu'au titre le plus proche du haut de votre éditeur. |
| `mintlify.preview.followEditor` | `true` | Bascule la prévisualisation vers la page de l'éditeur actif lorsque vous changez de fichier. Également activable depuis la barre d'outils de la prévisualisation. |
| `mintlify.preview.port` | `3939` | Port du serveur de prévisualisation. Ajouté à la commande de prévisualisation via `--port`, sauf si cette commande en définit déjà un. |

`mintlify.preview.command` est un paramètre utilisateur, un espace de travail ne peut donc pas le remplacer. Cela empêche un dépôt cloné d'exécuter une commande arbitraire sur votre machine lorsque vous ouvrez une prévisualisation.

Expand All @@ -130,6 +149,7 @@ Exécutez-les depuis la palette de commandes :
| --- | --- |
| **Mintlify: Preview Mintlify** | Ouvre le panneau de prévisualisation pour le fichier actuel. |
| **Mintlify: Stop preview server** | Arrête le serveur de prévisualisation en cours d'exécution. |
| **Mintlify: Open preview in browser** | Ouvre la page prévisualisée dans votre navigateur. |
| **Mintlify: Show detected docs root** | Affiche le fichier `docs.json` que l'extension a résolu. |
| **Mintlify: Open component docs** | Ouvre la documentation du composant sous votre curseur. |
| **Mintlify: Restart language server** | Redémarre le serveur de langage. |
Expand Down
26 changes: 23 additions & 3 deletions zh/cli/mdx-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ code --install-extension mintlify.mintlify-snippets
- 未知或重复的属性。
- 枚举属性的无效值。
- 缺少必需属性。
- 未闭合或不匹配的标签。
- 未闭合或不匹配的标签,包括像 `<div>` 这样的普通 HTML 元素
- 无法解析的 snippet 导入。

这些类型的错误会导致构建失败,因此请在编写时及时修复,以避免部署失败。
Expand All @@ -79,6 +79,18 @@ code --install-extension mintlify.mintlify-snippets

扩展会从打开的文件向上查找,直到找到 `docs.json`,以此确定文档根目录,因此像 `/snippets/example.mdx` 这样的绝对导入可以正确解析。检测到的项目会显示在状态栏中。要查看扩展正在使用哪个根目录,请在命令面板中运行 **Mintlify: Show detected docs root**。

<div id="folding">
## 折叠
</div>

使用行号侧边的折叠箭头来折叠页面中的区域:

- 组件和 HTML 标签区域,例如 `<Accordion>…</Accordion>`。
- 标题小节。
- Frontmatter。
- 代码块。
- JSX 注释。

<div id="configuration-validation">
## 配置校验
</div>
Expand All @@ -91,7 +103,13 @@ code --install-extension mintlify.mintlify-snippets

打开一个 `.mdx` 文件,选择编辑器标题栏中的预览图标,或右键点击文件并选择 **Preview Mintlify**。预览面板会在编辑器旁打开并渲染页面。

编辑器内预览需要 [Mintlify CLI](/zh/cli/install)。运行中服务器的 URL 会显示在状态栏中。选择它可以停止服务器,或运行 **Mintlify: Stop preview server**。
预览工具栏包含后退、前进和重新加载按钮、地址框,以及 **Follow editor** 开关。在地址框中输入类似 `/quickstart` 的路径并按 <kbd>Enter</kbd> 即可跳转到该页面。开启 **Follow editor** 后,预览会随着你在编辑器中切换文件而切换页面。

编辑器内预览在 iframe 中渲染,因此浏览器的查找功能和开发者工具无法访问它。选择预览工具栏中的 **Open in browser** 按钮,或运行 **Mintlify: Open preview in browser**,改为在浏览器中打开页面。

编辑器内预览需要 [Mintlify CLI](/zh/cli/install)。预览服务器默认在端口 `3939` 上运行,以避免与端口 3000 上的应用冲突。可通过 `mintlify.preview.port` 设置更改端口。

运行中服务器的 URL 会显示在状态栏中。选择它可以停止服务器,或运行 **Mintlify: Stop preview server**。

要查看底层 `mint dev` 进程的输出,请打开 **Mintlify Preview** 输出通道。

Expand All @@ -116,7 +134,8 @@ code --install-extension mintlify.mintlify-snippets
| `mintlify.diagnostics.enabled` | `true` | 报告未知组件、未知属性、缺少的必需属性和无法解析的 snippet 导入。 |
| `mintlify.warnAboutConflictingExtensions` | `true` | 当你在 Mintlify MDX 扩展之外还安装了其他 MDX 扩展时发出警告。 |
| `mintlify.preview.command` | `mint dev --no-open` | 用于启动预览服务器的命令,从项目根目录运行。 |
| `mintlify.preview.followScroll` | `true` | 将预览滚动到最接近编辑器顶部的标题处。 |
| `mintlify.preview.followEditor` | `true` | 当你切换文件时,将预览切换到当前活动编辑器对应的页面。也可以从预览工具栏切换。 |
| `mintlify.preview.port` | `3939` | 预览服务器的端口。除非预览命令已设置端口,否则会以 `--port` 形式附加到该命令。 |

`mintlify.preview.command` 是用户级设置,工作区无法覆盖它。这可以防止克隆的仓库在你打开预览时在你的机器上运行任意命令。

Expand All @@ -130,6 +149,7 @@ code --install-extension mintlify.mintlify-snippets
| --- | --- |
| **Mintlify: Preview Mintlify** | 为当前文件打开预览面板。 |
| **Mintlify: Stop preview server** | 停止正在运行的预览服务器。 |
| **Mintlify: Open preview in browser** | 在浏览器中打开预览的页面。 |
| **Mintlify: Show detected docs root** | 显示扩展解析到的 `docs.json` 文件。 |
| **Mintlify: Open component docs** | 打开光标所在组件的文档。 |
| **Mintlify: Restart language server** | 重启语言服务器。 |
Expand Down