Saltar al contenido

Portal de docs

Un sitio de docs de Jotly es un portal público que leen tus clientes y al que enlaza tu equipo de soporte. Escribes en un editor de bloques, publicas con un clic y el sitio sigue el diseño que elijas.

Esta página cubre todo el camino: el editor, los sitios y dominios, el diseño, las audiencias y cómo leen el sitio el buscador y los agentes de IA. Dos páginas relacionadas van más a fondo: Git Sync y el servidor MCP de docs.

Escribe páginas

Cada página es un árbol de bloques con ids estables. Escribe / en una línea vacía para abrir el menú de comandos.

  • Básicos: texto, títulos del 1 al 4, listas con viñetas, numeradas y de tareas, cita, separador y aviso (nota, info, consejo, advertencia, peligro, listo).
  • Multimedia: imágenes con pie y un archivo aparte para modo oscuro, e insertos de YouTube, Loom, Vimeo, Figma, CodePen, CodeSandbox, StackBlitz, Google Docs, Miro, Excalidraw, Supademo y Arcade.
  • Interactivos: pestañas, pasos, acordeones, tarjetas, botones y enlaces a otras páginas.
  • Avanzados: bloques de código, grupos de código, tablas y bloques condicionales.

El menú de la izquierda es un árbol de pestañas, grupos, enlaces y páginas. Arrastra para mover, renombra, duplica, oculta del menú y pon un emoji o un ícono de Lucide a una página, un grupo o una pestaña.

Borradores y publicación

Las páginas se guardan solas como borrador. En una página publicada, los cambios al título, la descripción y el cuerpo esperan hasta que pulses Publicar cambios; el slug, el ícono, la portada y el SEO se aplican al instante. También puedes ver la vista previa, descartar cambios y despublicar.

Los miembros pueden publicar cuando el ajuste del sitio “Los miembros pueden publicar” está activo (lo está por omisión). Borrar páginas y cambiar los ajustes del sitio es de los administradores.

Cada publicación crea una revisión numerada con su autor y su fecha. Abre el historial para leer una versión vieja, compararla con la actual o restaurarla al editor como borrador.

Al crear un espacio puedes partir de una plantilla:

  • En blanco
  • Página de inicio
  • Documentación de producto
  • Referencia de API
  • Changelog
  • Centro de ayuda

Sitios y dominios

Un workspace puede tener varios sitios de docs, cada uno con su slug, su diseño y su audiencia. Dónde vive un sitio depende de cómo lo publiques:

DóndeDirección
Dirección de Jotly/b/<workspace>/<slug-del-sitio>/<página>
Dominio propio<tu-dominio>/<slug-del-sitio>
Subdirectorioacme.com/docs, con un proxy inverso

El dominio propio es el que conectas a todo el workspace en Ajustes y requiere el plan Starter o Pro. Si el workspace baja al plan Free, el sitio deja de servirse ahí.

Para un subdirectorio como acme.com/docs, tu servidor hace proxy de la ruta a la dirección de Jotly y manda la cabecera X-Forwarded-Prefix. Los ajustes de Docs generan el fragmento para Vercel, Cloudflare Workers, Nginx y Next.js, y Verificar pide <subdirectorio>/llms.txt para confirmar que el proxy funciona.

Límites por plan:

PlanPáginas publicadasSitios
Free251
StarterSin límite3
ProSin límiteSin límite

Diseño

Abre Docs y luego Diseño. El portal público se actualiza conforme cambias cada opción.

  • Plantilla: Jotly, Developer (tres columnas), Centro de ayuda (primero la búsqueda, con un hero) o Libro (barra lateral rellena).
  • Color de acento: un valor hex, por separado para claro y oscuro. Fondos, bordes y enlaces se derivan de él. Los colores avanzados te dejan cambiar cada uno.
  • Forma: esquinas cuadradas, suaves o redondas, además del estilo de íconos, la profundidad, el estilo de enlaces y el de la lista lateral.
  • Apariencia: sistema, claro u oscuro por omisión, con un interruptor opcional para los lectores y temas de código para cada modo.
  • Marca: logos claro y oscuro, favicon, navegación del encabezado, un botón de acción, una barra de anuncio y un pie con redes sociales.
  • Idioma: los textos propios del portal (búsqueda, “En esta página”, opinión) vienen en 11 idiomas y siguen el idioma del lector o uno fijo. El contenido de las páginas no se traduce.
El CSS propio (hasta 20,000 caracteres, limitado al portal) y quitar “Powered by Jotly” requieren el plan Pro.

Quién puede leer

Cada sitio tiene una audiencia:

AudienciaQuién lo ve
PúblicaCualquier persona.
Enlaces compartidosQuien tenga un enlace que creaste. Los enlaces pueden tener nombre y vencimiento, y los puedes revocar.
AutenticadaClientes con identidad verificada: un identify firmado, un token de SSO, un inicio de sesión del portal o una cuenta del equipo.
PrivadaSólo tu equipo.

Un token anónimo del widget o un identify sin firma cuenta como anónimo, así que nunca abre un sitio autenticado. Mira Identificar usuarios.

Cualquier audiencia distinta de la pública requiere el plan Pro. Un sitio sin publicar sólo lo ve tu equipo.

Muestra a cada lector su propia versión

Un bloque Condicional, o una regla Visible para en la página, muestra contenido sólo a los lectores que cumplan: todas o alguna de las condiciones sobre authenticated, email, email_domain, company, plan, role, name o cualquier atributo que mandes en identify. Las reglas se evalúan en el servidor, así que el contenido oculto nunca llega al navegador. Las páginas con regla quedan fuera de la búsqueda, el sitemap, llms.txt, el servidor MCP y Nova.

Búsqueda y agentes de IA

Lectores y agentes tienen varias formas de entrar:

  • Búsqueda: pulsa Cmd+K o Ctrl+K. Los resultados salen de la búsqueda de texto completo de Postgres, con títulos sin distinguir acentos, y muestran la mejor sección y un fragmento. La puedes apagar por sitio.
  • Preguntar a Nova: la ventana de búsqueda ofrece “Preguntar a Nova” y el menú de la página ofrece “Preguntar” cuando el widget de Jotly está en la página, y abren ahí la conversación con Nova. El ajuste del sitio requiere el plan Pro.
  • Markdown: agrega .md a la URL de cualquier página, o manda Accept: text/markdown, para recibirla en Markdown. El menú de la página trae Copiar página, Ver como Markdown, Abrir en ChatGPT y Abrir en Claude.
  • llms.txt: /llms.txt, /llms-full.txt y /sitemap.xml, cada uno con su interruptor. Sólo listan lo que un lector anónimo puede ver.
  • MCP: cada sitio público puede responder a Claude, Cursor y VS Code. Mira el servidor MCP de docs.
Cada página pregunta “¿Te sirvió esta página?”. Un comentario de “No me sirvió” puede abrir una solicitud en tu tablero de feedback.

Ver también Página del producto Docs