- Edición visual: 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 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 callouts, bloques de código y otros Componentes (Mintlify) con comandos de barra.
- Sin configuración: Comienza a escribir de inmediato desde tu panel.
Flujo de trabajo del Editor web
1
Elige tu rama
Crea una rama o realiza cambios directamente en tu rama de despliegue. Recomendamos crear una rama para poder previsualizar los cambios antes de que se publiquen.
2
Abre tu archivo
Ve a un archivo existente en la barra lateral o crea uno nuevo con el explorador de archivos.
3
Edita tu contenido
Realiza cambios en el Editor web. Prueba alternar entre el modo visual y el modo Markdown con el interruptor de la esquina superior derecha para ver qué modo prefieres.
4
Previsualiza tus cambios
El modo visual te muestra cómo se verán los cambios en tu sitio en producción. Úsalo para verificar que todo se vea correcto.
5
Publica tus cambios
Si trabajas en tu rama de despliegue, publica los cambios directamente desde el Editor web. En otras ramas, crea un pull request para revisión antes de publicar.
Modos del editor
Modo visual
/ para abrir el menú de componentes y añadir contenido con estilo, avisos, fragmentos de código u otros componentes.
Modo Markdown
MDX subyacente de tu documentación. Es ideal cuando necesitas un control preciso de las propiedades de los componentes o cuando prefieres escribir con sintaxis Markdown.
Próximos pasos
- Aprende los conceptos fundamentales de Git.
- Aprende buenas prácticas para colaborar con ramas.
- Explora la gestión de contenido con el Editor web.
- Comprende las opciones de publicación para distintos escenarios.