Editor web
Edita tus docs de Jamdesk en el navegador: explora el repo, edita MDX con vista previa en vivo y confirma en GitHub para activar un build.
El editor web te permite editar tu documentación directamente en el dashboard de Jamdesk, sin clonar el repositorio ni tocar una terminal. Abre una página, edita su MDX con una vista previa en vivo a un lado y confirma tus cambios en tu rama de GitHub. Cada commit inicia un build automáticamente, así que tus cambios se publican de la misma forma que lo haría un git push.
Las capturas de pantalla muestran la interfaz en inglés.
Es el equivalente basado en navegador de la vista previa local y la extensión de VS Code. Recurre a él cuando quieras hacer una edición rápida desde cualquier lugar, o cuando prefieras no clonar el repositorio en absoluto.
Abrir el editor
Haz clic en Editor en la barra lateral del dashboard. El editor se abre en el repositorio conectado de tu proyecto y su rama predeterminada.
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 vista previa necesitan espacio para ubicarse uno junto al otro. Está disponible para todos los propietarios y miembros del equipo del proyecto, en todos los planes.
La interfaz
El editor tiene tres paneles:
| Pane | What it does |
|---|---|
| Navegación (izquierda) | Las páginas y grupos de tu sitio, leídos desde docs.json. Filtra páginas, abre el editor de Configuración (docs.json) o Añadir página. |
| Editor (centro) | Un editor de código MDX para el archivo abierto, con resaltado de sintaxis y recuento de palabras. |
| Vista previa (derecha) | Una renderización en vivo de la página, actualizada mientras escribes. Alterna entre Escritorio / Móvil y Claro / Oscuro para comprobar cómo se ve. |
La rama que estás editando se muestra en la parte 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 se actualiza la vista previa en vivo. Tus ediciones se guardan como un borrador local en tu navegador hasta que confirmas los cambios, así puedes moverte entre páginas sin perder tu trabajo. No se escribe nada en GitHub hasta que decides confirmar los cambios.
Añadir una página
Haz clic en Añadir página para crear una página nueva sin salir del editor:
- Elige una plantilla inicial.
- Escribe un título. El nombre de archivo de la página se genera automáticamente a partir de él.
- Elige a qué grupo de navegación pertenece.
La nueva página se abre como borrador. Cuando confirmas los cambios, Jamdesk escribe tanto el nuevo archivo .mdx como la entrada de navegación en docs.json en el mismo commit.
Confirmar cambios
Cuando estés listo para publicar, confirma tus cambios pendientes en GitHub:
Haz clic en Confirmar. El diálogo muestra todos los archivos que has cambiado (una página, docs.json, o varios a la vez).
Escribe un mensaje de commit o haz clic en Generar para que Jamdesk escriba uno a partir de tu diff.
Jamdesk confirma los cambios en tu rama actual e inicia un build de inmediato. Síguelo en la página de Builds del proyecto.
¿Prefieres descartar los cambios? Revertir descarta los cambios no guardados de la página actual y restaura la versión confirmada.
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 señala. Cuando confirmas los cambios, cualquier archivo que haya cambiado en el origen se muestra como una fusión de tres vías para que puedas conciliar ambas versiones. Tus ediciones locales nunca se descartan.
Confirmar cambios desde el editor es exactamente como hacer push desde tu propia máquina: escribe un commit real en tu repositorio y activa el mismo pipeline de build. Si tu documentación vive en un subdirectorio del repositorio (configuración de monorepo), el editor lee y escribe ahí automáticamente.
Requisitos
| Requirement | Detail |
|---|---|
| GitHub conectado | El proyecto debe tener un repositorio y una rama conectados. |
| Navegador de escritorio | Una pantalla ancha (aproximadamente 1400px o más); el editor no está disponible en anchos móviles. |
| Acceso | Cualquier propietario o miembro del proyecto. Editar escribe en tu repositorio, por lo que se aplican los bloqueos de escritura habituales (por ejemplo, una suscripción vencida). |