Saltar al contenido principal

¿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, 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.
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: Haga clic en Collapse sidebar para ocultar sus páginas y en Ask agent para abrir el agente junto a su página. En una página del sitio, la barra superior también tiene Preview y Publish, además del selector de branch cuando está visible. En una página privada, tiene Share. Haga clic en More options para acciones de página como Page settings, Comments, Version history, Duplicate y Move within project.
  • Barra lateral: Use la barra lateral para seleccionar páginas que editar, crear páginas nuevas, gestionar la estructura de su sitio y moverse por el dashboard. Presione Cmd + \ (macOS) o Ctrl + \ (Windows) para mostrar u ocultar sus páginas. Presione Cmd + K (macOS) o Ctrl + K (Windows) para buscar en el dashboard.
    • Iconos del dashboard: Cambie de proyecto desde el menú de la parte superior. Haga clic en Home para volver al editor desde cualquier parte del dashboard o en Search para buscar en sus páginas, la configuración y las automatizaciones. Debajo, abra Publishes, Analytics, Automations, MCP y Settings. En la parte inferior, haga clic en Get help para acceder a la documentación, el soporte y las novedades del producto, o haga clic en su avatar para abrir el menú de su perfil.
    • Páginas: 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. Si usa páginas privadas, Personal contiene sus borradores privados y Shared with me contiene páginas que sus compañeros han compartido con usted directamente.

​
Buscar en el dashboard

Presione Cmd + K (macOS) o Ctrl + K (Windows), o haga clic en Search en la barra lateral, para buscar en el dashboard. En el modo visual, primero deseleccione cualquier texto, porque Cmd + K añade un enlace al texto seleccionado. La búsqueda encuentra:
  • Sus páginas.
  • Páginas de configuración.
  • Secciones de docs.json, que se abren en el editor.
  • Secciones de Analytics y Publishes.
  • Automatizaciones por nombre.
La búsqueda también ejecuta acciones, como invitar a miembros, crear una automatización, abrir o cerrar el agente, mostrar u ocultar la barra lateral, cambiar entre los temas claro y oscuro, contactar con soporte y abrir la lista de atajos de teclado. Algunas acciones, como invitar a miembros, solo aparecen si su rol lo permite. Antes de que escriba, la búsqueda sugiere resultados para la página en la que se encuentra. Por ejemplo, en una página de configuración sugiere secciones de esa página, y en el editor sugiere secciones de la configuración del 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, 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 10.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. El modo source no está disponible mientras el modo de sugerencias está activado. 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.