Saltar al contenido principal
Configure la marca, la apariencia y las funciones de su sitio desde el panel Site configurations en el editor web. Los cambios de configuración se sincronizan en tiempo real con otros editores en la misma branch, de modo que su equipo siempre ve los ajustes más recientes.
Menú de Configurations en el editor.
El panel está organizado en secciones que se corresponden con las propiedades de nivel superior de su docs.json.

​
General

Establezca la identidad de su sitio y cómo aparece para los visitantes.
  • Name: El nombre de su proyecto. Aparece en las pestañas del navegador y en los resultados de búsqueda.
  • Description: Breve descripción de su proyecto. Se utiliza para SEO y AEO.

​
Marca

Suba las marcas que identifican su sitio.
  • Logo: El logo de su marca. Suba archivos PNG o JPG. Establezca versiones separadas para modo claro y oscuro y una URL opcional al hacer clic. Para usar un logo SVG, añada el archivo a su repositorio y referencie su ruta en su docs.json.
  • Favicon: Pequeño icono que aparece en las pestañas del navegador. Suba archivos ICO, PNG, GIF o JPG. Establezca versiones separadas para modo claro y oscuro si es necesario.

​
Estilo

Controle la identidad visual y la paleta de colores de su sitio.
  • Theme: Elija un tema para la apariencia general de su sitio.
  • Primary color: El color de acento principal usado en todo su sitio para enlaces, botones y elementos destacados.
  • Light color: Color de acento usado en modo oscuro. La forma en que los temas lo aplican varía según el tema.
  • Dark color: Color de acento usado en modo claro. La forma en que los temas lo aplican varía según el tema.
  • Background color: Colores de fondo personalizados para modo claro y oscuro.
  • Icon library: Biblioteca de iconos usada para todas las propiedades de iconos. El valor predeterminado es fontawesome.
  • Strict appearance: Bloquea el sitio en un único modo de apariencia y oculta el conmutador de tema.
  • Default appearance: Indica si su sitio se carga en modo system, light o dark por defecto.
  • Background decoration: Aplica un estilo visual (gradient, grid o windows) al fondo.
  • Background image: Imagen de fondo opcional. Establezca una sola imagen o versiones separadas para modo claro y oscuro.

​
Tipografía

Reemplace las fuentes predeterminadas con la tipografía de su marca.
  • Font family: Cualquier familia de Google Fonts funciona sin configuración adicional. Para una fuente alojada por usted mismo, proporcione una URL de origen y un formato (woff o woff2).
  • Weight: Normalmente 400 para regular y 700 para negrita. Las fuentes variables admiten pesos precisos como 550.
  • Heading font: Anulación opcional aplicada a todos los encabezados (h1 a h6).
  • Body font: Anulación opcional aplicada al cuerpo de texto y al resto de la página.
Añada elementos de navegación a la parte superior de su sitio.
  • Primary button: La llamada a la acción principal en su cabecera. Establezca el tipo, la etiqueta y la URL de destino.
  • Navbar links: Enlaces de navegación adicionales en su cabecera. Cada enlace incluye un texto y una URL.
Añada enlaces y perfiles de redes sociales al pie de página de su sitio.
  • Social links: Perfiles en plataformas como GitHub, X, LinkedIn, Discord, YouTube y Slack.
  • Footer columns: Habilítelo para organizar los enlaces del pie de página en hasta cuatro columnas con encabezados personalizados.
Muestre una barra de anuncios en la parte superior de cada página.
  • Content: El texto del banner. Admite formato MDX básico como enlaces, negrita y cursiva. Los componentes personalizados no son compatibles.
  • dismissible: Muestra un botón para descartar en el lado derecho del banner.
  • Type: Estilo visual. info usa el color primario de la marca, warning usa un fondo ámbar y critical usa un fondo rojo. El valor predeterminado es info.
  • Color: Anula el color de fondo del banner con un color hexadecimal personalizado. Establezca valores separados para modo claro y oscuro para colores adaptables al tema.

​
Miniatura

Personalice las miniaturas de las páginas y las vistas previas para redes sociales.
  • Background: Imagen de fondo personalizada para las miniaturas.
  • Appearance: Renderiza las miniaturas en modo light o dark. Cuando no se define, las miniaturas se generan automáticamente a partir de los colores de su tema.
  • Font: Fuente personalizada para el texto en las miniaturas.

​
Contenido

