Skip to main content

¿Es nuevo en el editor? Empiece por el tutorial.

Cree una branch, haga un cambio, comparta una vista previa y publique.
Use el editor para escribir y publicar documentación en su navegador. El editor usa un flujo de trabajo docs-as-code en el que Git respalda todos sus cambios. Su trabajo se guarda como commits en su repositorio y el editor gestiona las operaciones de Git por usted. El editor se carga de forma predeterminada cuando abre su dashboard. Cualquier miembro de su organización puede abrirlo, pero ciertas acciones dependen de su rol. Los admins y editors pueden editar y publicar. Los viewers pueden explorar el contenido y dejar comentarios y sugerencias.

​
Cómo funciona el editor

Los cambios se guardan automáticamente, pero guardar es distinto de publicar. A medida que escribe, el editor almacena su trabajo. Sus cambios persisten entre pestañas, dispositivos e interrupciones de red. Para que un cambio llegue a su sitio publicado, debe publicarlo. Publicar escribe en Git. Cuando publica, el editor hace commit de sus cambios en su repositorio. Si publica en su deployment branch, su sitio publicado se actualiza de inmediato. En una feature branch, puede guardar los cambios en la branch o abrir una pull request para revisión. Nada en una feature branch llega a su sitio publicado hasta que hace merge en su deployment branch. Git se mantiene sincronizado. Cuando alguien hace push a su repositorio, esos cambios aparecen automáticamente. No necesita hacer pull ni actualizar la página. El editor combina los cambios que no entran en conflicto y señala todo lo que requiere su atención. Su equipo edita en conjunto. Varias personas pueden editar la misma página a la vez, con cursores en vivo que muestran quién trabaja en cada parte. Los comentarios y las sugerencias son visibles para todos.
Si el editor alguna vez parece estar desincronizado con su repositorio, use Restablecer editor para forzar una resincronización.

​
Diseño del editor

  • Barra superior: Use la barra superior para controlar en qué branch trabaja, acceder al agente, previsualizar y publicar cambios.
  • Barra lateral: Use la barra lateral para seleccionar páginas que editar, crear páginas nuevas y gestionar la estructura de su sitio.
    • Home: El árbol de archivos de su proyecto. Las páginas en Personal son privadas para usted. Las páginas en Workspace son públicas para su organización.
    • Publishing: La estructura de navegación de su sitio. Organice las páginas como quiere que aparezcan en su sitio.

​
Modo visual y modo source

El modo visual representa su página a medida que escribe. Presione / para abrir el menú de componentes e insertar componentes. El modo source le da acceso directo al MDX. Úselo para tener control preciso sobre las propiedades de los componentes y el frontmatter. Ambos modos editan el mismo archivo. Cambie entre ellos con Cmd + Shift + S (macOS) o Ctrl + Shift + S (Windows). Para conocer los componentes que puede insertar, consulte Componentes. Para la sintaxis de MDX, consulte Dar formato al texto y Dar formato al código.

​
Conceptos de Git

Entender algunos conceptos de Git le ayuda a aprovechar mejor el editor. Para ver las definiciones de commits, branches, pull requests, merges, conflictos y diffs, consulte Conceptos de Git para la documentación.

Temas relacionados

GlosarioVista general de automatizacionesDescripción general