From 747fe5442ded46a076bd6df683e600c1c96fa4d7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 00:30:00 +0000 Subject: [PATCH 1/2] Document collaborative editing for supporting text files Generated-By: mintlify-agent --- editor/pages.mdx | 17 ++++++++++++++++- es/editor/pages.mdx | 17 +++++++++++++++++ fr/editor/pages.mdx | 17 +++++++++++++++++ zh/editor/pages.mdx | 17 +++++++++++++++++ 4 files changed, 67 insertions(+), 1 deletion(-) diff --git a/editor/pages.mdx b/editor/pages.mdx index 4bb67a373..86a0eb31a 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -12,6 +12,21 @@ Browse pages in the **Navigation** tab of the left panel. Click a page to open i The web editor treats API specification files (OpenAPI and AsyncAPI) as read-only. To update a spec file, edit it in your preferred code editor and push the changes to your documentation repository. +## Edit supporting text files + +In addition to MDX and Markdown pages, the web editor opens common text files for live, collaborative editing. Click any of the following file types in the navigation tree to edit them with the same real-time syncing, autosave, and Git integration as your documentation pages: + +- `.yml` and `.yaml` +- `.json` +- `.js` and `.jsx` +- `.css` +- `.txt` +- `.csv` + +Text files open in a source-mode editor with syntax highlighting and search (Cmd + F on macOS, Ctrl + F on Windows). Edits sync live across collaborators—each person's cursor is visible, and changes published from outside the editor merge automatically. If a file is edited concurrently in Git and the editor in a way that can't be merged, the editor surfaces conflict markers labeled `editor` and `incoming` so you can resolve them before publishing. + +Files with extensions outside this list (for example, fonts, archives, and binary assets) remain read-only. Edit those in your local code editor and push the changes to your repository. + ## Create new pages 1. Click the plus button in the navigation element where you want to add a page. @@ -38,7 +53,7 @@ Switch between visual and Markdown mode with the toggle in the toolbar. **Markdown mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter. - The web editor treats API specification files (OpenAPI and AsyncAPI) as read-only. Edit them in your code editor and push the changes to your repository. + The web editor treats API specification files (OpenAPI and AsyncAPI) as read-only. Edit them in your code editor and push the changes to your repository. For the list of supporting files you can edit directly in the web editor, see [Edit supporting text files](#edit-supporting-text-files). For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code). diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index e9ac8bdb2..09a508dc0 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -37,6 +37,23 @@ Cambia entre el modo visual y Markdown mode mediante el conmutador en la barra d Los archivos de especificación de API (OpenAPI y AsyncAPI) son de solo lectura en el editor web. Puedes ver su contenido, pero no puedes editarlos directamente. Para actualizar un archivo de especificación, edítalo con tu editor de código preferido y envía los cambios a tu repositorio de documentación. +
+ ## Editar archivos de texto auxiliares +
+ +Además de las páginas MDX y Markdown, el editor web abre archivos de texto comunes para edición colaborativa en tiempo real. Haz clic en cualquiera de los siguientes tipos de archivo en el árbol de navegación para editarlos con la misma sincronización en tiempo real, guardado automático e integración con Git que tus páginas de documentación: + +- `.yml` y `.yaml` +- `.json` +- `.js` y `.jsx` +- `.css` +- `.txt` +- `.csv` + +Los archivos de texto se abren en un editor en modo fuente con resaltado de sintaxis y búsqueda (Cmd + F en macOS, Ctrl + F en Windows). Los cambios se sincronizan en vivo entre colaboradores: el cursor de cada persona es visible y las modificaciones publicadas fuera del editor se fusionan automáticamente. Si un archivo se edita simultáneamente en Git y en el editor de una forma que no se puede fusionar, el editor muestra marcadores de conflicto etiquetados como `editor` e `incoming` para que puedas resolverlos antes de publicar. + +Los archivos con extensiones fuera de esta lista (por ejemplo, fuentes, archivos comprimidos y otros recursos binarios) permanecen como de solo lectura. Edítalos en tu editor de código local y envía los cambios a tu repositorio. + Conmutador de modo en la barra de herramientas. diff --git a/fr/editor/pages.mdx b/fr/editor/pages.mdx index 942ad85ae..9a955050d 100644 --- a/fr/editor/pages.mdx +++ b/fr/editor/pages.mdx @@ -37,6 +37,23 @@ Basculez entre le mode visuel et le Markdown mode à l'aide du bouton de bascule Les fichiers de spécification d'API (OpenAPI et AsyncAPI) sont en lecture seule dans l'éditeur web. Vous pouvez consulter leur contenu, mais vous ne pouvez pas les modifier directement. Pour mettre à jour un fichier de spécification, modifiez-le avec votre éditeur de code préféré et poussez les modifications vers votre dépôt de documentation. +
+ ## Modifier les fichiers texte auxiliaires +
+ +En plus des pages MDX et Markdown, l'éditeur web ouvre les fichiers texte courants pour une édition collaborative en temps réel. Cliquez sur l'un des types de fichiers suivants dans l'arborescence de navigation pour les modifier avec la même synchronisation en temps réel, l'enregistrement automatique et l'intégration Git que vos pages de documentation : + +- `.yml` et `.yaml` +- `.json` +- `.js` et `.jsx` +- `.css` +- `.txt` +- `.csv` + +Les fichiers texte s'ouvrent dans un éditeur en mode source avec coloration syntaxique et recherche (Cmd + F sur macOS, Ctrl + F sous Windows). Les modifications se synchronisent en direct entre collaborateurs : le curseur de chaque personne est visible et les changements publiés en dehors de l'éditeur fusionnent automatiquement. Si un fichier est modifié simultanément dans Git et dans l'éditeur d'une manière qui ne peut pas être fusionnée, l'éditeur affiche des marqueurs de conflit étiquetés `editor` et `incoming` afin que vous puissiez les résoudre avant la publication. + +Les fichiers dont l'extension ne figure pas dans cette liste (par exemple les polices, les archives et autres ressources binaires) restent en lecture seule. Modifiez-les dans votre éditeur de code local, puis poussez les changements vers votre dépôt. + Bouton de bascule de mode dans la barre d'outils. diff --git a/zh/editor/pages.mdx b/zh/editor/pages.mdx index b2e14be9f..896258ec0 100644 --- a/zh/editor/pages.mdx +++ b/zh/editor/pages.mdx @@ -37,6 +37,23 @@ keywords: ["编辑器","内容","页面","文件"] API 规范文件（OpenAPI 和 AsyncAPI）在 Web 编辑器中为只读。你可以查看其内容，但无法直接编辑。要更新规范文件，请使用你偏好的代码编辑器进行编辑，然后将更改推送到你的文档仓库。 +
+ ## 编辑辅助文本文件 +
+ +除了 MDX 和 Markdown 页面外，Web 编辑器还可以打开常见文本文件进行实时协作编辑。在导航树中点击以下任一类型的文件，可使用与文档页面相同的实时同步、自动保存和 Git 集成方式进行编辑： + +- `.yml` 和 `.yaml` +- `.json` +- `.js` 和 `.jsx` +- `.css` +- `.txt` +- `.csv` + +文本文件会在带有语法高亮和搜索功能的源代码模式编辑器中打开（macOS 上使用 Cmd + F，Windows 上使用 Ctrl + F）。更改会在协作者之间实时同步：每个人的光标都可见，从编辑器外部发布的更改会自动合并。如果某个文件在 Git 和编辑器中被同时修改且无法自动合并，编辑器会显示标记为 `editor` 和 `incoming` 的冲突标记，方便你在发布前解决冲突。 + +扩展名不在此列表中的文件（例如字体、压缩包和其他二进制资源）仍为只读。请在本地代码编辑器中修改这些文件，然后将更改推送到你的仓库。 + 工具栏中的模式切换开关。 From 644957aab5ff58b9e3f6e53fb8d84c66d7b9d3e0 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 14 May 2026 00:33:24 +0000 Subject: [PATCH 2/2] Shorten long sentence and improve translated descriptions Generated-By: mintlify-agent --- editor/pages.mdx | 4 +++- es/editor/pages.mdx | 8 +++++--- fr/editor/pages.mdx | 8 +++++--- zh/editor/pages.mdx | 8 +++++--- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/editor/pages.mdx b/editor/pages.mdx index 86a0eb31a..857a1ef78 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -23,7 +23,9 @@ In addition to MDX and Markdown pages, the web editor opens common text files fo - `.txt` - `.csv` -Text files open in a source-mode editor with syntax highlighting and search (Cmd + F on macOS, Ctrl + F on Windows). Edits sync live across collaborators—each person's cursor is visible, and changes published from outside the editor merge automatically. If a file is edited concurrently in Git and the editor in a way that can't be merged, the editor surfaces conflict markers labeled `editor` and `incoming` so you can resolve them before publishing. +Text files open in a source-mode editor with syntax highlighting and search (Cmd + F on macOS, Ctrl + F on Windows). Edits sync live across collaborators—each person's cursor is visible, and changes published from outside the editor merge automatically. + +When concurrent edits in Git and the editor can't merge cleanly, the editor inserts conflict markers labeled `editor` and `incoming`. Resolve the markers before publishing. Files with extensions outside this list (for example, fonts, archives, and binary assets) remain read-only. Edit those in your local code editor and push the changes to your repository. diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index 09a508dc0..8c01fe2fe 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -1,7 +1,7 @@ --- title: "Crear y editar páginas" -description: "Crea, edita y organiza páginas de documentación en el editor web." -keywords: ["editor","contenido","páginas","archivos"] +description: "Crea páginas, edita contenido, sube imágenes y vídeos, y gestiona archivos en el editor web de Mintlify con edición enriquecida y búsqueda." +keywords: ["editor","contenido","páginas","archivos","crear","editar","medios","imágenes","vídeo"] ---