Personalice cómo aparece el contenido en su sitio.
  • Page eyebrow: Muestra etiquetas pequeñas que preceden a los títulos de las páginas. Elija section o breadcrumbs.
  • Timestamps: Muestra la fecha de la última modificación del contenido en todas las páginas.
  • LaTeX: Carga las hojas de estilo de LaTeX (KaTeX) para renderizar notación matemática.

​
Bloques de código

Configure el resaltado de sintaxis y el comportamiento de los bloques de código.
  • Code block theme: Iguala el modo claro/oscuro del sitio con system, usa siempre un tema oscuro con dark o elija un tema personalizado de Shiki.
  • Custom code languages: Registre lenguajes adicionales para el resaltado de sintaxis.

​
Menú contextual

Configure las acciones rápidas que aparecen en el menú contextual de la página.
  • Options: Menú desplegable de selección múltiple con acciones como copy, view y abrir la página en chatgpt, claude, cursor y otros asistentes de IA.
  • Display: Dónde mostrar las opciones. header (predeterminado) las muestra en el menú contextual en la parte superior de la página; toc las muestra en la barra lateral del índice de contenido.
Ajuste el comportamiento de la navegación en todo su sitio.
  • drilldown: Navega automáticamente a la primera página cuando un usuario hace clic en un grupo de navegación.
Personalice la experiencia de búsqueda y los comentarios.
  • Search placeholder: El texto que aparece en el cuadro de búsqueda antes de que los usuarios escriban. El valor predeterminado es Search or ask.
  • Feedback: Muestra botones de pulgar arriba y pulgar abajo o un enlace “Suggest edits” en cada página.

​
Referencia de API

Documente los endpoints de su API.
  • OpenAPI specs: Añada archivos de especificación OpenAPI para generar páginas de referencia de API.
  • AsyncAPI specs: Añada archivos de especificación AsyncAPI para generar páginas de referencia de API.
  • MDX server: Endpoints personalizados del servidor MDX para el playground de API.
  • Playground display: Muestra el playground interactivo de la API, el playground simple de la API o ningún playground de API.
  • Proxy server: Habilita o deshabilita el servidor proxy para las solicitudes de API.
  • mdx.schema: Indica si se renderiza la sección de esquema en las páginas de referencia de API.

​
Redirecciones

Use la sección Redirects para añadir, editar, buscar y eliminar redirecciones sin editar manualmente su archivo docs.json. Las redirecciones envían a los usuarios desde URLs antiguas a otras nuevas, lo cual es útil cuando renombra páginas o reestructura su sitio. Para más información, consulte Redirecciones. Cada redirección tiene los siguientes campos:
  • Source: La ruta desde la que redirigir, como /old-path. Admite comodines.
  • Destination: La ruta a la que redirigir, como /new-path. Admite comodines.
  • Status: El código de estado HTTP para la redirección.
    • 308: Redirección permanente. Úselo para contenido que se ha movido de forma permanente. Este es el estado predeterminado.
    • 307: Redirección temporal. Úselo cuando el movimiento es temporal.
Menú de redirecciones en el editor.
Para añadir una redirección:
  1. Haga clic en Add redirect.
  2. Introduzca el origen y el destino.
  3. Haga clic en Save.
Para editar o eliminar una redirección existente, pase el cursor sobre la fila y use el icono de edición en línea o la X para eliminarla.

​
SEO

Configure las metaetiquetas y la indexación para los motores de búsqueda.
  • metatags: Etiquetas <meta> personalizadas aplicadas en todo su sitio. Añada pares clave-valor para etiquetas como og:image o twitter:card.
  • Indexing: Elija si se deben indexar las páginas ocultas.

​
Analítica

Conecte plataformas de analítica para rastrear el comportamiento de los visitantes. Los proveedores admitidos incluyen Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit y más. Cada entrada se muestra como una fila en línea. Use el icono X para eliminar una integración.

​
Página 404

Personalice la experiencia cuando un usuario llega a una página inexistente.
  • Redirect to home: Cuando está activado, las páginas inexistentes redirigen a su página de inicio. Cuando está desactivado, se muestra una página 404 y puede personalizar el título y la descripción a continuación.
  • Title: Encabezado que se muestra en la página 404.
  • Description: Subtítulo que se muestra en la página 404.

​
Variables

Defina variables personalizadas que se pueden reutilizar en todo su contenido. Cada variable es un par clave-valor. Use el icono X para eliminar una variable.