Saltar al contenido principal
Interfaz del editor web de Mintlify en modo claro El editor web es una interfaz visual para crear, editar y revisar documentación directamente en tu navegador.
  • Edición visual: Realiza cambios en tu documentación con un editor WYSIWYG (what you see is what you get) 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 inclinada.
  • Sin configuración: Comienza a escribir de inmediato desde tu dashboard.

Flujo de trabajo del editor web

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

Elige tu branch

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

Abre tu archivo

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

Edita tu contenido

Realiza cambios en el editor web. Prueba alternar entre el modo visual y el Modo Markdown usando el interruptor en la esquina superior derecha para ver qué modo prefieres.
4

Previsualiza tus cambios

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

Publica tus cambios

Si estás trabajando en tu rama de implementación, publica tus cambios directamente desde el editor web. En otros branches, crea una solicitud de extracción para revisión antes de publicar.

Modos del editor

El editor web tiene dos modos para adaptarse a distintas preferencias y necesidades de edición. Usa el conmutador en la esquina superior derecha de la barra de herramientas del editor para cambiar entre modos de edición.
Iconos del conmutador de modo resaltados en el editor web.

Modo visual

El modo visual ofrece una experiencia WYSIWYG (lo que ves es lo que obtienes) en la que los cambios que haces en el editor son los mismos que se publicarán en tu sitio de documentación. Este modo es ideal cuando quieres ver en tiempo real cómo se verán tus cambios. Pulsa “/” para abrir el menú de componentes y añadir contenido con estilo, avisos, fragmentos de código u otros componentes.
Modo de edición visual en el editor web 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 sobre las propiedades de los componentes o cuando prefieres escribir con la sintaxis de Markdown.
Markdown mode en el editor web de Mintlify

Próximos pasos

I