Saltar al contenido principal
Configura la marca, la apariencia y las funcionalidades de tu sitio de documentación desde el panel Configurations en el editor web.
Opciones de Configurations en la barra lateral en modo claro.

​
Define la marca de tu sitio

Configura la identidad de tu sitio y cómo aparece para los visitantes.
  • Título de la documentación: El nombre de tu documentación. Aparece en las pestañas del navegador y en los resultados de búsqueda.
  • Descripción: Breve resumen de tu documentación. Se utiliza para SEO y los metadatos del sitio.
  • Favicon: Pequeño icono que aparece en las pestañas del navegador. Carga archivos ICO, PNG, GIF o JPG.
  • Tema: Elige un tema para la apariencia general de tu documentación.

​
Personaliza los colores y la apariencia

Controla la identidad visual y la paleta de colores de tu sitio.
  • Color primario: El color de acento principal que se usa en todo tu sitio para enlaces, botones y elementos destacados.
  • Color del modo claro: Variación del color de acento para el modo claro. La forma en que se aplica depende de cada tema.
  • Color del modo oscuro: Variación del color de acento para el modo oscuro. La forma en que se aplica depende de cada tema.
  • Logo: El logo de tu marca. Sube archivos SVG, PNG o JPG. Puedes establecer logos distintos para los modos claro y oscuro.
  • Enlace del logo: Adónde van los usuarios cuando hacen clic en tu logo. Normalmente es tu página de inicio o tu sitio de marketing.
  • Colores de fondo: Configura colores de fondo personalizados por separado para los modos claro y oscuro.
  • Imagen de fondo: Añade una imagen de fondo a tu sitio. Sube archivos PNG, GIF o JPG.
  • Decoración de fondo: Aplica estilos visuales a tu imagen de fondo.
  • Selector de tema: Muestra u oculta el interruptor de modo claro/oscuro para los usuarios.
  • Tema predeterminado: Define si tu sitio se carga en modo claro u oscuro de forma predeterminada.

​
Configurar fuentes personalizadas

Reemplaza las fuentes predeterminadas con la tipografía de tu marca.
  • Fuente predeterminada: La familia tipográfica y el peso base para todo el texto. Proporciona una URL de origen y el formato (WOFF o WOFF2).
  • Fuente de encabezados: Familia tipográfica y peso específicamente para encabezados (h1, h2, etc.). Se configura por separado del cuerpo de texto.
  • Fuente del cuerpo: Familia tipográfica y peso para el cuerpo de texto y los párrafos.
Para cada fuente, especifica el nombre de la familia, el peso, la URL de origen (como Google Fonts) y el formato.

​
Configurar el encabezado

Agrega elementos de navegación a la parte superior de tu sitio.
  • Botón de la barra de navegación: Agrega un botón principal de llamada a la acción en tu encabezado. Configura el tipo de botón, el label y la URL de destino.
  • Enlaces de la barra de navegación: Agrega enlaces de navegación adicionales en tu encabezado. Cada enlace incluye texto y una URL.
Agrega enlaces y perfiles de redes sociales al footer de tu sitio.
  • Enlaces sociales: Agrega tus perfiles en plataformas como GitHub, X (Twitter), LinkedIn, Discord, YouTube, Slack y más.
  • Columnas del footer: Organiza los enlaces del footer en columnas con títulos personalizados y grupos de enlaces.

​
Mejorar el contenido

Personaliza cómo se muestra el contenido en tu sitio.
  • Fondo de miniatura: Configura una imagen de fondo personalizada para las miniaturas de página y las vistas previas en redes sociales.
  • Apariencia de la miniatura: Controla cómo se muestran las miniaturas.
  • Fuente de la miniatura: Configura una fuente personalizada para el texto en las miniaturas.
  • Etiqueta de página: Añade pequeñas etiquetas encima de los títulos de las páginas.
  • Tema del bloque de código: Elige el tema de resaltado de sintaxis para los bloques de código.
  • Soporte para LaTeX: Habilita el renderizado de notación matemática con LaTeX.
Personaliza la experiencia de búsqueda.
  • Marcador de posición de búsqueda: El texto que aparece en el campo de búsqueda antes de que los usuarios escriban. El valor predeterminado es «Buscar o preguntar…».

​
Agrega analítica e integraciones

Conecta herramientas de analítica y servicios de terceros a tu documentación. Realiza el seguimiento del comportamiento de los visitantes con:
  • Amplitude, Mixpanel, Heap: Plataformas de analítica de producto
  • Google Analytics, Google Tag Manager: Analítica web
  • PostHog, Plausible, Fathom: Analítica centrada en la privacidad
  • Segment, Hightouch: Plataformas de datos de clientes
  • Hotjar, LogRocket: Reproducción de sesiones y mapas de calor
  • Microsoft Clarity: Analítica del comportamiento de usuarios
  • Intercom: Mensajería con clientes
  • Clearbit, Koala: Identificación de visitantes
Integraciones adicionales:
  • Telemetry: Activa o desactiva la telemetría de uso
  • Cookies: Define pares personalizados de key y value de cookies

​
Configurar la documentación de la API

Configura referencias de API interactivas.
  • Especificaciones de OpenAPI: Vincula tus archivos de especificación OpenAPI/Swagger.
  • Especificaciones de AsyncAPI: Vincula tus archivos de especificación AsyncAPI para APIs asíncronas.
  • Visualización del área de pruebas: Controla cómo se muestra el área de pruebas de la API.
  • Servidor proxy: Configura un servidor proxy para las solicitudes de API desde el área de pruebas.