Editor visual

Interfaz del editor visual de Mintlify en modo claro

Interfaz del editor visual de Mintlify en modo oscuro

Accede al editor visual desde tu dashboard para gestionar tu documentación directamente en el navegador.

Edición WYSIWYG: Realiza cambios en tu documentación con un editor WYSIWYG (what you see is what you get) que muestra cómo se verá el contenido al publicarse.
Sincronización con Git: Todos los cambios se sincronizan automáticamente con tu repositorio de Git para mantener el control de versiones.
Colaboración en equipo: Varias personas pueden trabajar en la documentación simultáneamente.
Integración de componentes: Agrega llamadas de atención, bloques de código y otros componentes con comandos de barra.
Sin configuración previa: Comienza a escribir de inmediato desde tu dashboard.

Descripción general

Así es como normalmente trabajarás en el editor visual:

Elige tu branch

Crea una branch o realiza cambios directamente en tu rama de implementación. Recomendamos crear una branch para que puedas previsualizar tus cambios antes de que se publiquen.

Abre tu archivo

Navega a un archivo existente en la barra lateral o crea uno nuevo usando el explorador de archivos.

Edita tu contenido

Realiza cambios en el editor visual. Presiona / para abrir el menú de componentes.

Previsualiza tus cambios

El modo visual te muestra cómo aparecerán tus cambios en tu sitio en producción. Úsalo para verificar que todo se vea correcto.

Publica tus cambios

Si estás trabajando en tu rama de implementación, publica tus cambios directamente desde el editor visual. En otras branch, crearás una solicitud de extracción para revisión antes de publicar.

Modos del editor

El editor visual tiene dos modos para adaptarse a distintas preferencias y necesidades de edición: modo visual y Modo Markdown. Usa el conmutador de modo en la barra de herramientas del editor para cambiar de modo.

Iconos del conmutador de modo resaltados en el editor visual.

Modo visual

El modo visual ofrece una experiencia WYSIWYG (what you see is what you get) en la que los cambios que realizas en el editor reflejan cómo se verá tu documentación publicada. Este modo es ideal cuando quieres ver en tiempo real cómo se verán tus cambios.

Modo de edición visual en el editor visual de Mintlify

Modo Markdown

Markdown mode proporciona acceso directo al código MDX subyacente de tu documentación. Este modo es ideal cuando necesitas un control preciso de las propiedades de los componentes o cuando prefieres escribir con la sintaxis de Markdown.

Gestionar contenido

Navega por tus archivos

Usa el explorador de archivos de la barra lateral para navegar por tus archivos de documentación. Haz clic en cualquier archivo para abrirlo en el editor. Pulsa Command + P en macOS o Ctrl + P en Windows para buscar archivos por nombre.

Crear páginas nuevas

Selecciona el icono Create a new file en la barra lateral del explorador de archivos.

Menú de archivos en el editor visual en modo oscuro

Los nombres de archivo se completan automáticamente con la extensión .mdx. Para cambiar el tipo de archivo, haz clic en la extensión. Selecciona el tipo de archivo que deseas en el menú desplegable.

Menú de extensión de archivo en el editor visual

Menú de extensión de archivo en el editor visual en modo oscuro

Renombrar páginas

Para cambiar el nombre de una página, haz clic en el icono del menú kebab del archivo que quieres renombrar. Selecciona Renombrar en el menú desplegable.

Cambiar el nombre de una página en el editor visual.

Cambiar el nombre de una página en el editor visual en modo oscuro.

Eliminar páginas

Para eliminar una página, haz clic en el icono del menú de tres puntos del archivo que quieres eliminar. Selecciona Eliminar en el menú desplegable.

Eliminar una página en el editor visual.

Eliminar una página en el editor visual en modo oscuro.

Edita tu archivo docs.json para agregar nuevas páginas y eliminar las páginas borradas de la navegación de tu sitio. Consulta Navegación para obtener más información sobre cómo organizar páginas. Ejemplo: Agregar una página de Temas al grupo Profile En este ejemplo, creaste una nueva página titulada Temas y quieres agregarla al grupo Profile en tu documentación. Agrega la ruta de la nueva página en el arreglo pages del grupo Profile en tu archivo docs.json para que aparezca en la navegación de tu sitio.

Adding a Themes page to the Profile group

{
    "navigation": {
        "groups": [
            {
                "group": "Primeros pasos",
                "pages": [
                    "index",
                    "quickstart",
                    "installation"
                ]
            },
            {
                "group": "Perfil",
                "pages": [
                    "settings",
                    "account-types",
                    "dashboard",
                    "themes"
                ]
            }
        ]
    }
}

Editar contenido

Realiza cambios en tus páginas usando el modo visual o el modo Markdown en el editor. En el modo visual, presiona / para abrir el menú de componentes. Agrega bloques de contenido, avisos, bloques de código y otros componentes para personalizar tu documentación.

El menú de componentes desplegado, resaltado en el editor visual de Mintlify

En el modo Markdown, editas directamente el MDX de tus páginas. Esto puede ser útil cuando necesitas:

Establecer propiedades específicas de componentes
Trabajar con componentes anidados complejos
Copiar y pegar contenido MDX de otras fuentes

Consulta Formatear texto y Formatear código para obtener más información sobre cómo escribir con la sintaxis de Markdown.

Publica tus cambios

