Editor web

Crea, mantén y publica documentación en tu navegador.

Accede al editor web 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 (lo que ves es lo que obtienes) que muestra cómo se verá tu 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 avisos, bloques de código y otros componentes con comandos de barra diagonal.
• Sin necesidad de configuración: Comienza a escribir de inmediato desde tu dashboard.

​

Descripción general

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

1. Choose your 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.

2. Open your file

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

3. Edit your content

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

4. Preview your changes

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

5. Publish your changes

   Publica tus cambios directamente en tu sitio de documentación en producción o crea una solicitud de extracción para revisar los cambios antes de hacer el merge.

​

Modos del editor

El editor web tiene dos modos para adaptarse a distintas preferencias y necesidades de edición: modo visual y Markdown mode.

Usa el conmutador de modo en la barra de herramientas del editor para cambiar de modo.

​

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.

​

Markdown mode

Markdown mode ofrece acceso directo a los archivos que conforman tu documentación. Este modo es ideal cuando necesitas tener un control preciso sobre las propiedades de los componentes o cuando prefieres escribir con la sintaxis de MDX.

​

Gestionar contenido

​

Navega por tus archivos

Usa el explorador de archivos de la barra lateral para explorar 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 Crear un archivo nuevo en la barra lateral del explorador de archivos.

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.

​

Renombrar páginas

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

​

Eliminar páginas

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

​

Organiza tu navigation

Edita tu archivo docs.json para agregar nuevas páginas y eliminar las páginas borradas de la navigation de tu sitio. Consulta Navigation para obtener más información sobre cómo organizar las 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 al array pages del grupo Profile en tu archivo docs.json para que aparezca en la navigation 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 Markdown mode en el editor.

En el modo visual, presiona / para abrir el menú de componentes. Agrega bloques de contenido, notas, bloques de código y otros componentes para personalizar tu documentación.

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

• Definir propiedades específicas de los componentes
• Trabajar con componentes anidados complejos
• Copiar y pegar contenido MDX desde otras fuentes

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

​

Publica tus cambios

El flujo de publicación del editor depende de la rama en la que trabajes y de las reglas de protección de ramas de tu repositorio.

Tipo de rama	Protección de rama	Qué ocurre cuando publicas
Rama de implementación	Ninguna	Los cambios se fusionan y se publican de inmediato
Rama de implementación	Solicitudes de extracción obligatorias	Se crea una solicitud de extracción para revisión
Otra rama	Ninguna	Los cambios se fusionan en la rama de implementación y se publican de inmediato
Otra rama	Solicitudes de extracción obligatorias	Se crea una solicitud de extracción para revisión

Configura reglas de protección de ramas en tu proveedor de Git para exigir revisiones de solicitudes de extracción antes de fusionar. Consulta About protected branches en la documentación de GitHub o Protected branches en la documentación de GitLab para obtener más información.

Para firmar las confirmaciones con tu cuenta de GitHub, debes autorizar tu cuenta de GitHub en la página My profile de tu dashboard. Si no autorizas tu cuenta de GitHub, la Aplicación de GitHub de Mintlify firma las confirmaciones realizadas en el editor web.

​

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.

​

Crea una solicitud de extracción

1. Guarda tu trabajo

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

2. Crea la solicitud de extracción

   Selecciona Publicar solicitud de extracción en la barra de herramientas del editor.

3. Agrega un título y una descripción

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

   • Qué cambios realizaste
   • Por qué los hiciste
   • Qué áreas específicas necesitan revisión
4. Crea y comparte

   Selecciona Publicar solicitud de extracción. El editor proporciona un enlace para ver tu solicitud de extracción.

   

​

Revisar solicitudes de extracción

Una vez creada tu solicitud de extracción:

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

​

Compartir implementaciones de vista previa

Comparte las implementaciones de vista previa con tu equipo para recopilar comentarios antes de publicar los cambios.

1. Haz clic en el botón Share en la barra de herramientas del editor.

2. Haz clic en el botón Preview para abrir la implementación de vista previa en una nueva pestaña del navegador.

   

3. Comparte la URL de la vista previa con cualquier persona que necesite revisar tus cambios.

Cuando hagas cambios, la implementación de vista previa se actualizará automáticamente. Es posible que los cambios tarden unos instantes en aparecer.

Las URL de vista previa son de acceso público de forma predeterminada. Cualquiera que tenga el enlace puede ver tu implementación de vista previa. Para restringir el acceso solo a miembros autenticados de tu organización, habilita la autenticación de vista previa en tu dashboard.

​

Atajos de teclado

El editor web 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 en bloque	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 encontrar al usar el editor web.

Los cambios no aparecen después de publicar

Posibles causas:

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

Soluciones:

1. Revisa el estado de la implementación en tu dashboard.

2. Actualiza forzosamente tu navegador (Ctrl

   o Cmd

   )

3. 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:

1. Verifica que tengas el acceso correcto al repositorio.
2. Comprueba si tu integración de Git está configurada correctamente.
3. 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:

1. Verifica tu conexión a internet.
2. Recarga la página.
3. Contacta al soporte si el problema persiste.

Los archivos no cargan o muestran errores

Posibles causas:

• Sintaxis de MDX no válida en los archivos
• Archivos faltantes o dañados
• Archivos demasiado grandes que provocan tiempos de espera

Soluciones:

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

​

Próximos pasos

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