From f916f492c5b800e6404e3d3174a5b4c85e9eb8ea Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 26 May 2026 07:13:05 +0000 Subject: [PATCH 1/2] docs: refresh Configurations editor page for new section structure --- editor/configurations.mdx | 164 +++++++++++++++--------- es/editor/configurations.mdx | 231 +++++++++++++++++---------------- fr/editor/configurations.mdx | 231 +++++++++++++++++---------------- zh/editor/configurations.mdx | 239 ++++++++++++++++++----------------- 4 files changed, 471 insertions(+), 394 deletions(-) diff --git a/editor/configurations.mdx b/editor/configurations.mdx index 3e9ec1145..cd1ebccb7 100644 --- a/editor/configurations.mdx +++ b/editor/configurations.mdx @@ -1,6 +1,6 @@ --- title: "Configurations" -description: "Edit site branding, colors, appearance, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync." +description: "Edit site branding, appearance, navigation, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync." keywords: ["editor", "configurations", "settings", "branding", "theme"] boost: 3 --- @@ -20,93 +20,126 @@ Configure your documentation site's branding, appearance, and features from the /> -## Brand your site +The panel is organized into sections that map to the top-level properties in your [`docs.json`](/organize/settings). Use the table of contents on the right to jump between sections. + +## General Set your site's identity and how it appears to visitors. -- **Docs title**: The name of your site. Appears in browser tabs and search results. -- **Description**: Brief summary of your documentation. Used for SEO and site metadata. -- **Favicon**: Small icon that appears in browser tabs. Upload ICO, PNG, GIF, or JPG files. +- **Name**: The name of your project. Appears in browser tabs and search results. +- **Description**: Brief overview of your project. Used for SEO and AEO. + +## Branding + +Upload the marks that identify your site. + +- **Logo**: Your brand logo. Upload PNG or JPG files. Set separate light and dark versions and an optional click-through URL. To use an SVG logo, add the file to your repository and reference its path in your [`docs.json`](/organize/settings-appearance#logos). +- **Favicon**: Small icon that appears in browser tabs. Upload ICO, PNG, GIF, or JPG files. Set separate light and dark versions if needed. -## Customize colors and appearance +## Styling Control your site's visual identity and color scheme. - **Theme**: Choose a [theme](/customize/themes) for your site's overall appearance. - **Primary color**: The main accent color used throughout your site for links, buttons, and highlights. -- **Light mode color**: Accent color variation for light mode. How themes apply this varies by theme. -- **Dark mode color**: Accent color variation for dark mode. How themes apply this varies by theme. -- **Logo**: Your brand logo. Upload PNG or JPG files. You can set different logos for light and dark modes. To use an SVG logo, add the file to your repository via Git and reference its path in your [docs.json](/organize/settings-appearance#logos) configuration. -- **Logo link**: Where users go when they click your logo. Typically your homepage or marketing site. -- **Background colors**: Set custom background colors for light and dark modes separately. -- **Background image**: Add a background image to your site. Upload PNG, GIF, or JPG files. -- **Background decoration**: Apply visual styles to your background image. -- **Theme toggle**: Show or hide the light/dark mode switcher for users. -- **Default theme**: Set whether your site loads in light or dark mode by default. - -## Set custom fonts +- **Light color**: Accent color used in dark mode. How themes apply this varies by theme. +- **Dark color**: Accent color used in light mode. How themes apply this varies by theme. +- **Background color**: Custom background colors for light and dark modes. +- **Icon library**: Icon library used for all icon properties. Defaults to `fontawesome`. +- **Strict appearance**: Lock the site to a single appearance mode and hide the theme toggle. +- **Default appearance**: Whether your site loads in `system`, `light`, or `dark` mode by default. +- **Background decoration**: Apply a visual style (`gradient`, `grid`, or `windows`) to your background. +- **Background image**: Optional background image. Set a single image or separate light and dark versions. -Replace default fonts with your brand's typography. +## Typography -- **Default font**: The base font family and weight for all text. Provide a source URL and format (WOFF or WOFF2). -- **Heading font**: Font family and weight specifically for headings (h1, h2, etc.). Set separately from body text. -- **Body font**: Font family and weight for body text and paragraphs. +Replace default fonts with your brand's typography. -For each font, specify the family name, weight, source URL (like Google Fonts), and format. +- **Font family**: Any [Google Fonts](https://fonts.google.com/) family works out of the box. For a self-hosted font, provide a source URL and format (`woff` or `woff2`). +- **Weight**: Typically `400` for regular and `700` for bold. Variable fonts support precise weights like `550`. +- **Heading font**: Optional override applied to all headings (`h1`–`h6`). +- **Body font**: Optional override applied to body text and the rest of the page. -## Configure header and banner +## Navbar Add navigation elements to the top of your site. -- **Navbar links**: Add navigation links in your header. Each link includes text and a URL. -- **Banner**: Add a banner displayed at the top of every page. +- **Primary button**: The main call-to-action in your header. Set the type, label, and destination URL. +- **Navbar links**: Additional navigation links in your header. Each link includes text and a URL. -## Configure footer +## Footer Add links and social media handles to your site footer. -- **Social links**: Add your profiles on platforms like GitHub, X (Twitter), LinkedIn, Discord, YouTube, Slack, and more. -- **Footer columns**: Organize footer links into columns with custom headings and link groups. +- **Social links**: Profiles on platforms like GitHub, X, LinkedIn, Discord, YouTube, and Slack. +- **Footer columns**: Enable to organize footer links into up to four columns with custom headings. + +## Banner -## Enhance content +Display an announcement bar across the top of every page. + +- **Content**: The banner text. Supports basic MDX formatting like links, bold, and italic. Custom components are not supported. +- **Dismissible**: Show a dismiss button on the right side of the banner. +- **Type**: Visual style. `info` uses the primary brand color, `warning` uses an amber background, and `critical` uses a red background. Defaults to `info`. +- **Color**: Override the banner background color with a custom hex color. Set separate light and dark values for theme-aware colors. + +## Thumbnail + +Customize page thumbnails and social previews. + +- **Background**: Custom background image for thumbnails. +- **Appearance**: Render thumbnails in `light` or `dark` mode. When unset, thumbnails are auto-generated from your theme colors. +- **Font**: Custom font for text in thumbnails. + +## Content Customize how content appears on your site. -- **Thumbnail background**: Set a custom background image for page thumbnails and social previews. -- **Thumbnail appearance**: Control how thumbnails display. -- **Thumbnail font**: Set a custom font for text in thumbnails. -- **Page eyebrow**: Add small labels preceding page titles. -- **Code block theme**: Choose the syntax highlighting theme for code blocks. -- **LaTeX support**: Enable mathematical notation rendering with LaTeX. -- **Icon library**: Choose the icon library to use for your site. +- **Code block theme**: Match the docs light/dark mode with `system`, always use a dark theme with `dark`, or pick a custom [Shiki](https://shiki.style/) theme. +- **Custom code languages**: Register additional syntax highlighting languages. +- **Page eyebrow**: Show small labels preceding page titles. Choose `section` or `breadcrumbs`. +- **Timestamps**: Show the date the content was last modified on all pages. +- **LaTeX**: Load LaTeX (KaTeX) stylesheets for mathematical notation rendering. -## Set up AI chat and search +## Context menu -Customize the search experience. +Configure the quick actions surfaced in the page context menu. -- **Search placeholder**: The text that appears in the search box before users type. Default is `Search or ask`. +- **Options**: Multi-select dropdown of actions like `copy`, `view`, and opening the page in `chatgpt`, `claude`, `cursor`, and other AI assistants. +- **Display**: Where to display the options. `header` (default) shows them in the top-of-page context menu; `toc` shows them in the table of contents sidebar. + +## Navigation -## Connect integrations +Tune navigation behavior across your site. -Connect third-party tools for analytics, support, and compliance. +- **Drilldown**: Auto-navigate to the first page when a user clicks a navigation group. -## API specifications +## Search + +Customize the search experience and feedback. + +- **Search placeholder**: The text that appears in the search box before users type. Default is `Search or ask`. +- **Feedback**: Show thumbs-up and thumbs-down buttons or a "Suggest edits" link on every page. + +## API reference Document your API endpoints. -- **OpenAPI specs**: Upload an OpenAPI specification file to generate API reference pages. -- **AsyncAPI specs**: Upload an AsyncAPI specification file to generate API reference pages. -- **Playground display**: Choose to display the interactive API playground, simple API playground, or no API playground. +- **OpenAPI specs**: Add OpenAPI specification files to generate API reference pages. +- **AsyncAPI specs**: Add AsyncAPI specification files to generate API reference pages. +- **MDX server**: Custom MDX server endpoints for the API playground. +- **Playground display**: Show the interactive API playground, the simple API playground, or no API playground. - **Proxy server**: Enable or disable the proxy server for API requests. +- **`mdx.schema`**: Whether to render the schema section on API reference pages. -## Manage redirects +## Redirects -Use the **Redirects** section to add, edit, search, and remove redirects without manually editing your `docs.json` file. Redirects send users from old URLs to new ones, which is useful when you rename pages or restructure your documentation. For more information about redirect behavior, see [Redirects](/create/redirects). +Use the **Redirects** section to add, edit, search, and remove redirects without manually editing your `docs.json` file. Redirects send users from old URLs to new ones, which is useful when you rename pages or restructure your documentation. For more information, see [Redirects](/create/redirects). Each redirect has the following fields: - **Source**: The path to redirect from, like `/old-path`. Supports wildcards. -- **Destination**: The path to redirect to, like `/new-path`. +- **Destination**: The path to redirect to, like `/new-path`. Supports wildcards. - **Status**: The HTTP status code for the redirect. - `308`: Permanent redirect. Use this for content that has moved permanently. This is the default status. - `307`: Temporary redirect. Use this when the move is temporary. @@ -125,17 +158,34 @@ Each redirect has the following fields: To add a redirect: -1. Click **Add redirect** + +1. Click **Add redirect**. 2. Enter the source and destination. 3. Click **Save**. -To edit or remove an existing redirect: -1. Hover over the redirect. -2. Click the pencil icon to edit or the trash icon to remove. +To edit or remove an existing redirect, hover over the row and use the inline edit icon or the **X** to remove it. + +## SEO + +Configure metatags and indexing for search engines. + +- **Metatags**: Custom `` tags applied across your site. Add key-value pairs for tags like `og:image` or `twitter:card`. +- **Indexing**: Choose whether to index hidden pages. + +## Analytics + +Connect analytics platforms to track visitor behavior. Supported providers include Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit, and more. + +Each entry renders as an inline row. Use the **X** icon to remove an integration. + +## 404 page + +Customize the experience when a user lands on a missing page. + +- **Redirect to home**: When on, missing pages redirect to your home page. When off, a 404 page is shown and you can customize the title and description below. +- **Title**: Heading shown on the 404 page. +- **Description**: Subheading shown on the 404 page. -## Additional page behaviors +## Variables -- **404 pages**: Customize 404 pages and set up redirect behavior. -- **Menu drilldown**: Enable or disable auto-navigating to the first page when a user clicks a navigation group. -- **Timestamps**: Show "Last modified on [date]" on all pages. -- **SEO indexing**: Choose whether to index hidden pages for search engines. +Define custom variables that can be re-used throughout your content. Each variable is a key-value pair. Use the **X** icon to remove a variable. diff --git a/es/editor/configurations.mdx b/es/editor/configurations.mdx index 7280eb1c8..24c7cdb06 100644 --- a/es/editor/configurations.mdx +++ b/es/editor/configurations.mdx @@ -1,168 +1,177 @@ --- title: "Configuraciones" -description: "Edita los metadatos de las páginas, los elementos de navegación y la configuración multimedia usando las hojas de configuración visuales en la barra lateral del editor web de Mintlify." -keywords: ["editor", "configurations", "settings"] +description: "Edita la marca, la apariencia, la navegación y las funcionalidades de tu sitio desde el panel Configurations del editor web de Mintlify, con sincronización en tiempo real." +keywords: ["editor", "configurations", "settings", "branding", "theme"] boost: 3 --- -Configura la marca, la apariencia y las funcionalidades de tu sitio de documentación desde el panel **Configurations** en el editor web. +Configura la marca, la apariencia y las funcionalidades de tu sitio de documentación desde el panel **Configurations** en el editor web. Los cambios se sincronizan en tiempo real con otros editores en la misma rama. - Opciones de Configurations en la barra lateral en modo claro. + Menú de Configurations en el editor. - Opciones de Configurations en la barra lateral en modo oscuro. + Menú de Configurations en el editor. -
- ## Define la marca de tu sitio -
+El panel está organizado en secciones que se corresponden con las propiedades de nivel superior de tu [`docs.json`](/es/organize/settings). Usa la tabla de contenido a la derecha para saltar entre secciones. -Configura la identidad de tu sitio y cómo aparece para los visitantes. +## General -* **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](/es/customize/themes) para la apariencia general de tu documentación. +Define la identidad de tu sitio y cómo aparece para los visitantes. -
- ## Personaliza los colores y la apariencia -
+- **Name**: El nombre de tu proyecto. Aparece en las pestañas del navegador y en los resultados de búsqueda. +- **Description**: Resumen breve del proyecto. Se usa para SEO y AEO. + +## Branding + +Sube las marcas que identifican tu sitio. + +- **Logo**: El logo de tu marca. Sube archivos PNG o JPG. Define versiones claras y oscuras separadas y una URL opcional de destino. Para usar un logo SVG, añade el archivo a tu repositorio y referencia su ruta en tu [`docs.json`](/es/organize/settings-appearance#logos). +- **Favicon**: Pequeño icono que aparece en las pestañas del navegador. Sube archivos ICO, PNG, GIF o JPG. Define versiones claras y oscuras separadas si es necesario. + +## Styling 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 PNG o JPG. Puedes establecer logos distintos para los modos claro y oscuro. Para usar un logo SVG, añade el archivo a tu repositorio a través de Git y haz referencia a su ruta en tu configuración de docs.json. -* **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 -
+- **Theme**: Elige un [tema](/es/customize/themes) para la apariencia general del sitio. +- **Primary color**: El color de acento principal usado en enlaces, botones y elementos destacados. +- **Light color**: Color de acento usado en modo oscuro. La forma de aplicarlo depende del tema. +- **Dark color**: Color de acento usado en modo claro. La forma de aplicarlo depende del tema. +- **Background color**: Colores de fondo personalizados para los modos claro y oscuro. +- **Icon library**: Biblioteca de iconos usada en todas las propiedades de icono. Por defecto es `fontawesome`. +- **Strict appearance**: Bloquea el sitio en un único modo de apariencia y oculta el selector de tema. +- **Default appearance**: Si tu sitio 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. Configura una sola imagen o versiones separadas para modo claro y oscuro. + +## Typography 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. +- **Font family**: Cualquier familia de [Google Fonts](https://fonts.google.com/) funciona directamente. Para una fuente autoalojada, proporciona la URL de origen y el formato (`woff` o `woff2`). +- **Weight**: Normalmente `400` para regular y `700` para negrita. Las fuentes variables admiten pesos precisos como `550`. +- **Heading font**: Override opcional aplicado a todos los encabezados (`h1`–`h6`). +- **Body font**: Override opcional aplicado al cuerpo de texto y al resto de la página. + +## Navbar -Para cada fuente, especifica el nombre de la familia, el peso, la URL de origen (como Google Fonts) y el formato. +Agrega elementos de navegación a la parte superior del sitio. -
- ## Configurar el encabezado -
+- **Primary button**: La llamada a la acción principal del encabezado. Configura el tipo, el label y la URL de destino. +- **Navbar links**: Enlaces de navegación adicionales del encabezado. Cada enlace incluye texto y una URL. -Agrega elementos de navegación a la parte superior de tu sitio. +## Footer -* **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 redes sociales al footer de tu sitio. - +- **Social links**: Perfiles en plataformas como GitHub, X, LinkedIn, Discord, YouTube y Slack. +- **Footer columns**: Activa columnas (hasta cuatro) con títulos personalizados para organizar los enlaces del footer. -Agrega enlaces y perfiles de redes sociales al footer de tu sitio. +## Banner -* **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. +Muestra un anuncio en la parte superior de cada página. -
- ## Mejorar el contenido -
+- **Content**: El texto del banner. Admite formato MDX básico como enlaces, negrita y cursiva. No se admiten componentes personalizados. +- **Dismissible**: Muestra un botón para cerrar el banner. +- **Type**: Estilo visual. `info` usa el color principal de la marca, `warning` usa un fondo ámbar y `critical` usa un fondo rojo. Por defecto es `info`. +- **Color**: Sobrescribe el color de fondo del banner con un hex personalizado. Define valores separados para claro y oscuro. + +## Thumbnail + +Personaliza las miniaturas de página y las vistas previas en redes sociales. + +- **Background**: Imagen de fondo personalizada para las miniaturas. +- **Appearance**: Renderiza las miniaturas en modo `light` o `dark`. Si no se define, se generan automáticamente a partir de los colores del tema. +- **Font**: Fuente personalizada para el texto de las miniaturas. + +## Content 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. +- **Code block theme**: Sigue el modo claro/oscuro del sitio con `system`, usa siempre uno oscuro con `dark`, o elige un tema personalizado de [Shiki](https://shiki.style/). +- **Custom code languages**: Registra lenguajes adicionales para el resaltado de sintaxis. +- **Page eyebrow**: Muestra pequeñas etiquetas encima de los títulos de página. Elige `section` o `breadcrumbs`. +- **Timestamps**: Muestra la fecha de la última modificación en todas las páginas. +- **LaTeX**: Carga la hoja de estilos de LaTeX (KaTeX) para renderizar notación matemática. + +## Context menu - +Configura las acciones rápidas del menú contextual de página. -Personaliza la experiencia de búsqueda. +- **Options**: Desplegable multi-selección 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` (por defecto) las muestra en el menú contextual superior; `toc` las muestra en la barra lateral de la tabla de contenido. -* **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…». +## Navigation -
- ## Conectar integraciones -
+Ajusta el comportamiento de la navegación. -Conecta herramientas de terceros para Analytics, soporte y cumplimiento. +- **Drilldown**: Navega automáticamente a la primera página cuando un usuario hace clic en un grupo de navegación. -
- ## Configurar especificaciones de la API -
+## Search -Agrega archivos de especificación [OpenAPI](/es/api-playground/openapi-setup) o [AsyncAPI](/es/api-playground/asyncapi-setup) para documentar endpoints. +Personaliza la experiencia de búsqueda y feedback. -* **Especificaciones de OpenAPI**: Sube un archivo de especificación de OpenAPI o ingresa una URL a un archivo externo de OpenAPI. -* **Especificaciones de AsyncAPI**: Sube un archivo de especificación de AsyncAPI o ingresa una URL a un archivo externo de AsyncAPI. -* **Visualización del área de pruebas**: Elige mostrar el área de pruebas interactiva de la API, el área de pruebas simple de la API o ninguna área de pruebas de la API. -* **Servidor proxy**: Activa o desactiva el servidor proxy para solicitudes a la API. +- **Search placeholder**: Texto que aparece en el campo de búsqueda antes de escribir. Por defecto es `Search or ask`. +- **Feedback**: Muestra botones de pulgar arriba/abajo o un enlace "Suggest edits" en cada página. -
- ## Gestionar redirecciones -
+## API reference -Usa la sección **Redirects** para agregar, editar, buscar y eliminar redirecciones sin tener que editar manualmente tu archivo `docs.json`. Las redirecciones envían a los usuarios desde URLs antiguas a otras nuevas, lo que resulta útil cuando renombras páginas o reestructuras tu documentación. Para obtener más información sobre el comportamiento de las redirecciones, consulta [Redirecciones](/es/create/redirects). +Documenta los endpoints de tu API. + +- **OpenAPI specs**: Añade archivos de especificación OpenAPI para generar páginas de referencia. +- **AsyncAPI specs**: Añade archivos de especificación AsyncAPI para generar páginas de referencia. +- **MDX server**: Endpoints personalizados del servidor MDX para el playground. +- **Playground display**: Muestra el playground interactivo, el playground simple o ninguno. +- **Proxy server**: Activa o desactiva el servidor proxy para las solicitudes de la API. +- **`mdx.schema`**: Renderiza la sección de schema en las páginas de referencia. + +## Redirects + +Usa la sección **Redirects** para agregar, editar, buscar y eliminar redirecciones sin editar manualmente tu `docs.json`. Para más información, consulta [Redirecciones](/es/create/redirects). Cada redirección tiene los siguientes campos: -- **Source**: La ruta desde la que se redirige, como `/old-path`. Admite comodines. -- **Destination**: La ruta a la que se redirige, como `/new-path`. -- **Status**: El código de estado HTTP de la redirección. - - `308`: Redirección permanente. Úsalo para contenido que se ha movido de manera permanente. Es el estado predeterminado. - - `307`: Redirección temporal. Úsalo cuando el cambio sea temporal. +- **Source**: Ruta desde la que se redirige, como `/old-path`. Admite comodines. +- **Destination**: Ruta a la que se redirige, como `/new-path`. Admite comodines. +- **Status**: Código de estado HTTP. + - `308`: Redirección permanente. Es el valor por defecto. + - `307`: Redirección temporal. - Menú de redirecciones en el editor. - Menú de redirecciones en el editor. + Menú de redirecciones en el editor. + + Menú de redirecciones en el editor. Para agregar una redirección: + 1. Haz clic en **Add redirect**. -2. Introduce el origen y el destino. +2. Ingresa el origen y el destino. 3. Haz clic en **Save**. -Para editar o eliminar una redirección existente: -1. Pasa el cursor por encima de la redirección. -2. Haz clic en el icono del lápiz para editarla o en el icono de la papelera para eliminarla. +Para editar o eliminar una redirección, pasa el cursor por la fila y usa el icono de edición en línea o la **X** para eliminarla. + +## SEO + +Configura metatags e indexación para motores de búsqueda. + +- **Metatags**: Etiquetas `` personalizadas aplicadas en todo el sitio. Añade pares clave-valor como `og:image` o `twitter:card`. +- **Indexing**: Elige si indexar las páginas ocultas. + +## Analytics + +Conecta plataformas de analítica para hacer seguimiento del comportamiento de los visitantes. Los proveedores compatibles incluyen Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit y más. -
- ## Agrega analítica e integraciones -
+Cada entrada se muestra como una fila en línea. Usa el icono **X** para eliminar una integración. -Conecta herramientas de analítica y servicios de terceros a tu documentación. +## 404 page -Realiza el seguimiento del comportamiento de los visitantes con: +Personaliza la experiencia cuando un usuario llega a una página inexistente. -* **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 +- **Redirect to home**: Cuando está activado, las páginas faltantes redirigen al inicio. Cuando está desactivado, se muestra una página 404 y puedes personalizar su título y descripción. +- **Title**: Encabezado mostrado en la página 404. +- **Description**: Subtítulo mostrado en la página 404. -Integraciones adicionales: +## Variables -* **Telemetry**: Activa o desactiva la telemetría de uso -* **Cookies**: Define pares personalizados de key y value de cookies \ No newline at end of file +Define variables personalizadas que se pueden reutilizar en todo el contenido. Cada variable es un par clave-valor. Usa el icono **X** para eliminar una variable. diff --git a/fr/editor/configurations.mdx b/fr/editor/configurations.mdx index 3c2af946d..a87a74864 100644 --- a/fr/editor/configurations.mdx +++ b/fr/editor/configurations.mdx @@ -1,168 +1,177 @@ --- title: "Configurations" -description: "Modifiez les métadonnées des pages, les éléments de navigation et les paramètres multimédias à l’aide des feuilles de configuration visuelles dans la barre latérale de l’éditeur web Mintlify." -keywords: ["éditeur", "configurations", "paramètres"] +description: "Modifiez l’image de marque, l’apparence, la navigation et les fonctionnalités de votre site depuis le panneau Configurations de l’éditeur web Mintlify, avec synchronisation en temps réel." +keywords: ["éditeur", "configurations", "paramètres", "branding", "theme"] boost: 3 --- -Configurez l'image de marque, l'apparence et les fonctionnalités de votre site de documentation à partir du panneau **Configurations** de l'éditeur web. +Configurez l'image de marque, l'apparence et les fonctionnalités de votre site de documentation depuis le panneau **Configurations** de l'éditeur web. Les modifications se synchronisent en temps réel avec les autres éditeurs sur la même branche. - Paramètres de Configurations dans la barre latérale en mode clair. + Menu Configurations dans l’éditeur. - Paramètres de Configurations dans la barre latérale en mode sombre. + Menu Configurations dans l’éditeur. -
- ## Personnalisez l’identité de votre site -
+Le panneau est organisé en sections qui correspondent aux propriétés de premier niveau de votre [`docs.json`](/fr/organize/settings). Utilisez la table des matières à droite pour naviguer entre les sections. -Définissez l’identité de votre site et la façon dont il se présente aux visiteurs. +## General -* **Titre de la documentation** : Le nom de votre documentation. Apparaît dans les onglets du navigateur et les résultats de recherche. -* **Description** : Brève synthèse de votre documentation. Utilisée pour le SEO et les metadata du site. -* **Favicon** : Petite icône qui apparaît dans les onglets du navigateur. Téléversez des fichiers ICO, PNG, GIF ou JPG. -* **Thème** : Choisissez un [thème](/fr/customize/themes) pour l’apparence générale de votre documentation. +Définissez l'identité de votre site et la façon dont il apparaît aux visiteurs. -
- ## Personnaliser les couleurs et l'apparence -
+- **Name** : Le nom de votre projet. Apparaît dans les onglets du navigateur et les résultats de recherche. +- **Description** : Bref aperçu du projet. Utilisé pour le SEO et l'AEO. -Contrôlez l'identité visuelle et la palette de couleurs de votre site. +## Branding -* **Couleur principale** : La couleur d'accent principale utilisée sur l'ensemble de votre site pour les liens, les boutons et les éléments mis en évidence. -* **Couleur en mode clair** : Variation de la couleur d'accent pour le mode clair. Son application peut varier selon le thème. -* **Couleur en mode sombre** : Variation de la couleur d'accent pour le mode sombre. Son application peut varier selon le thème. -* **Logo** : Le logo de votre marque. Téléversez des fichiers PNG ou JPG. Vous pouvez définir des logos différents pour les modes clair et sombre. Pour utiliser un logo SVG, ajoutez le fichier à votre dépôt via Git et référencez son chemin dans votre configuration docs.json. -* **Lien du logo** : Page vers laquelle les utilisateurs sont redirigés lorsqu'ils cliquent sur votre logo. En général, votre page d'accueil ou votre site marketing. -* **Couleurs d'arrière-plan** : Définissez des couleurs d'arrière-plan personnalisées séparément pour les modes clair et sombre. -* **Image d'arrière-plan** : Ajoutez une image d'arrière-plan à votre site. Téléversez des fichiers PNG, GIF ou JPG. -* **Décoration d'arrière-plan** : Appliquez des styles visuels à votre image d'arrière-plan. -* **Bascule de thème** : Affichez ou masquez le sélecteur de mode clair/sombre pour les utilisateurs. -* **Thème par défaut** : Définissez si votre site se charge par défaut en mode clair ou en mode sombre. +Téléversez les éléments qui identifient votre site. -
- ## Configurer des polices personnalisées -
+- **Logo** : Le logo de votre marque. Téléversez des fichiers PNG ou JPG. Définissez des versions claire et sombre distinctes et une URL de destination optionnelle. Pour utiliser un logo SVG, ajoutez le fichier à votre dépôt et référencez son chemin dans votre [`docs.json`](/fr/organize/settings-appearance#logos). +- **Favicon** : Petite icône affichée dans les onglets du navigateur. Téléversez des fichiers ICO, PNG, GIF ou JPG. Définissez des versions claire et sombre si nécessaire. -Remplacez les polices par défaut par la typographie de votre marque. +## Styling + +Contrôlez l'identité visuelle et la palette de couleurs de votre site. + +- **Theme** : Choisissez un [thème](/fr/customize/themes) pour l'apparence globale de votre site. +- **Primary color** : La couleur d'accentuation principale utilisée pour les liens, boutons et éléments mis en évidence. +- **Light color** : Couleur d'accentuation utilisée en mode sombre. L'application dépend du thème. +- **Dark color** : Couleur d'accentuation utilisée en mode clair. L'application dépend du thème. +- **Background color** : Couleurs d'arrière-plan personnalisées pour les modes clair et sombre. +- **Icon library** : Bibliothèque d'icônes utilisée pour toutes les propriétés d'icône. Par défaut : `fontawesome`. +- **Strict appearance** : Verrouille le site sur un seul mode d'apparence et masque le sélecteur de thème. +- **Default appearance** : Indique si votre site se charge en mode `system`, `light` ou `dark` par défaut. +- **Background decoration** : Applique un style visuel (`gradient`, `grid` ou `windows`) à l'arrière-plan. +- **Background image** : Image d'arrière-plan optionnelle. Définissez une seule image ou des versions distinctes pour les modes clair et sombre. -* **Police par défaut** : Famille et graisse de police de base pour tout le texte. Indiquez une URL source et un format (WOFF ou WOFF2). -* **Police des titres** : Famille et graisse de police spécifiquement pour les titres (h1, h2, etc.). À configurer séparément du texte principal. -* **Police du texte principal** : Famille et graisse de police pour le corps du texte et les paragraphes. +## Typography -Pour chaque police, indiquez le nom de la famille, la graisse, l’URL source (comme Google Fonts) et le format. +Remplacez les polices par défaut par la typographie de votre marque. + +- **Font family** : Toute famille [Google Fonts](https://fonts.google.com/) fonctionne directement. Pour une police auto-hébergée, fournissez une URL source et un format (`woff` ou `woff2`). +- **Weight** : Généralement `400` pour la version normale et `700` pour la version grasse. Les polices variables prennent en charge des poids précis comme `550`. +- **Heading font** : Surcharge optionnelle appliquée à tous les en-têtes (`h1`–`h6`). +- **Body font** : Surcharge optionnelle appliquée au corps du texte et au reste de la page. -
- ## Configurer l'en-tête -
+## Navbar Ajoutez des éléments de navigation en haut de votre site. -* **Bouton de la barre de navigation** : Ajoutez un bouton d'appel à l'action principal dans l'en-tête. Configurez le type de bouton, son label et l'URL de destination. -* **Liens de la barre de navigation** : Ajoutez des liens de navigation supplémentaires dans l'en-tête. Chaque lien comporte un texte et une URL. +- **Primary button** : L'appel à l'action principal dans l'en-tête. Définissez le type, le label et l'URL de destination. +- **Navbar links** : Liens de navigation supplémentaires dans l'en-tête. Chaque lien comprend un texte et une URL. + +## Footer + +Ajoutez des liens et des réseaux sociaux au footer de votre site. + +- **Social links** : Profils sur des plateformes comme GitHub, X, LinkedIn, Discord, YouTube et Slack. +- **Footer columns** : Activez jusqu'à quatre colonnes avec des titres personnalisés pour organiser les liens du footer. + +## Banner + +Affichez une bannière d'annonce en haut de chaque page. + +- **Content** : Le texte de la bannière. Prend en charge le formatage MDX de base : liens, gras et italique. Les composants personnalisés ne sont pas pris en charge. +- **Dismissible** : Affiche un bouton de fermeture à droite de la bannière. +- **Type** : Style visuel. `info` utilise la couleur principale de la marque, `warning` un arrière-plan ambré, `critical` un arrière-plan rouge. Par défaut : `info`. +- **Color** : Remplace la couleur de fond par un hex personnalisé. Définissez des valeurs distinctes pour les modes clair et sombre. - +## Thumbnail -Ajoutez des liens et des comptes de réseaux sociaux au pied de page de votre site. +Personnalisez les vignettes de page et les aperçus pour les réseaux sociaux. -* **Liens vers les réseaux sociaux** : Ajoutez vos profils sur des plateformes comme GitHub, X (Twitter), LinkedIn, Discord, YouTube, Slack et bien plus encore. -* **Colonnes de pied de page** : Organisez les liens du pied de page en colonnes avec des titres personnalisés et des groupes de liens. +- **Background** : Image d'arrière-plan personnalisée pour les vignettes. +- **Appearance** : Rendu des vignettes en mode `light` ou `dark`. Si non défini, elles sont générées automatiquement à partir des couleurs du thème. +- **Font** : Police personnalisée pour le texte des vignettes. -
- ## Améliorer le contenu -
+## Content -Personnalisez la façon dont le contenu apparaît sur votre site. +Personnalisez l'affichage du contenu sur votre site. -* **Arrière-plan de vignette** : Définissez une image d’arrière-plan personnalisée pour les vignettes de page et les aperçus sur les réseaux sociaux. -* **Apparence des vignettes** : Contrôlez la façon dont les vignettes s’affichent. -* **Police des vignettes** : Définissez une police personnalisée pour le texte des vignettes. -* **Surtitre de page** : Ajoutez de petits labels au-dessus des titres de page. -* **Thème des blocs de code** : Choisissez le thème de coloration syntaxique pour les blocs de code. -* **Prise en charge de LaTeX** : Activez le rendu des notations mathématiques avec LaTeX. +- **Code block theme** : Suit le mode clair/sombre du site avec `system`, utilise toujours un thème sombre avec `dark`, ou choisissez un thème personnalisé [Shiki](https://shiki.style/). +- **Custom code languages** : Enregistrez des langages supplémentaires pour la coloration syntaxique. +- **Page eyebrow** : Affiche de petits labels au-dessus des titres de page. Choisissez `section` ou `breadcrumbs`. +- **Timestamps** : Affiche la date de la dernière modification sur toutes les pages. +- **LaTeX** : Charge la feuille de style LaTeX (KaTeX) pour le rendu de la notation mathématique. - +## Context menu -Personnalisez l'expérience de recherche. +Configurez les actions rapides du menu contextuel de la page. -* **Texte d’indication de recherche** : Le texte qui apparaît dans le champ de recherche avant que les utilisateurs ne saisissent quoi que ce soit. La valeur par défaut est « Search or ask... ». +- **Options** : Liste déroulante multi-sélection avec des actions comme `copy`, `view`, et ouvrir la page dans `chatgpt`, `claude`, `cursor` et autres assistants IA. +- **Display** : Où afficher les options. `header` (par défaut) les affiche dans le menu contextuel en haut de la page ; `toc` les affiche dans la barre latérale de la table des matières. -
- ## Connecter des intégrations -
+## Navigation -Connectez des outils tiers pour Analytics, l’assistance et la conformité. +Ajustez le comportement de la navigation. -
- ## Configurer les spécifications d’API -
+- **Drilldown** : Naviguer automatiquement vers la première page quand un utilisateur clique sur un groupe de navigation. -Ajoutez des fichiers de spécification [OpenAPI](/fr/api-playground/openapi-setup) ou [AsyncAPI](/fr/api-playground/asyncapi-setup) pour documenter les endpoints. +## Search -* **Spécifications OpenAPI** : Importez un fichier de spécification OpenAPI ou saisissez une URL vers un fichier OpenAPI externe. -* **Spécifications AsyncAPI** : Importez un fichier de spécification AsyncAPI ou saisissez une URL vers un fichier AsyncAPI externe. -* **Affichage du bac à sable d’API** : Choisissez d’afficher le bac à sable d’API interactif, un bac à sable d’API simple ou aucun bac à sable d’API. -* **Serveur proxy** : Activez ou désactivez le serveur proxy pour les requêtes d’API. +Personnalisez l'expérience de recherche et de feedback. -
- ## Gérer les redirections -
+- **Search placeholder** : Texte affiché dans la barre de recherche avant que l'utilisateur ne tape. Par défaut : `Search or ask`. +- **Feedback** : Affiche des boutons pouce levé/baissé ou un lien « Suggest edits » sur chaque page. -Utilisez la section **Redirects** pour ajouter, modifier, rechercher et supprimer des redirections sans avoir à modifier manuellement votre fichier `docs.json`. Les redirections envoient les utilisateurs depuis d'anciennes URL vers de nouvelles, ce qui est utile lorsque vous renommez des pages ou réorganisez votre documentation. Pour plus d'informations sur le comportement des redirections, consultez [Redirections](/fr/create/redirects). +## API reference + +Documentez les endpoints de votre API. + +- **OpenAPI specs** : Ajoutez des fichiers de spécification OpenAPI pour générer des pages de référence. +- **AsyncAPI specs** : Ajoutez des fichiers de spécification AsyncAPI pour générer des pages de référence. +- **MDX server** : Endpoints MDX server personnalisés pour le playground. +- **Playground display** : Affiche le playground interactif, le playground simple, ou aucun playground. +- **Proxy server** : Active ou désactive le serveur proxy pour les requêtes API. +- **`mdx.schema`** : Indique s'il faut afficher la section schema sur les pages de référence API. + +## Redirects + +Utilisez la section **Redirects** pour ajouter, modifier, rechercher et supprimer des redirections sans modifier manuellement votre `docs.json`. Pour plus d'informations, consultez [Redirections](/fr/create/redirects). Chaque redirection comporte les champs suivants : -- **Source** : Le chemin à rediriger, par exemple `/old-path`. Prend en charge les caractères génériques. -- **Destination** : Le chemin de destination, par exemple `/new-path`. -- **Status** : Le code d'état HTTP de la redirection. - - `308` : Redirection permanente. À utiliser pour le contenu qui a été déplacé définitivement. C'est le statut par défaut. - - `307` : Redirection temporaire. À utiliser lorsque le déplacement est temporaire. +- **Source** : Le chemin de redirection source, comme `/old-path`. Prend en charge les caractères génériques. +- **Destination** : Le chemin de destination, comme `/new-path`. Prend en charge les caractères génériques. +- **Status** : Code de statut HTTP. + - `308` : Redirection permanente. Valeur par défaut. + - `307` : Redirection temporaire. - Menu des redirections dans l'éditeur. - Menu des redirections dans l'éditeur. + Menu Redirects dans l’éditeur. + + Menu Redirects dans l’éditeur. Pour ajouter une redirection : + 1. Cliquez sur **Add redirect**. 2. Saisissez la source et la destination. 3. Cliquez sur **Save**. -Pour modifier ou supprimer une redirection existante : -1. Survolez la redirection. -2. Cliquez sur l'icône en forme de crayon pour la modifier ou sur l'icône de la corbeille pour la supprimer. +Pour modifier ou supprimer une redirection existante, survolez la ligne et utilisez l'icône d'édition inline ou la **X** pour la supprimer. + +## SEO + +Configurez les métatags et l'indexation pour les moteurs de recherche. + +- **Metatags** : Balises `` personnalisées appliquées à l'ensemble du site. Ajoutez des paires clé-valeur comme `og:image` ou `twitter:card`. +- **Indexing** : Choisissez d'indexer ou non les pages cachées. + +## Analytics + +Connectez des plateformes d'analytics pour suivre le comportement des visiteurs. Les fournisseurs pris en charge incluent Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit et d'autres. -
- ## Ajouter des Analytics et des intégrations -
+Chaque entrée s'affiche comme une ligne inline. Utilisez l'icône **X** pour supprimer une intégration. -Connectez des outils d'Analytics et des services tiers à votre documentation. +## 404 page -Suivez le comportement des visiteurs avec : +Personnalisez l'expérience lorsqu'un utilisateur arrive sur une page manquante. -* **Amplitude, Mixpanel, Heap** : plateformes d'analytics produit -* **Google Analytics, Google Tag Manager** : analytics web -* **PostHog, Plausible, Fathom** : analytics axés sur la confidentialité -* **Segment, Hightouch** : plateformes de données clients -* **Hotjar, LogRocket** : relecture de sessions et cartes de chaleur -* **Microsoft Clarity** : analytics de comportement utilisateur -* **Intercom** : messagerie client -* **Clearbit, Koala** : identification des visiteurs +- **Redirect to home** : Lorsqu'activé, les pages manquantes redirigent vers l'accueil. Sinon, une page 404 est affichée et vous pouvez en personnaliser le titre et la description. +- **Title** : Titre affiché sur la page 404. +- **Description** : Sous-titre affiché sur la page 404. -Intégrations supplémentaires : +## Variables -* **Telemetry** : activer ou désactiver la télémétrie d'utilisation -* **Cookies** : définir des paires clé/valeur de cookies personnalisées \ No newline at end of file +Définissez des variables personnalisées réutilisables dans tout votre contenu. Chaque variable est une paire clé-valeur. Utilisez l'icône **X** pour supprimer une variable. diff --git a/zh/editor/configurations.mdx b/zh/editor/configurations.mdx index d5ec7d656..0df2126bd 100644 --- a/zh/editor/configurations.mdx +++ b/zh/editor/configurations.mdx @@ -1,168 +1,177 @@ --- title: "配置" -description: "使用 Mintlify 网页编辑器侧边栏中的可视化配置表单编辑页面元数据、导航元素和媒体设置。" -keywords: ["editor", "configurations", "settings"] +description: "在 Mintlify Web 编辑器的 Configurations 面板中编辑站点品牌、外观、导航和功能设置，团队实时同步。" +keywords: ["editor", "configurations", "settings", "branding", "theme"] boost: 3 --- -在 Web 编辑器的 **Configurations** 面板中配置文档站点的品牌、外观和功能。 +在 Web 编辑器的 **Configurations** 面板中配置文档站点的品牌、外观和功能。配置更改会与同一分支上的其他编辑器实时同步。 - 浅色模式侧边栏中的 Configurations 设置。 + 编辑器中的 Configurations 菜单。 - 深色模式侧边栏中的 Configurations 设置。 + 编辑器中的 Configurations 菜单。 -
- ## 设置站点品牌 -
+该面板按照与 [`docs.json`](/zh/organize/settings) 顶级属性对应的章节组织。使用右侧的目录在章节之间跳转。 -设定站点的标识，以及它在访问者眼中的呈现方式。 +## General -* **文档标题 (Docs title) **：你的文档名称。会显示在浏览器标签页和搜索结果中。 -* **摘要 (Description) **：对文档的简要概述。用于 SEO (搜索引擎优化) 和站点 metadata。 -* **Favicon**：显示在浏览器标签页中的小图标。可上传 ICO、PNG、GIF 或 JPG 文件。 -* **Theme**：为文档的整体外观选择一个[主题](/zh/customize/themes)。 +设置站点的标识及其对访问者的展示方式。 -
- ## 自定义颜色和外观 -
+- **Name**：项目名称。显示在浏览器标签页和搜索结果中。 +- **Description**：项目简要概述。用于 SEO 和 AEO。 -控制你站点的视觉标识和配色方案。 +## Branding -* **主色**：站点中用于链接、按钮和高亮的主要强调色。 -* **浅色模式颜色**：浅色模式下的强调色变体。具体应用方式因主题而异。 -* **深色模式颜色**：深色模式下的强调色变体。具体应用方式因主题而异。 -* **Logo**：你的品牌 Logo。上传 PNG 或 JPG 文件。你可以为浅色和深色模式分别设置不同的 Logo。如需使用 SVG Logo，请通过 Git 将文件添加到你的仓库，并在 docs.json 配置中引用其路径。 -* **Logo 链接**：用户点击 Logo 时跳转到的位置。通常是你的首页或营销站点。 -* **背景颜色**：分别为浅色和深色模式设置自定义背景色。 -* **背景图片**：为站点添加背景图片。上传 PNG、GIF 或 JPG 文件。 -* **背景装饰**：为背景图片应用视觉效果。 -* **主题切换**：控制是否向用户显示浅色/深色模式切换开关。 -* **默认主题**：设置站点默认以浅色或深色模式加载。 +上传标识您站点的品牌资产。 -
- ## 设置自定义字体 -
+- **Logo**：品牌 logo。上传 PNG 或 JPG 文件。可分别设置浅色和深色版本，并可选填点击跳转 URL。要使用 SVG logo，将文件添加到您的仓库，并在 [`docs.json`](/zh/organize/settings-appearance#logos) 中引用其路径。 +- **Favicon**：浏览器标签中显示的小图标。上传 ICO、PNG、GIF 或 JPG 文件。如需可分别设置浅色和深色版本。 -将默认字体替换为你的品牌字体体系。 +## Styling -* **默认字体**：用于所有文本的基础字体系列和字重。提供一个来源 URL 和格式 (WOFF 或 WOFF2) 。 -* **标题字体**：专门用于标题 (h1、h2 等) 的字体系列和字重。与正文文本分开设置。 -* **正文字体**：用于正文文本和段落的字体系列和字重。 +控制站点的视觉风格和配色方案。 -对于每种字体，指定字体系列名称、字重、来源 URL (例如 Google Fonts) ，以及格式。 +- **Theme**：为站点选择整体外观[主题](/zh/customize/themes)。 +- **Primary color**：站点中链接、按钮和高亮元素使用的主强调色。 +- **Light color**：深色模式下使用的强调色。具体应用方式因主题而异。 +- **Dark color**：浅色模式下使用的强调色。具体应用方式因主题而异。 +- **Background color**：为浅色和深色模式分别设置自定义背景色。 +- **Icon library**：所有图标属性使用的图标库。默认为 `fontawesome`。 +- **Strict appearance**：将站点锁定为单一外观模式，并隐藏主题切换器。 +- **Default appearance**：站点默认以 `system`、`light` 还是 `dark` 模式加载。 +- **Background decoration**：为背景应用视觉样式（`gradient`、`grid` 或 `windows`）。 +- **Background image**：可选的背景图像。可设置单张图像，或为浅色和深色模式分别设置。 -
- ## 配置页眉 -
+## Typography + +用您品牌的字体替换默认字体。 + +- **Font family**：任意 [Google Fonts](https://fonts.google.com/) 家族开箱即用。要使用自托管字体，请提供源 URL 和格式（`woff` 或 `woff2`）。 +- **Weight**：通常 `400` 为常规，`700` 为粗体。可变字体支持像 `550` 这样的精确字重。 +- **Heading font**：应用于所有标题（`h1`–`h6`）的可选覆盖。 +- **Body font**：应用于正文及页面其余部分的可选覆盖。 + +## Navbar 在站点顶部添加导航元素。 -* **导航栏按钮**：在页眉中添加一个主要的行动号召按钮。设置按钮类型、标签和目标 URL。 -* **导航栏链接**：在页眉中添加额外的导航链接。每个链接都包含文本和一个 URL。 +- **Primary button**：标题栏中的主要号召性按钮。设置类型、label 和目标 URL。 +- **Navbar links**：标题栏中的其他导航链接。每个链接包含文本和 URL。 + +## Footer + +为站点 footer 添加链接和社交媒体账号。 + +- **Social links**：GitHub、X、LinkedIn、Discord、YouTube、Slack 等平台的个人资料。 +- **Footer columns**：启用最多四列带自定义标题的链接组。 + +## Banner + +在每个页面顶部显示公告栏。 + +- **Content**：横幅文字。支持基本 MDX 格式，如链接、加粗和斜体。不支持自定义组件。 +- **Dismissible**：在横幅右侧显示关闭按钮。 +- **Type**：视觉样式。`info` 使用主品牌色，`warning` 使用琥珀色背景，`critical` 使用红色背景。默认为 `info`。 +- **Color**：使用自定义十六进制颜色覆盖横幅背景色。可分别设置浅色和深色值。 + +## Thumbnail - +自定义页面缩略图和社交分享预览图。 -在站点页脚中添加链接和社交媒体账号。 +- **Background**：缩略图的自定义背景图。 +- **Appearance**：以 `light` 或 `dark` 模式渲染缩略图。未设置时根据主题色自动生成。 +- **Font**：缩略图文本使用的自定义字体。 -* **社交链接**：添加你在 GitHub、X (Twitter) 、LinkedIn、Discord、YouTube、Slack 等平台上的个人或组织主页。 -* **页脚列**：通过自定义标题和链接分组，将页脚链接组织成多列。 +## Content -
- ## 增强内容 -
+自定义站点中的内容显示方式。 -自定义你的网站上内容的呈现方式。 +- **Code block theme**：使用 `system` 跟随站点浅色/深色模式，使用 `dark` 始终使用深色主题，或选择自定义 [Shiki](https://shiki.style/) 主题。 +- **Custom code languages**：注册额外的语法高亮语言。 +- **Page eyebrow**：在页面标题上方显示小标签。可选 `section` 或 `breadcrumbs`。 +- **Timestamps**：在所有页面显示内容最后修改日期。 +- **LaTeX**：加载 LaTeX（KaTeX）样式表以渲染数学公式。 -* **缩略图背景**：为页面缩略图和社交分享预览设置自定义背景图片。 -* **缩略图外观**：控制缩略图的展示方式。 -* **缩略图字体**：为缩略图中的文本设置自定义字体。 -* **页面眉标题**：在页面标题上方添加小标签。 -* **代码块主题**：为代码块选择语法高亮主题。 -* **LaTeX 支持**：启用使用 LaTeX 渲染数学公式。 +## Context menu - +配置页面上下文菜单中的快捷操作。 -自定义搜索体验。 +- **Options**：多选下拉，包含 `copy`、`view`、以及在 `chatgpt`、`claude`、`cursor` 等 AI 助手中打开页面等操作。 +- **Display**：选项的显示位置。`header`（默认）在页面顶部的上下文菜单中显示；`toc` 在目录侧边栏中显示。 -* **搜索占位文本**：在用户输入之前显示在搜索框中的文本。默认值为“Search or ask...”。 +## Navigation -
- ## 连接集成 -
+调整全站的导航行为。 -连接第三方工具以实现分析、支持和合规等功能。 +- **Drilldown**：用户点击导航分组时，自动导航到第一个页面。 -
- ## 配置 API 规范 -
+## Search -添加 [OpenAPI](/zh/api-playground/openapi-setup) 或 [AsyncAPI](/zh/api-playground/asyncapi-setup) 规范文件来为 API 端点编写文档。 +自定义搜索体验和反馈。 -* **OpenAPI 规范**：上传 OpenAPI 规范文件，或输入指向外部 OpenAPI 文件的 URL。 -* **AsyncAPI 规范**：上传 AsyncAPI 规范文件，或输入指向外部 AsyncAPI 文件的 URL。 -* **操作台显示**：选择显示交互式 API 操作台、简易 API 操作台，或不显示 API 操作台。 -* **代理服务器**：为 API 请求启用或禁用代理服务器。 +- **Search placeholder**：用户输入前搜索框中显示的提示文本。默认为 `Search or ask`。 +- **Feedback**：在每个页面显示点赞/点踩按钮或「Suggest edits」链接。 -
- ## 管理重定向 -
+## API reference -使用 **Redirects** 部分可以添加、编辑、搜索和删除重定向，无需手动修改 `docs.json` 文件。重定向会将用户从旧 URL 导向新 URL，在你重命名页面或重构文档结构时非常有用。有关重定向行为的更多信息，请参阅 [重定向](/zh/create/redirects)。 +记录您的 API 端点。 -每条重定向包含以下字段： +- **OpenAPI specs**：添加 OpenAPI 规范文件以生成 API 参考页面。 +- **AsyncAPI specs**：添加 AsyncAPI 规范文件以生成 API 参考页面。 +- **MDX server**：API playground 的自定义 MDX server 端点。 +- **Playground display**：显示交互式 API playground、简单 API playground 或不显示。 +- **Proxy server**：启用或禁用 API 请求的代理服务器。 +- **`mdx.schema`**：是否在 API 参考页面上渲染 schema 部分。 -- **Source**: 要从其重定向的路径，例如 `/old-path`。支持通配符。 -- **Destination**: 要重定向到的路径，例如 `/new-path`。 -- **Status**: 重定向的 HTTP 状态码。 - - `308`: 永久重定向。用于已永久迁移的内容。这是默认状态。 - - `307`: 临时重定向。当迁移是临时的时使用。 +## Redirects + +使用 **Redirects** 部分来添加、编辑、搜索和删除重定向，无需手动编辑 `docs.json`。更多信息请参见[重定向](/zh/create/redirects)。 + +每个重定向包含以下字段： + +- **Source**：重定向源路径，例如 `/old-path`。支持通配符。 +- **Destination**：重定向目标路径，例如 `/new-path`。支持通配符。 +- **Status**：HTTP 状态码。 + - `308`：永久重定向。默认值。 + - `307`：临时重定向。 - 编辑器中的重定向菜单。 - 编辑器中的重定向菜单。 + 编辑器中的重定向菜单。 + + 编辑器中的重定向菜单。 添加重定向： -1. 点击 **Add redirect**。 -2. 输入源路径和目标路径。 -3. 点击 **Save**。 -编辑或删除现有重定向： -1. 将光标悬停在重定向上。 -2. 点击铅笔图标进行编辑，或点击垃圾桶图标进行删除。 +1. 单击 **Add redirect**。 +2. 输入源和目标。 +3. 单击 **Save**。 + +要编辑或删除现有重定向，将光标悬停在该行上，使用内联编辑图标或 **X** 删除。 + +## SEO + +为搜索引擎配置 metatags 和索引。 + +- **Metatags**：应用于整个站点的自定义 `` 标签。添加键值对，例如 `og:image` 或 `twitter:card`。 +- **Indexing**：选择是否索引隐藏页面。 + +## Analytics + +接入分析平台以跟踪访客行为。支持的提供商包括 Amplitude、Mixpanel、Heap、Google Analytics、Google Tag Manager、PostHog、Plausible、Fathom、Segment、Hightouch、Hotjar、LogRocket、Microsoft Clarity、Intercom、Clearbit 等。 -
- ## 添加分析和集成 -
+每个条目以内联行展示。使用 **X** 图标移除集成。 -将分析和第三方工具连接到你的文档站点。 +## 404 page -通过以下方式追踪访客行为： +自定义用户访问到不存在页面时的体验。 -* **Amplitude, Mixpanel, Heap**：产品分析平台 -* **Google Analytics, Google Tag Manager**：网站分析 -* **PostHog, Plausible, Fathom**：注重隐私的分析工具 -* **Segment, Hightouch**：客户数据平台 -* **Hotjar, LogRocket**：会话回放和热力图 -* **Microsoft Clarity**：用户行为分析 -* **Intercom**：客户沟通 -* **Clearbit, Koala**：访客识别 +- **Redirect to home**：开启时，缺失的页面会重定向到主页。关闭时显示 404 页面，并可自定义其标题和描述。 +- **Title**：404 页面显示的标题。 +- **Description**：404 页面显示的副标题。 -其他集成： +## Variables -* **Telemetry**：启用或禁用使用数据遥测 -* **Cookies**：设置自定义 cookie 的 key 和 value 键值对 \ No newline at end of file +定义可在内容中复用的自定义变量。每个变量是一个键值对。使用 **X** 图标移除变量。 From b7bc6434adfcd555bf528737715fbb3f64ddc3ea Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 26 May 2026 07:16:42 +0000 Subject: [PATCH 2/2] docs: tighten descriptions and add heading anchors for translations --- es/editor/configurations.mdx | 74 +++++++++++++++++++++++++++--------- fr/editor/configurations.mdx | 74 +++++++++++++++++++++++++++--------- zh/editor/configurations.mdx | 72 ++++++++++++++++++++++++++--------- 3 files changed, 164 insertions(+), 56 deletions(-) diff --git a/es/editor/configurations.mdx b/es/editor/configurations.mdx index 24c7cdb06..105646d45 100644 --- a/es/editor/configurations.mdx +++ b/es/editor/configurations.mdx @@ -1,6 +1,6 @@ --- title: "Configuraciones" -description: "Edita la marca, la apariencia, la navegación y las funcionalidades de tu sitio desde el panel Configurations del editor web de Mintlify, con sincronización en tiempo real." +description: "Edita la marca, la apariencia, la navegación y las funcionalidades desde el panel Configurations del editor web, con sincronización en tiempo real." keywords: ["editor", "configurations", "settings", "branding", "theme"] boost: 3 --- @@ -15,21 +15,27 @@ Configura la marca, la apariencia y las funcionalidades de tu sitio de documenta El panel está organizado en secciones que se corresponden con las propiedades de nivel superior de tu [`docs.json`](/es/organize/settings). Usa la tabla de contenido a la derecha para saltar entre secciones. -## General +
+ ## General +
Define la identidad de tu sitio y cómo aparece para los visitantes. - **Name**: El nombre de tu proyecto. Aparece en las pestañas del navegador y en los resultados de búsqueda. - **Description**: Resumen breve del proyecto. Se usa para SEO y AEO. -## Branding +
+ ## Branding +
Sube las marcas que identifican tu sitio. - **Logo**: El logo de tu marca. Sube archivos PNG o JPG. Define versiones claras y oscuras separadas y una URL opcional de destino. Para usar un logo SVG, añade el archivo a tu repositorio y referencia su ruta en tu [`docs.json`](/es/organize/settings-appearance#logos). - **Favicon**: Pequeño icono que aparece en las pestañas del navegador. Sube archivos ICO, PNG, GIF o JPG. Define versiones claras y oscuras separadas si es necesario. -## Styling +
+ ## Styling +
Controla la identidad visual y la paleta de colores de tu sitio. @@ -44,7 +50,9 @@ Controla la identidad visual y la paleta de colores de tu sitio. - **Background decoration**: Aplica un estilo visual (`gradient`, `grid` o `windows`) al fondo. - **Background image**: Imagen de fondo opcional. Configura una sola imagen o versiones separadas para modo claro y oscuro. -## Typography +
+ ## Typography +
Reemplaza las fuentes predeterminadas con la tipografía de tu marca. @@ -53,21 +61,27 @@ Reemplaza las fuentes predeterminadas con la tipografía de tu marca. - **Heading font**: Override opcional aplicado a todos los encabezados (`h1`–`h6`). - **Body font**: Override opcional aplicado al cuerpo de texto y al resto de la página. -## Navbar + Agrega elementos de navegación a la parte superior del sitio. - **Primary button**: La llamada a la acción principal del encabezado. Configura el tipo, el label y la URL de destino. - **Navbar links**: Enlaces de navegación adicionales del encabezado. Cada enlace incluye texto y una URL. -## Footer + Agrega enlaces y redes sociales al footer de tu sitio. - **Social links**: Perfiles en plataformas como GitHub, X, LinkedIn, Discord, YouTube y Slack. - **Footer columns**: Activa columnas (hasta cuatro) con títulos personalizados para organizar los enlaces del footer. -## Banner + Muestra un anuncio en la parte superior de cada página. @@ -76,7 +90,9 @@ Muestra un anuncio en la parte superior de cada página. - **Type**: Estilo visual. `info` usa el color principal de la marca, `warning` usa un fondo ámbar y `critical` usa un fondo rojo. Por defecto es `info`. - **Color**: Sobrescribe el color de fondo del banner con un hex personalizado. Define valores separados para claro y oscuro. -## Thumbnail +
+ ## Thumbnail +
Personaliza las miniaturas de página y las vistas previas en redes sociales. @@ -84,7 +100,9 @@ Personaliza las miniaturas de página y las vistas previas en redes sociales. - **Appearance**: Renderiza las miniaturas en modo `light` o `dark`. Si no se define, se generan automáticamente a partir de los colores del tema. - **Font**: Fuente personalizada para el texto de las miniaturas. -## Content +
+ ## Content +
Personaliza cómo se muestra el contenido en tu sitio. @@ -94,27 +112,35 @@ Personaliza cómo se muestra el contenido en tu sitio. - **Timestamps**: Muestra la fecha de la última modificación en todas las páginas. - **LaTeX**: Carga la hoja de estilos de LaTeX (KaTeX) para renderizar notación matemática. -## Context menu +
+ ## Context menu +
Configura las acciones rápidas del menú contextual de página. - **Options**: Desplegable multi-selección 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` (por defecto) las muestra en el menú contextual superior; `toc` las muestra en la barra lateral de la tabla de contenido. -## Navigation + Ajusta el comportamiento de la navegación. - **Drilldown**: Navega automáticamente a la primera página cuando un usuario hace clic en un grupo de navegación. -## Search + Personaliza la experiencia de búsqueda y feedback. - **Search placeholder**: Texto que aparece en el campo de búsqueda antes de escribir. Por defecto es `Search or ask`. - **Feedback**: Muestra botones de pulgar arriba/abajo o un enlace "Suggest edits" en cada página. -## API reference +
+ ## API reference +
Documenta los endpoints de tu API. @@ -125,7 +151,9 @@ Documenta los endpoints de tu API. - **Proxy server**: Activa o desactiva el servidor proxy para las solicitudes de la API. - **`mdx.schema`**: Renderiza la sección de schema en las páginas de referencia. -## Redirects +
+ ## Redirects +
Usa la sección **Redirects** para agregar, editar, buscar y eliminar redirecciones sin editar manualmente tu `docs.json`. Para más información, consulta [Redirecciones](/es/create/redirects). @@ -151,20 +179,26 @@ Para agregar una redirección: Para editar o eliminar una redirección, pasa el cursor por la fila y usa el icono de edición en línea o la **X** para eliminarla. -## SEO +
+ ## SEO +
Configura metatags e indexación para motores de búsqueda. - **Metatags**: Etiquetas `` personalizadas aplicadas en todo el sitio. Añade pares clave-valor como `og:image` o `twitter:card`. - **Indexing**: Elige si indexar las páginas ocultas. -## Analytics +
+ ## Analytics +
Conecta plataformas de analítica para hacer seguimiento del comportamiento de los visitantes. Los proveedores compatibles 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. Usa el icono **X** para eliminar una integración. -## 404 page +
+ ## 404 page +
Personaliza la experiencia cuando un usuario llega a una página inexistente. @@ -172,6 +206,8 @@ Personaliza la experiencia cuando un usuario llega a una página inexistente. - **Title**: Encabezado mostrado en la página 404. - **Description**: Subtítulo mostrado en la página 404. -## Variables +
+ ## Variables +
Define variables personalizadas que se pueden reutilizar en todo el contenido. Cada variable es un par clave-valor. Usa el icono **X** para eliminar una variable. diff --git a/fr/editor/configurations.mdx b/fr/editor/configurations.mdx index a87a74864..6fd0971d2 100644 --- a/fr/editor/configurations.mdx +++ b/fr/editor/configurations.mdx @@ -1,6 +1,6 @@ --- title: "Configurations" -description: "Modifiez l’image de marque, l’apparence, la navigation et les fonctionnalités de votre site depuis le panneau Configurations de l’éditeur web Mintlify, avec synchronisation en temps réel." +description: "Modifiez l'image de marque, l'apparence, la navigation et les fonctionnalités depuis le panneau Configurations de l'éditeur web, en temps réel." keywords: ["éditeur", "configurations", "paramètres", "branding", "theme"] boost: 3 --- @@ -15,21 +15,27 @@ Configurez l'image de marque, l'apparence et les fonctionnalités de votre site Le panneau est organisé en sections qui correspondent aux propriétés de premier niveau de votre [`docs.json`](/fr/organize/settings). Utilisez la table des matières à droite pour naviguer entre les sections. -## General +
+ ## General +
Définissez l'identité de votre site et la façon dont il apparaît aux visiteurs. - **Name** : Le nom de votre projet. Apparaît dans les onglets du navigateur et les résultats de recherche. - **Description** : Bref aperçu du projet. Utilisé pour le SEO et l'AEO. -## Branding +
+ ## Branding +
Téléversez les éléments qui identifient votre site. - **Logo** : Le logo de votre marque. Téléversez des fichiers PNG ou JPG. Définissez des versions claire et sombre distinctes et une URL de destination optionnelle. Pour utiliser un logo SVG, ajoutez le fichier à votre dépôt et référencez son chemin dans votre [`docs.json`](/fr/organize/settings-appearance#logos). - **Favicon** : Petite icône affichée dans les onglets du navigateur. Téléversez des fichiers ICO, PNG, GIF ou JPG. Définissez des versions claire et sombre si nécessaire. -## Styling +
+ ## Styling +
Contrôlez l'identité visuelle et la palette de couleurs de votre site. @@ -44,7 +50,9 @@ Contrôlez l'identité visuelle et la palette de couleurs de votre site. - **Background decoration** : Applique un style visuel (`gradient`, `grid` ou `windows`) à l'arrière-plan. - **Background image** : Image d'arrière-plan optionnelle. Définissez une seule image ou des versions distinctes pour les modes clair et sombre. -## Typography +
+ ## Typography +
Remplacez les polices par défaut par la typographie de votre marque. @@ -53,21 +61,27 @@ Remplacez les polices par défaut par la typographie de votre marque. - **Heading font** : Surcharge optionnelle appliquée à tous les en-têtes (`h1`–`h6`). - **Body font** : Surcharge optionnelle appliquée au corps du texte et au reste de la page. -## Navbar + Ajoutez des éléments de navigation en haut de votre site. - **Primary button** : L'appel à l'action principal dans l'en-tête. Définissez le type, le label et l'URL de destination. - **Navbar links** : Liens de navigation supplémentaires dans l'en-tête. Chaque lien comprend un texte et une URL. -## Footer + Ajoutez des liens et des réseaux sociaux au footer de votre site. - **Social links** : Profils sur des plateformes comme GitHub, X, LinkedIn, Discord, YouTube et Slack. - **Footer columns** : Activez jusqu'à quatre colonnes avec des titres personnalisés pour organiser les liens du footer. -## Banner + Affichez une bannière d'annonce en haut de chaque page. @@ -76,7 +90,9 @@ Affichez une bannière d'annonce en haut de chaque page. - **Type** : Style visuel. `info` utilise la couleur principale de la marque, `warning` un arrière-plan ambré, `critical` un arrière-plan rouge. Par défaut : `info`. - **Color** : Remplace la couleur de fond par un hex personnalisé. Définissez des valeurs distinctes pour les modes clair et sombre. -## Thumbnail +
+ ## Thumbnail +
Personnalisez les vignettes de page et les aperçus pour les réseaux sociaux. @@ -84,7 +100,9 @@ Personnalisez les vignettes de page et les aperçus pour les réseaux sociaux. - **Appearance** : Rendu des vignettes en mode `light` ou `dark`. Si non défini, elles sont générées automatiquement à partir des couleurs du thème. - **Font** : Police personnalisée pour le texte des vignettes. -## Content +
+ ## Content +
Personnalisez l'affichage du contenu sur votre site. @@ -94,27 +112,35 @@ Personnalisez l'affichage du contenu sur votre site. - **Timestamps** : Affiche la date de la dernière modification sur toutes les pages. - **LaTeX** : Charge la feuille de style LaTeX (KaTeX) pour le rendu de la notation mathématique. -## Context menu +
+ ## Context menu +
Configurez les actions rapides du menu contextuel de la page. - **Options** : Liste déroulante multi-sélection avec des actions comme `copy`, `view`, et ouvrir la page dans `chatgpt`, `claude`, `cursor` et autres assistants IA. - **Display** : Où afficher les options. `header` (par défaut) les affiche dans le menu contextuel en haut de la page ; `toc` les affiche dans la barre latérale de la table des matières. -## Navigation + Ajustez le comportement de la navigation. - **Drilldown** : Naviguer automatiquement vers la première page quand un utilisateur clique sur un groupe de navigation. -## Search + Personnalisez l'expérience de recherche et de feedback. - **Search placeholder** : Texte affiché dans la barre de recherche avant que l'utilisateur ne tape. Par défaut : `Search or ask`. - **Feedback** : Affiche des boutons pouce levé/baissé ou un lien « Suggest edits » sur chaque page. -## API reference +
+ ## API reference +
Documentez les endpoints de votre API. @@ -125,7 +151,9 @@ Documentez les endpoints de votre API. - **Proxy server** : Active ou désactive le serveur proxy pour les requêtes API. - **`mdx.schema`** : Indique s'il faut afficher la section schema sur les pages de référence API. -## Redirects +
+ ## Redirects +
Utilisez la section **Redirects** pour ajouter, modifier, rechercher et supprimer des redirections sans modifier manuellement votre `docs.json`. Pour plus d'informations, consultez [Redirections](/fr/create/redirects). @@ -151,20 +179,26 @@ Pour ajouter une redirection : Pour modifier ou supprimer une redirection existante, survolez la ligne et utilisez l'icône d'édition inline ou la **X** pour la supprimer. -## SEO +
+ ## SEO +
Configurez les métatags et l'indexation pour les moteurs de recherche. - **Metatags** : Balises `` personnalisées appliquées à l'ensemble du site. Ajoutez des paires clé-valeur comme `og:image` ou `twitter:card`. - **Indexing** : Choisissez d'indexer ou non les pages cachées. -## Analytics +
+ ## Analytics +
Connectez des plateformes d'analytics pour suivre le comportement des visiteurs. Les fournisseurs pris en charge incluent Amplitude, Mixpanel, Heap, Google Analytics, Google Tag Manager, PostHog, Plausible, Fathom, Segment, Hightouch, Hotjar, LogRocket, Microsoft Clarity, Intercom, Clearbit et d'autres. Chaque entrée s'affiche comme une ligne inline. Utilisez l'icône **X** pour supprimer une intégration. -## 404 page +
+ ## 404 page +
Personnalisez l'expérience lorsqu'un utilisateur arrive sur une page manquante. @@ -172,6 +206,8 @@ Personnalisez l'expérience lorsqu'un utilisateur arrive sur une page manquante. - **Title** : Titre affiché sur la page 404. - **Description** : Sous-titre affiché sur la page 404. -## Variables +
+ ## Variables +
Définissez des variables personnalisées réutilisables dans tout votre contenu. Chaque variable est une paire clé-valeur. Utilisez l'icône **X** pour supprimer une variable. diff --git a/zh/editor/configurations.mdx b/zh/editor/configurations.mdx index 0df2126bd..49f53e375 100644 --- a/zh/editor/configurations.mdx +++ b/zh/editor/configurations.mdx @@ -15,21 +15,27 @@ boost: 3 该面板按照与 [`docs.json`](/zh/organize/settings) 顶级属性对应的章节组织。使用右侧的目录在章节之间跳转。 -## General +
+ ## General +
设置站点的标识及其对访问者的展示方式。 - **Name**：项目名称。显示在浏览器标签页和搜索结果中。 - **Description**：项目简要概述。用于 SEO 和 AEO。 -## Branding +
+ ## Branding +
上传标识您站点的品牌资产。 - **Logo**：品牌 logo。上传 PNG 或 JPG 文件。可分别设置浅色和深色版本，并可选填点击跳转 URL。要使用 SVG logo，将文件添加到您的仓库，并在 [`docs.json`](/zh/organize/settings-appearance#logos) 中引用其路径。 - **Favicon**：浏览器标签中显示的小图标。上传 ICO、PNG、GIF 或 JPG 文件。如需可分别设置浅色和深色版本。 -## Styling +
+ ## Styling +
控制站点的视觉风格和配色方案。 @@ -44,7 +50,9 @@ boost: 3 - **Background decoration**：为背景应用视觉样式（`gradient`、`grid` 或 `windows`）。 - **Background image**：可选的背景图像。可设置单张图像，或为浅色和深色模式分别设置。 -## Typography +
+ ## Typography +
用您品牌的字体替换默认字体。 @@ -53,21 +61,27 @@ boost: 3 - **Heading font**：应用于所有标题（`h1`–`h6`）的可选覆盖。 - **Body font**：应用于正文及页面其余部分的可选覆盖。 -## Navbar + 在站点顶部添加导航元素。 - **Primary button**：标题栏中的主要号召性按钮。设置类型、label 和目标 URL。 - **Navbar links**：标题栏中的其他导航链接。每个链接包含文本和 URL。 -## Footer + 为站点 footer 添加链接和社交媒体账号。 - **Social links**：GitHub、X、LinkedIn、Discord、YouTube、Slack 等平台的个人资料。 - **Footer columns**：启用最多四列带自定义标题的链接组。 -## Banner + 在每个页面顶部显示公告栏。 @@ -76,7 +90,9 @@ boost: 3 - **Type**：视觉样式。`info` 使用主品牌色，`warning` 使用琥珀色背景，`critical` 使用红色背景。默认为 `info`。 - **Color**：使用自定义十六进制颜色覆盖横幅背景色。可分别设置浅色和深色值。 -## Thumbnail +
+ ## Thumbnail +
自定义页面缩略图和社交分享预览图。 @@ -84,7 +100,9 @@ boost: 3 - **Appearance**：以 `light` 或 `dark` 模式渲染缩略图。未设置时根据主题色自动生成。 - **Font**：缩略图文本使用的自定义字体。 -## Content +
+ ## Content +
自定义站点中的内容显示方式。 @@ -94,27 +112,35 @@ boost: 3 - **Timestamps**：在所有页面显示内容最后修改日期。 - **LaTeX**：加载 LaTeX（KaTeX）样式表以渲染数学公式。 -## Context menu +
+ ## Context menu +
配置页面上下文菜单中的快捷操作。 - **Options**：多选下拉，包含 `copy`、`view`、以及在 `chatgpt`、`claude`、`cursor` 等 AI 助手中打开页面等操作。 - **Display**：选项的显示位置。`header`（默认）在页面顶部的上下文菜单中显示；`toc` 在目录侧边栏中显示。 -## Navigation + 调整全站的导航行为。 - **Drilldown**：用户点击导航分组时，自动导航到第一个页面。 -## Search + 自定义搜索体验和反馈。 - **Search placeholder**：用户输入前搜索框中显示的提示文本。默认为 `Search or ask`。 - **Feedback**：在每个页面显示点赞/点踩按钮或「Suggest edits」链接。 -## API reference +
+ ## API reference +
记录您的 API 端点。 @@ -125,7 +151,9 @@ boost: 3 - **Proxy server**：启用或禁用 API 请求的代理服务器。 - **`mdx.schema`**：是否在 API 参考页面上渲染 schema 部分。 -## Redirects +
+ ## Redirects +
使用 **Redirects** 部分来添加、编辑、搜索和删除重定向，无需手动编辑 `docs.json`。更多信息请参见[重定向](/zh/create/redirects)。 @@ -151,20 +179,26 @@ boost: 3 要编辑或删除现有重定向，将光标悬停在该行上，使用内联编辑图标或 **X** 删除。 -## SEO +
+ ## SEO +
为搜索引擎配置 metatags 和索引。 - **Metatags**：应用于整个站点的自定义 `` 标签。添加键值对，例如 `og:image` 或 `twitter:card`。 - **Indexing**：选择是否索引隐藏页面。 -## Analytics +
+ ## Analytics +
接入分析平台以跟踪访客行为。支持的提供商包括 Amplitude、Mixpanel、Heap、Google Analytics、Google Tag Manager、PostHog、Plausible、Fathom、Segment、Hightouch、Hotjar、LogRocket、Microsoft Clarity、Intercom、Clearbit 等。 每个条目以内联行展示。使用 **X** 图标移除集成。 -## 404 page +
+ ## 404 page +
自定义用户访问到不存在页面时的体验。 @@ -172,6 +206,8 @@ boost: 3 - **Title**：404 页面显示的标题。 - **Description**：404 页面显示的副标题。 -## Variables +
+ ## Variables +
定义可在内容中复用的自定义变量。每个变量是一个键值对。使用 **X** 图标移除变量。