La rama en la que trabajas determina cómo el editor publica tus cambios:

Rama de implementación: Al publicar, tu sitio en producción se actualiza de inmediato.
Otras ramas: Al publicar, se crea una solicitud de extracción para que puedas revisar los cambios antes de implementarlos en producción.

El botón Publicar resaltado en el editor visual de Mintlify

Solicitudes de extracción y revisión de cambios

Las solicitudes de extracción te permiten proponer cambios desde tu branch para que otras personas los revisen antes de fusionarlos en tu documentación en producción. Esto ayuda a garantizar que tus cambios sean correctos y le da a tu equipo la oportunidad de colaborar en el contenido.

Incluso si trabajas solo, las solicitudes de extracción son útiles para previsualizar cambios y mantener un historial claro de actualizaciones.

Crear una solicitud de extracción

Guardar tu trabajo

Selecciona Guardar cambios para guardar todos los cambios en tu branch.

Crear la solicitud de extracción

Selecciona Publish Pull Request en la barra de herramientas del editor.

Añadir un título y una descripción

Escribe un título y una descripción claros que expliquen:

Qué cambios hiciste
Por qué los hiciste
Cualquier área específica que necesite revisión

Crear y compartir

Selecciona Publish Pull Request. El editor proporcionará un enlace para ver tu solicitud de extracción.

Botón Publish Pull Request resaltado en el editor visual de Mintlify

Revisar solicitudes de extracción

Una vez creada tu solicitud de extracción:

Revisar cambios: Tú y tu equipo pueden revisar la solicitud de extracción en tu proveedor de Git, como GitHub o GitLab.
Dejar comentarios: Añade comentarios o solicita cambios.
Realizar cambios adicionales: Haz cambios adicionales en el editor visual. Cuando seleccionas Guardar cambios, el editor los envía a tu solicitud de extracción.
Aprobar: Aprueba la solicitud de extracción cuando estés satisfecho con los cambios.
Fusionar: Fusiona la solicitud de extracción cuando estés listo para implementar tus cambios en producción.

Atajos de teclado

El editor visual admite todos los atajos de teclado comunes, como copiar, pegar, deshacer y seleccionar todo, y además los siguientes:

Comando	macOS	Windows
Buscar archivos	`Cmd` + `P`	`Control` + `P`
Agregar enlace al texto seleccionado	`Cmd` + `K`	`Control` + `K`
Insertar salto de línea	`Cmd` + `Enter`	`Control` + `Enter`
Negrita	`Cmd` + `B`	`Control` + `B`
Cursiva	`Cmd` + `I`	`Control` + `I`
Subrayado	`Cmd` + `U`	`Control` + `U`
Tachado	`Cmd` + `Shift` + `S`	`Control` + `Shift` + `S`
Código	`Cmd` + `E`	`Control` + `E`
Texto normal	`Cmd` + `Alt` + `0`	`Control` + `Alt` + `0`
Encabezado 1	`Cmd` + `Alt` + `1`	`Control` + `Alt` + `1`
Encabezado 2	`Cmd` + `Alt` + `2`	`Control` + `Alt` + `2`
Encabezado 3	`Cmd` + `Alt` + `3`	`Control` + `Alt` + `3`
Encabezado 4	`Cmd` + `Alt` + `4`	`Control` + `Alt` + `4`
Lista numerada	`Cmd` + `Shift` + `7`	`Control` + `Shift` + `7`
Lista con viñetas	`Cmd` + `Shift` + `8`	`Control` + `Shift` + `8`
Cita	`Cmd` + `Shift` + `B`	`Control` + `Shift` + `B`
Subíndice	`Cmd` + `,`	`Control` + `,`
Superíndice	`Cmd` + `.`	`Control` + `.`

Solución de problemas

Encuentra soluciones a problemas comunes que puedes experimentar al usar el editor visual.

Los cambios no aparecen después de publicar

Posibles causas:

La implementación aún está en curso
Problemas de caché del navegador
Errores de compilación o de implementación

Soluciones:

Revisa el estado de la implementación en tu dashboard.
Actualiza forzadamente tu navegador (Ctrl + F5 o Cmd + Shift + R)
Borra la caché de tu navegador.

Errores de permisos al publicar

Posibles causas:

Permisos insuficientes en el repositorio de Git
Problemas de Autenticación con tu proveedor de Git

Soluciones:

Verifica que tengas el acceso correcto al repositorio.
Comprueba si tu integración de Git está configurada correctamente.
Revisa la documentación de Permisos del editor.

Problemas al cargar el editor

Posibles causas:

Problemas de conectividad de red
Repositorios de documentación grandes

Soluciones:

Revisa tu conexión a internet.
Actualiza la página.
Contacta al soporte si el problema persiste.

Los archivos no se cargan o muestran errores

Posibles causas:

Sintaxis MDX inválida en los archivos
Archivos faltantes o dañados
Archivos de gran tamaño que provocan tiempos de espera

Soluciones:

Revisa la sintaxis del archivo para detectar errores de formato MDX.
Verifica que el archivo exista en tu repositorio.

Próximos pasos

Aprende los conceptos fundamentales de Git
Aprende las mejores prácticas para colaborar con branches

Comenzar

Organizar

Personalizar

Crear contenido

Documentar APIs

Implementar

Optimizar

Descripción general