Descripción general del editor

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

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, sus ediciones se hacen commit automáticamente en la branch y se abre una pull request para su revisión. Nada de lo que hay 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.

• Barra superior: Abra el agente con Ask agent. En la pestaña Site, la barra superior también tiene el selector de branch, Preview y Publish. En la pestaña Workspace, tiene Share. Haga clic en More options para acciones de página como Page settings, Comments, Version history, Duplicate y Move to.
• Barra lateral: Use la barra lateral para seleccionar páginas que editar, crear páginas nuevas y gestionar la estructura de su sitio. Presione Ctrl + \ (macOS y Windows) para mostrarla u ocultarla. Presione Cmd + K (macOS) o Ctrl + K (Windows) para buscar en sus páginas y en el dashboard.
  • Workspace: Páginas que no forman parte de su repositorio de Git ni de su sitio publicado. Personal contiene sus borradores privados, Teamspace contiene páginas compartidas con toda su organización y Shared with me contiene páginas que sus compañeros han compartido con usted directamente.
  • Site: Su repositorio y su sitio publicado. Navigation contiene las páginas de la navegación de su sitio. Files enumera los archivos de su repositorio que no están en la navegación.

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, con números de línea. Úselo para tener control preciso sobre las propiedades de los componentes y el frontmatter. Escriba < para acceder a los componentes. Presione Cmd + S (macOS) o Ctrl + S (Windows) para dar formato al documento. Si un solo cambio modifica más de 1.000 caracteres, el editor le pide que lo confirme.

Ambos modos editan el mismo archivo y admiten la colaboración en tiempo real. Cambie entre ellos con Cmd + Shift + S (macOS) o Ctrl + Shift + S (Windows), o con el interruptor Source mode en More options. El editor recuerda su elección entre páginas.

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.

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.