Jamdesk Documentation logo

Editor web

Edita tus docs de Jamdesk en el navegador: explora el repo conectado, edita MDX con preview en vivo y haz commit a GitHub para iniciar un build.

El editor web te permite editar tu documentación directamente en el dashboard de Jamdesk, sin configuración local, sin terminal y sin comandos de Git. Abre una página, edita su MDX con un preview en vivo junto a ti y haz commit de tus cambios en tu rama de GitHub. Cada commit inicia un build automáticamente, así que tus cambios se publican tal como lo haría un git push.

Es la contraparte basada en el navegador de preview local y la extensión de VS Code: úsalo cuando quieras hacer una edición rápida desde cualquier lugar, o cuando prefieras no clonar el repositorio.

Abrir el editor

Haz clic en Editor en la barra lateral del dashboard. El editor se abre en el repositorio conectado y la rama predeterminada de tu proyecto.

El editor requiere un repositorio de GitHub conectado y una pantalla ancha (escritorio). En ventanas más estrechas muestra un aviso de "se necesita un navegador más ancho", ya que los paneles de código y preview necesitan espacio para colocarse uno junto al otro. Está disponible para todo propietario de proyecto y miembro del equipo, en todos los planes.

La interfaz

El editor tiene tres paneles:

PanelQué hace
Navigation (izquierda)Las páginas y grupos de tu sitio, leídos desde docs.json. Filtra páginas, abre el editor de Configuration (docs.json), o haz clic en Add page.
Editor (centro)Un editor de código MDX para el archivo abierto, con resaltado de sintaxis y conteo de palabras.
Preview (derecha)Una renderización en vivo de la página, actualizada mientras escribes. Alterna Desktop / Mobile y Light / Dark para comprobar cómo se ve.

La rama que estás editando se muestra en la esquina superior izquierda; cambia de rama con el selector de ramas.

Editar una página

Haz clic en cualquier página de la navegación para abrirla. Edita el MDX en el panel central y observa cómo el preview se actualiza en vivo. Tus ediciones se guardan como un borrador local en tu navegador hasta que hagas commit, así que puedes moverte entre páginas sin perder tu trabajo, y nada se escribe en GitHub hasta que decidas hacer commit.

Agregar una página

Haz clic en Add page para crear una nueva página sin salir del editor:

  1. Elige una plantilla inicial.
  2. Ingresa un título: el nombre de archivo de la página se deriva de él automáticamente.
  3. Elige a qué grupo de navegación pertenece.

La nueva página se abre como borrador. Cuando haces commit, Jamdesk escribe tanto el nuevo archivo .mdx como la entrada de navegación en docs.json en el mismo commit.

Hacer commit de los cambios

Cuando estés listo para publicar, haz commit de tus cambios pendientes en GitHub:

1
Abre el diálogo de commit

Haz clic en Commit. El diálogo muestra cada archivo que has cambiado (una página, docs.json, o varios a la vez).

2
Escribe un mensaje

Escribe un mensaje de commit, o haz clic en Generate para que Jamdesk lo escriba a partir de tu diff.

3
Commit

Jamdesk hace commit de los cambios en tu rama actual e inicia un build de inmediato. Síguelo en la página Builds del proyecto.

¿Prefieres descartar las ediciones? Revert descarta los cambios sin guardar de la página actual y restaura la versión del último commit.

Trabajar con cambios externos

Si alguien más hace push a la misma rama mientras estás editando, el editor detecta que la rama avanzó y lo marca. Cuando haces commit, cualquier archivo que haya cambiado en el origen se muestra como un merge de tres vías para que puedas reconciliar ambas versiones; tus ediciones locales nunca se descartan.

Hacer commit desde el editor es exactamente igual que hacer push desde tu propia máquina: escribe un commit real en tu repositorio y activa el mismo pipeline de build. Si tus docs viven en un subdirectorio del repositorio (configuración de monorepo), el editor lee y escribe ahí automáticamente.

Requisitos

RequisitoDetalle
GitHub conectadoEl proyecto debe tener un repositorio y una rama conectados.
Navegador de escritorioUna pantalla ancha (aproximadamente 1400px o más); el editor no está disponible en anchos móviles.
AccesoCualquier propietario o miembro del proyecto. Editar escribe en tu repositorio, así que aplican los bloqueos de escritura habituales (por ejemplo, una suscripción vencida).

¿Qué sigue?

Preview local

Preview y edición local con el CLI

Cómo funciona el despliegue

Qué pasa después de hacer commit