Primeros pasos con el editor web

Aprende a crear y editar documentación con el editor web

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 (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 inclinada.
• Sin configuración: Comienza a escribir de inmediato desde tu panel.

​

Flujo de trabajo del Editor web

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

1. Elige tu rama

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

2. Abre tu archivo

   Navega 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 usando el interruptor en la esquina superior derecha para ver qué modo prefieres.

4. 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.

5. Publica tus cambios

   Si estás trabajando en tu rama de despliegue, publica tus cambios directamente desde el Editor web. En otras ramas, crea una pull request 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 los modos de edición.

​

Modo visual

El modo visual ofrece una experiencia WYSIWYG en la que los cambios que hagas en el editor son los 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 Markdown

El modo Markdown ofrece 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.

​

Próximos pasos

• Aprende los conceptos fundamentales de Git.
• Conoce las prácticas recomendadas para colaborar con ramas.
• Explora la gestión de contenido con el Editor web.
• Comprende las opciones de publicación para distintos escenarios.