Skip to content
Open
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
19 changes: 18 additions & 1 deletion editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,23 @@
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.
</Note>

## 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:

Check warning on line 17 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L17

Did you really mean 'autosave'?

- `.yml` and `.yaml`
- `.json`
- `.js` and `.jsx`
- `.css`
- `.txt`
- `.csv`

Text files open in a source-mode editor with syntax highlighting and search (<kbd>Cmd</kbd> + <kbd>F</kbd> on macOS, <kbd>Ctrl</kbd> + <kbd>F</kbd> on Windows). Edits sync live across collaborators—each person's cursor is visible, and changes published from outside the editor merge automatically.

Check warning on line 26 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L26

Use 'Cursor' instead of 'cursor'.

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.

## Create new pages

1. Click the <Icon icon="plus" /> plus button in the navigation element where you want to add a page.
Expand All @@ -33,12 +50,12 @@
- **Link to another page**: Right-click a page in the navigation tree, click **Copy link**, then paste the link into your content. The editor recognizes internal links to other pages and converts them.
- **Insert media from your project**: Drag an image or video from the navigation tree into the page to embed it inline. Supported formats include PNG, JPG, JPEG, GIF, WebP, SVG, MP4, and WebM.
- **Insert an emoji**: Type <kbd>:</kbd> followed by a keyword to open the emoji picker.
- **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.

Check warning on line 53 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L53

Use 'Cursor' instead of 'cursor'.

**Markdown mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter.

<Note>
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).
</Note>

For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code).
Expand All @@ -58,7 +75,7 @@

### Table of contents

In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section.

Check warning on line 78 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L78

Did you really mean 'minimap'?

Check warning on line 78 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L78

Did you really mean 'minimap'?

### Code block options

Expand All @@ -73,7 +90,7 @@

Open the publish menu and click any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff. If you're in Markdown mode, you see a Markdown diff.

Diff view is read-only. Click the <Icon icon="x" /> button next to the mode toggle to return to editing.

Check warning on line 93 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L93

Use 'diffs?' instead of 'Diff'.

Check warning on line 93 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L93

In general, use active voice instead of passive voice ('is read').

## Manage pages

Expand All @@ -90,7 +107,7 @@

Hover over a page and click the gear icon, or right-click and select **Settings**, to configure:

- **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL.

Check warning on line 110 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L110

Use 'sidebars?' instead of 'Sidebar'.
- **Description** and **Keywords**: Improve search and SEO.
- **Layout**: Choose from standard, wide, centered, or custom.

Expand All @@ -102,7 +119,7 @@

Type <kbd>/image</kbd> to upload a new image or select an existing one from your repository. Type <kbd>/video</kbd> to upload or select a video.

You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In Markdown mode, the editor inserts the file path at your cursor position. Images save to your `images/` folder and videos to `videos/`.

Check warning on line 122 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L122

Use 'Cursor' instead of 'cursor'.

To reuse media that already lives in your project, drag an image or video file from the navigation tree onto the page. The editor embeds the asset inline.

Expand Down
23 changes: 21 additions & 2 deletions es/editor/pages.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

<div id="navigate-files">
Expand Down Expand Up @@ -37,6 +37,25 @@ 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.
</Note>

<div id="edit-supporting-text-files">
## Editar archivos de texto auxiliares
</div>

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 (<kbd>Cmd</kbd> + <kbd>F</kbd> en macOS, <kbd>Ctrl</kbd> + <kbd>F</kbd> 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.

Cuando ediciones simultáneas en Git y en el editor no se pueden fusionar de forma limpia, el editor inserta marcadores de conflicto etiquetados como `editor` e `incoming`. Resuelve los marcadores 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.

<Frame>
<img src="/images/editor/mode-toggle-light.png" alt="Conmutador de modo en la barra de herramientas." className="block dark:hidden" />

Expand Down
23 changes: 21 additions & 2 deletions fr/editor/pages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Créer et modifier des pages"
description: "Créez, modifiez et organisez des pages de documentation dans l'éditeur web."
keywords: ["éditeur","contenu","pages","fichiers"]
description: "Créez des pages, modifiez du contenu, importez des images et vidéos, et gérez vos fichiers dans l'éditeur web Mintlify avec édition enrichie et recherche."
keywords: ["éditeur","contenu","pages","fichiers","créer","modifier","médias","images","vidéo"]
---

<div id="navigate-files">
Expand Down Expand Up @@ -37,6 +37,25 @@ 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.
</Note>

<div id="edit-supporting-text-files">
## Modifier les fichiers texte auxiliaires
</div>

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 (<kbd>Cmd</kbd> + <kbd>F</kbd> sur macOS, <kbd>Ctrl</kbd> + <kbd>F</kbd> 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.

Lorsque des modifications simultanées dans Git et dans l'éditeur ne peuvent pas être fusionnées proprement, l'éditeur insère des marqueurs de conflit étiquetés `editor` et `incoming`. Résolvez les marqueurs 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.

<Frame>
<img src="/images/editor/mode-toggle-light.png" alt="Bouton de bascule de mode dans la barre d'outils." className="block dark:hidden" />

Expand Down
23 changes: 21 additions & 2 deletions zh/editor/pages.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "创建和编辑页面"
description: "在 Web 编辑器中创建、编辑和组织文档页面。"
keywords: ["编辑器","内容","页面","文件"]
description: "在 Mintlify Web 编辑器中创建页面、编辑内容、上传图片和视频,并通过富文本编辑和全文搜索管理文档文件。"
keywords: ["编辑器","内容","页面","文件","创建","编辑","媒体","图片","视频"]
---

<div id="navigate-files">
Expand Down Expand Up @@ -37,6 +37,25 @@ keywords: ["编辑器","内容","页面","文件"]
API 规范文件(OpenAPI 和 AsyncAPI)在 Web 编辑器中为只读。你可以查看其内容,但无法直接编辑。要更新规范文件,请使用你偏好的代码编辑器进行编辑,然后将更改推送到你的文档仓库。
</Note>

<div id="edit-supporting-text-files">
## 编辑辅助文本文件
</div>

除了 MDX 和 Markdown 页面外,Web 编辑器还可以打开常见文本文件进行实时协作编辑。在导航树中点击以下任一类型的文件,可使用与文档页面相同的实时同步、自动保存和 Git 集成方式进行编辑:

- `.yml` 和 `.yaml`
- `.json`
- `.js` 和 `.jsx`
- `.css`
- `.txt`
- `.csv`

文本文件会在带有语法高亮和搜索功能的源代码模式编辑器中打开(macOS 上使用 <kbd>Cmd</kbd> + <kbd>F</kbd>,Windows 上使用 <kbd>Ctrl</kbd> + <kbd>F</kbd>)。更改会在协作者之间实时同步:每个人的光标都可见,从编辑器外部发布的更改会自动合并。

当 Git 和编辑器中的同时编辑无法干净地合并时,编辑器会插入标记为 `editor` 和 `incoming` 的冲突标记。在发布前请解决这些标记。

扩展名不在此列表中的文件(例如字体、压缩包和其他二进制资源)仍为只读。请在本地代码编辑器中修改这些文件,然后将更改推送到你的仓库。

<Frame>
<img src="/images/editor/mode-toggle-light.png" alt="工具栏中的模式切换开关。" className="block dark:hidden" />

Expand Down
Loading