diff --git a/es/deploy/vercel.mdx b/es/deploy/vercel.mdx index 243cd200a..0dc72b886 100644 --- a/es/deploy/vercel.mdx +++ b/es/deploy/vercel.mdx @@ -10,53 +10,64 @@ import { VercelJsonGenerator } from "/snippets/es/vercel-json-generator.mdx"; ## Archivo vercel.json -El archivo `vercel.json` define cómo se compila y se implementa tu proyecto. Se encuentra en el directorio raíz y controla varios aspectos de la implementación, incluidos el enrutamiento, las redirecciones, los encabezados y la configuración de compilación. +El archivo `vercel.json` configura cómo se compila e implementa tu proyecto. Se encuentra en el directorio raíz de tu proyecto y controla varios aspectos de la implementación, incluidos el enrutamiento, las redirecciones, los encabezados y los ajustes de compilación. -Usamos la opción `rewrites` para enrutar mediante proxy las solicitudes desde tu dominio principal hacia tu documentación. +Usamos la configuración de `rewrites` para enrutar mediante proxy las solicitudes desde tu domain principal hacia tu documentación. -Los `rewrites` reasignan las solicitudes entrantes a distintos destinos sin cambiar la URL en el navegador. Cuando alguien visita `yoursite.com/docs`, Vercel obtendrá internamente el contenido de `your-subdomain.mintlify.dev/docs`, pero el usuario seguirá viendo `yoursite.com/docs` en su navegador. Esto es diferente de las redirecciones, que enviarían a los usuarios a una URL completamente distinta. +Los rewrites asignan las solicitudes entrantes a distintos destinos sin cambiar la URL en el navegador. Cuando alguien visita `yoursite.com/docs`, Vercel obtiene internamente el contenido de `your-subdomain.mintlify.dev/docs`, pero el usuario sigue viendo `yoursite.com/docs` en su navegador. Esto es diferente de las redirecciones, que envían a los usuarios a otra URL por completo. -Puedes personalizar la subruta con el valor que prefieras, como `/docs`, `/help` o `/guides`. Además, puedes usar subrutas profundamente anidadas, como `/product/docs`. - -
- ## Estructura del repositorio -
- -Tus archivos de documentación deben organizarse dentro de tu repositorio para que coincidan con la estructura de subruta que elijas. Por ejemplo, si quieres que tu documentación esté en `yoursite.com/docs`, deberías crear un directorio `docs/` con todos tus archivos de documentación. +Puedes personalizar la subruta con cualquier valor que prefieras, como `/docs`, `/help` o `/guides`. Además, puedes usar subrutas anidadas en varios niveles, como `/product/docs`.
## Configuración
-Para alojar tu documentación en una subruta personalizada con Vercel, añade la siguiente configuración a tu archivo `vercel.json`. Este ejemplo usa `/docs`, pero puedes reemplazarlo por cualquier subruta: +
+ ### Alojar desde `/docs` +
+ +1. Ve a [Configuración de dominio personalizado](https://dashboard.mintlify.com/settings/deployment/custom-domain) en tu dashboard. +2. Activa el interruptor **Host at `/docs`**. + + + Captura de pantalla de la página de Configuración de dominio personalizado. El interruptor Host at `/docs` está activado y resaltado por un rectángulo naranja. + + Captura de pantalla de la página de Configuración de dominio personalizado. El interruptor Host at `/docs` está activado y resaltado por un rectángulo naranja. + + +3. Ingresa tu domain. +4. Selecciona **Add domain**. +5. Agrega las siguientes reglas de reescritura a tu archivo `vercel.json`. Reemplaza `[subdomain]` con tu subdomain: ```json -{ - "rewrites": [ - { - "source": "/docs", - "destination": "https://[subdomain].mintlify.dev/docs" - }, - { - "source": "/docs/:match*", - "destination": "https://[subdomain].mintlify.dev/docs/:match*" - } - ] -} + { + "rewrites": [ + { + "source": "/docs", + "destination": "https://[subdomain].mintlify.dev/docs" + }, + { + "source": "/docs/:match*", + "destination": "https://[subdomain].mintlify.dev/docs/:match*" + } + ] + } ``` * **`source`**: El patrón de ruta en tu domain que activa la reescritura. -* **`destination`**: El destino al que se debe enviar la solicitud mediante proxy. +* **`destination`**: El destino al que se debe enrutar la solicitud mediante proxy. * **`:match*`**: Un comodín que captura cualquier segmento de ruta después de tu subruta. Para obtener más información, consulta [Configuring projects with vercel.json: Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites) en la documentación de Vercel. -
- ### Generar redirecciones +
+ ### Hospedar desde una ruta personalizada
-Ingresa tu subdomain y subdirectorio personalizado para generar las redirecciones para tu archivo `vercel.json`. +Para usar una subruta personalizada (cualquier ruta distinta de `/docs`), debes organizar los archivos de tu documentación dentro de tu repositorio para que coincidan con la estructura de esa subruta. Por ejemplo, si tu documentación se hospeda en `yoursite.com/help`, los archivos de la documentación deben estar en el directorio `help/`. + +Usa el generador a continuación para crear la configuración de rewrites. Agrega los rewrites a tu archivo `vercel.json`. diff --git a/es/organize/settings.mdx b/es/organize/settings.mdx index ed4fd804b..f12c9dbfb 100644 --- a/es/organize/settings.mdx +++ b/es/organize/settings.mdx @@ -135,24 +135,24 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - El estilo del “eyebrow” de la página. Elige `section` para mostrar el nombre de la sección o `breadcrumbs` para mostrar la ruta completa de navegación. De forma predeterminada es `section`. + Estilo del eyebrow de la página. Elige `section` para mostrar el nombre de la sección o `breadcrumbs` para mostrar la ruta completa de navegación. De forma predeterminada es `section`. - Configuración del tema de los bloques de código. De forma predeterminada es `"system"`. + Configuración del tema de los bloques de código. El valor predeterminado es `"system"`. **Configuración simple:** - * `"system"`: Coincidir con el modo actual del sitio (claro u oscuro) - * `"dark"`: Usar siempre el modo oscuro + * `"system"`: Coincide con el modo actual del sitio (claro u oscuro) + * `"dark"`: Usa siempre el modo oscuro **Configuración de tema personalizada:** * Usa una cadena para especificar un único [tema de Shiki](https://shiki.style/themes) para todos los bloques de código - * Usa un objeto para especificar [temas de Shiki](https://shiki.style/themes) separados para los modos claro y oscuro + * Usa un objeto para especificar [temas de Shiki](https://shiki.style/themes) distintos para los modos claro y oscuro - Un único nombre de tema de Shiki para usar tanto en modo claro como oscuro. + Un único nombre de tema de Shiki para usar en ambos modos, claro y oscuro. ```json "styling": { @@ -196,7 +196,7 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Biblioteca de iconos para usar en toda tu documentación. De forma predeterminada es `fontawesome`. + Biblioteca de iconos que se usará en toda tu documentación. De forma predeterminada es `fontawesome`. Puedes especificar una URL a un icono alojado externamente, la ruta a un archivo de icono en tu proyecto o código SVG compatible con JSX para cualquier icono individual, independientemente de la configuración de la biblioteca. @@ -206,81 +206,37 @@ Esta sección contiene la referencia completa del archivo `docs.json`. - Configuración tipográfica para tu documentación. La fuente predeterminada es [Inter](https://fonts.google.com/specimen/Inter). + Configuración de fuentes para los encabezados de tu documentación. La fuente predeterminada varía según el tema. - + - Familia tipográfica, por ejemplo, "Open Sans". + Familia tipográfica, como "Open Sans". - Peso tipográfico, como 400 o 700. Las fuentes variables admiten pesos precisos como 550. + Peso de la fuente, como 400 o 700. Las fuentes variables admiten pesos precisos como 550. - URL del archivo de tu fuente, por ejemplo, https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) se cargan automáticamente cuando especificas un nombre de `family` de Google Fonts, por lo que no se necesita una URL de fuente. + URL al origen de tu fuente, como https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) se carga automáticamente cuando especificas un nombre de `family` de Google Fonts, por lo que no se necesita una URL de origen. Formato del archivo de fuente. - - - Sobrescribe la configuración de la fuente específicamente para los encabezados. - - - - Familia tipográfica, por ejemplo, "Open Sans", "Playfair Display". - - - - Peso tipográfico, como 400 o 700. Las fuentes variables admiten pesos precisos como 550. - - - - URL del archivo de tu fuente, por ejemplo, https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) se cargan automáticamente cuando especificas un nombre de `family` de Google Fonts, por lo que no se necesita una URL de fuente. - - - - Formato del archivo de fuente. - - - - - - Sobrescribe la configuración de la fuente específicamente para el cuerpo del texto. - - - - Familia tipográfica, por ejemplo, "Open Sans", "Playfair Display". - - - - Peso tipográfico, como 400 o 700. Las fuentes variables admiten pesos precisos como 550. - - - - URL del archivo de tu fuente, por ejemplo, https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) se cargan automáticamente cuando especificas un nombre de `family` de Google Fonts, por lo que no se necesita una URL de fuente. - - - - Formato del archivo de fuente. - - - Configuración del conmutador de modo claro/oscuro. - + - Modo de tema predeterminado. Elige `system` para ajustarlo a la configuración del sistema operativo del usuario, o `light` o `dark` para forzar un modo específico. De manera predeterminada es `system`. + Modo de tema predeterminado. Elige `system` para coincidir con la configuración del SO de los usuarios, o `light` o `dark` para forzar un modo específico. El valor predeterminado es `system`. - Indica si se debe ocultar el conmutador de modo claro/oscuro. De manera predeterminada es `true`. + Si se oculta el conmutador de modo claro/oscuro. El valor predeterminado es `true`. diff --git a/fr/deploy/vercel.mdx b/fr/deploy/vercel.mdx index 85bca1169..53b5cfb0d 100644 --- a/fr/deploy/vercel.mdx +++ b/fr/deploy/vercel.mdx @@ -10,53 +10,64 @@ import { VercelJsonGenerator } from "/snippets/fr/vercel-json-generator.mdx"; ## Fichier vercel.json
-Le fichier `vercel.json` définit la manière dont votre projet est construit et déployé. Il se trouve à la racine de votre projet et contrôle divers aspects de votre déploiement, notamment le routage, les redirections, les en-têtes et les paramètres de build. +Le fichier `vercel.json` définit la façon dont votre projet est construit et déployé. Il se trouve à la racine de votre projet et contrôle divers aspects du déploiement, notamment le routage, les redirections, les en-têtes et les paramètres de build. -Nous utilisons la configuration `rewrites` pour faire transiter (proxy) les requêtes de votre domaine principal vers votre documentation. +Nous utilisons la configuration `rewrites` pour mettre en proxy les requêtes depuis votre domaine principal vers votre documentation. -Les réécritures redirigent les requêtes entrantes vers d’autres destinations sans modifier l’URL affichée dans le navigateur. Lorsque quelqu’un visite `yoursite.com/docs`, Vercel récupère en interne le contenu depuis `your-subdomain.mintlify.dev/docs`, mais l’utilisateur voit toujours `yoursite.com/docs` dans son navigateur. Cela diffère des redirections, qui enverraient les utilisateurs vers une autre URL. +Les réécritures font pointer les requêtes entrantes vers d’autres destinations sans changer l’URL dans le navigateur. Lorsque quelqu’un visite `yoursite.com/docs`, Vercel récupère en interne le contenu depuis `your-subdomain.mintlify.dev/docs`, mais l’utilisateur voit toujours `yoursite.com/docs` dans son navigateur. Cela diffère des redirections, qui envoient les utilisateurs vers une autre URL. -Vous pouvez personnaliser le sous-chemin avec la valeur de votre choix, comme `/docs`, `/help` ou `/guides`. Vous pouvez également utiliser des sous-chemins profondément imbriqués comme `/product/docs`. - -
- ## Structure du référentiel -
- -Vos fichiers de documentation doivent être organisés dans votre référentiel afin de correspondre à la structure de sous-chemin que vous avez choisie. Par exemple, si vous souhaitez que votre documentation se trouve à `yoursite.com/docs`, vous devez créer un répertoire `docs/` contenant tous vos fichiers de documentation. +Vous pouvez personnaliser le sous-chemin avec n’importe quelle valeur, comme `/docs`, `/help` ou `/guides`. Vous pouvez également utiliser des sous-chemins profondément imbriqués comme `/product/docs`.
## Configuration
-Pour héberger votre documentation à un sous-chemin personnalisé avec Vercel, ajoutez la configuration suivante à votre fichier `vercel.json`. Cet exemple utilise `/docs`, mais vous pouvez le remplacer par n’importe quel sous-chemin : +
+ ### Héberger depuis `/docs` +
+ +1. Accédez à la [configuration du domaine personnalisé](https://dashboard.mintlify.com/settings/deployment/custom-domain) dans votre Dashboard. +2. Activez l’option **Héberger à `/docs`**. + + + Capture d’écran de la page de configuration du domaine personnalisé. L’option « Héberger à `/docs` » est activée et mise en évidence par un rectangle orange. + + Capture d’écran de la page de configuration du domaine personnalisé. L’option « Héberger à `/docs` » est activée et mise en évidence par un rectangle orange. + + +3. Renseignez votre domain. +4. Sélectionnez **Ajouter un domain**. +5. Ajoutez les réécritures suivantes à votre fichier `vercel.json`. Remplacez `[subdomain]` par votre sous-domaine : ```json -{ - "rewrites": [ - { - "source": "/docs", - "destination": "https://[subdomain].mintlify.dev/docs" - }, - { - "source": "/docs/:match*", - "destination": "https://[subdomain].mintlify.dev/docs/:match*" - } - ] -} + { + "rewrites": [ + { + "source": "/docs", + "destination": "https://[subdomain].mintlify.dev/docs" + }, + { + "source": "/docs/:match*", + "destination": "https://[subdomain].mintlify.dev/docs/:match*" + } + ] + } ``` * **`source`**: Le modèle de chemin sur votre domain qui déclenche la réécriture. -* **`destination`**: La destination vers laquelle la requête doit être mise en proxy. +* **`destination`**: La cible vers laquelle la requête doit être mise en proxy. * **`:match*`**: Un caractère générique qui capture tous les segments de chemin après votre sous-chemin. Pour en savoir plus, consultez [Configuring projects with vercel.json: Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites) dans la documentation Vercel. -
- ### Générer des règles de réécriture +
+ ### Héberger depuis un chemin personnalisé
-Saisissez votre sous-domaine et votre sous-répertoire personnalisé pour générer les règles de réécriture de votre fichier `vercel.json`. +Pour utiliser un sous-chemin personnalisé (tout chemin autre que `/docs`), vous devez organiser vos fichiers de documentation dans votre référentiel pour qu’ils correspondent à la structure de ce sous-chemin. Par exemple, si votre documentation est hébergée à `yoursite.com/help`, vos fichiers de documentation doivent se trouver dans un répertoire `help/`. + +Utilisez le générateur ci-dessous pour créer votre configuration de réécriture. Ajoutez les règles de réécriture à votre fichier `vercel.json`. diff --git a/fr/organize/settings.mdx b/fr/organize/settings.mdx index ab3832931..43ea1f09a 100644 --- a/fr/organize/settings.mdx +++ b/fr/organize/settings.mdx @@ -135,7 +135,7 @@ Cette section présente la référence complète du fichier `docs.json`. - Le style de l’« eyebrow » de la page. Choisissez `section` pour afficher le nom de la section ou `breadcrumbs` pour afficher le chemin de navigation complet. Par défaut : `section`. + Le style de l’eyebrow de la page. Choisissez `section` pour afficher le nom de la section ou `breadcrumbs` pour afficher le chemin de navigation complet. Par défaut : `section`. @@ -143,16 +143,16 @@ Cette section présente la référence complète du fichier `docs.json`. **Configuration simple :** - * `"system"` : correspond au mode actuel du site (clair ou sombre) - * `"dark"` : utilise toujours le mode sombre + * `"system"` : Faire correspondre le mode actuel du site (clair ou sombre) + * `"dark"` : Toujours utiliser le mode sombre **Configuration de thème personnalisée :** - * Utilisez une chaîne pour spécifier un [thème Shiki](https://shiki.style/themes) unique pour tous les code blocks + * Utilisez une chaîne pour spécifier un seul [thème Shiki](https://shiki.style/themes) pour tous les code blocks * Utilisez un objet pour spécifier des [thèmes Shiki](https://shiki.style/themes) distincts pour les modes clair et sombre - Un nom de thème Shiki unique à utiliser pour les modes clair et sombre. + Un seul nom de thème Shiki à utiliser pour les modes clair et sombre. ```json "styling": { @@ -168,11 +168,11 @@ Cette section présente la référence complète du fichier `docs.json`. - Un nom de thème Shiki pour le mode clair. + Nom de thème Shiki pour le mode clair. - Un nom de thème Shiki pour le mode sombre. + Nom de thème Shiki pour le mode sombre. ```json @@ -199,88 +199,44 @@ Cette section présente la référence complète du fichier `docs.json`. Bibliothèque d’icônes à utiliser dans toute votre documentation. Par défaut : `fontawesome`. - Vous pouvez spécifier une URL vers une icône hébergée en externe, un chemin vers un fichier d’icône dans votre projet, ou du code SVG compatible JSX pour n’importe quelle icône individuelle, quelle que soit la configuration de la bibliothèque. + Vous pouvez spécifier une URL vers une icône hébergée en externe, un chemin vers un fichier d’icône dans votre projet, ou du code SVG compatible JSX pour n’importe quelle icône individuelle, quel que soit le paramètre de bibliothèque. - Configuration des polices pour votre documentation. La police par défaut est [Inter](https://fonts.google.com/specimen/Inter). + Configuration des polices pour les titres de votre documentation. La police par défaut varie selon le thème. - Famille de polices, par exemple « Open Sans ». + Famille de polices, par exemple « Open Sans ». - Graisse (épaisseur) de la police, par exemple 400 ou 700. Les polices variables prennent en charge des valeurs précises comme 550. + Graisse de police, par exemple 400 ou 700. Les polices variables prennent en charge des graisses précises comme 550. - URL de la source de votre police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) est chargé automatiquement lorsque vous indiquez un nom de `family` Google Font, donc aucune URL source n’est nécessaire. + URL de la source de la police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. Les [Google Fonts](https://fonts.google.com) sont chargées automatiquement lorsque vous indiquez un nom de `family` Google Font, aucune URL source n’est donc nécessaire. Format du fichier de police. - - - Remplacer les paramètres de police spécifiquement pour les titres. - - - - Famille de polices, par exemple « Open Sans », « Playfair Display ». - - - - Graisse (épaisseur) de la police, par exemple 400 ou 700. Les polices variables prennent en charge des valeurs précises comme 550. - - - - URL de la source de votre police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) est chargé automatiquement lorsque vous indiquez un nom de `family` Google Font, donc aucune URL source n’est nécessaire. - - - - Format du fichier de police. - - - - - - Remplacer les paramètres de police spécifiquement pour le corps du texte. - - - - Famille de polices, par exemple « Open Sans », « Playfair Display ». - - - - Graisse (épaisseur) de la police, par exemple 400 ou 700. Les polices variables prennent en charge des valeurs précises comme 550. - - - - URL de la source de votre police, par exemple https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) est chargé automatiquement lorsque vous indiquez un nom de `family` Google Font, donc aucune URL source n’est nécessaire. - - - - Format du fichier de police. - - - - Paramètres du bouton de bascule mode clair/sombre. + Paramètres de commutateur pour le mode clair/sombre. - Mode de thème par défaut. Choisissez `system` pour correspondre aux réglages du système d’exploitation des utilisateurs, ou `light` ou `dark` pour imposer un mode spécifique. Par défaut : `system`. + Mode de thème par défaut. Choisissez `system` pour correspondre aux réglages de l’OS des utilisateurs, ou `light`/`dark` pour imposer un mode spécifique. Par défaut : `system`. - Indique s’il faut masquer le bouton de bascule clair/sombre. Par défaut : `true`. + Indique s’il faut masquer le commutateur de mode clair/sombre. Par défaut : `true`. diff --git a/snippets/es/vercel-json-generator.mdx b/snippets/es/vercel-json-generator.mdx index ea6cea794..f0c3aae49 100644 --- a/snippets/es/vercel-json-generator.mdx +++ b/snippets/es/vercel-json-generator.mdx @@ -1,6 +1,6 @@ export const VercelJsonGenerator = () => { const [subdomain, setSubdomain] = useState('[SUBDOMAIN]') - const [subdirectory, setSubdirectory] = useState('docs') + const [subpath, setSubpath] = useState('[SUBPATH]') const vercelConfig = { rewrites: [ @@ -13,28 +13,28 @@ export const VercelJsonGenerator = () => { destination: `https://${subdomain}.mintlify.app/_mintlify/api/request` }, { - source: `/${subdirectory}`, + source: `/${subpath}`, destination: `https://${subdomain}.mintlify.app` }, { - source: `/${subdirectory}/llms.txt`, + source: `/${subpath}/llms.txt`, destination: `https://${subdomain}.mintlify.app/llms.txt` }, { - source: `/${subdirectory}/llms-full.txt`, + source: `/${subpath}/llms-full.txt`, destination: `https://${subdomain}.mintlify.app/llms-full.txt` }, { - source: `/${subdirectory}/sitemap.xml`, + source: `/${subpath}/sitemap.xml`, destination: `https://${subdomain}.mintlify.app/sitemap.xml` }, { - source: `/${subdirectory}/robots.txt`, + source: `/${subpath}/robots.txt`, destination: `https://${subdomain}.mintlify.app/robots.txt` }, { - source: `/${subdirectory}/:path*`, - destination: `https://${subdomain}.mintlify.app/${subdirectory}/:path*` + source: `/${subpath}/:path*`, + destination: `https://${subdomain}.mintlify.app/${subpath}/:path*` }, { source: "/mintlify-assets/:path+", @@ -71,12 +71,12 @@ export const VercelJsonGenerator = () => {
setSubdirectory(e.target.value)} + value={subpath} + onChange={(e) => setSubpath(e.target.value)} placeholder="docs" className="w-full p-1 text-sm rounded border dark:border-white/10 bg-transparent" /> diff --git a/snippets/fr/vercel-json-generator.mdx b/snippets/fr/vercel-json-generator.mdx index ea6cea794..f0c3aae49 100644 --- a/snippets/fr/vercel-json-generator.mdx +++ b/snippets/fr/vercel-json-generator.mdx @@ -1,6 +1,6 @@ export const VercelJsonGenerator = () => { const [subdomain, setSubdomain] = useState('[SUBDOMAIN]') - const [subdirectory, setSubdirectory] = useState('docs') + const [subpath, setSubpath] = useState('[SUBPATH]') const vercelConfig = { rewrites: [ @@ -13,28 +13,28 @@ export const VercelJsonGenerator = () => { destination: `https://${subdomain}.mintlify.app/_mintlify/api/request` }, { - source: `/${subdirectory}`, + source: `/${subpath}`, destination: `https://${subdomain}.mintlify.app` }, { - source: `/${subdirectory}/llms.txt`, + source: `/${subpath}/llms.txt`, destination: `https://${subdomain}.mintlify.app/llms.txt` }, { - source: `/${subdirectory}/llms-full.txt`, + source: `/${subpath}/llms-full.txt`, destination: `https://${subdomain}.mintlify.app/llms-full.txt` }, { - source: `/${subdirectory}/sitemap.xml`, + source: `/${subpath}/sitemap.xml`, destination: `https://${subdomain}.mintlify.app/sitemap.xml` }, { - source: `/${subdirectory}/robots.txt`, + source: `/${subpath}/robots.txt`, destination: `https://${subdomain}.mintlify.app/robots.txt` }, { - source: `/${subdirectory}/:path*`, - destination: `https://${subdomain}.mintlify.app/${subdirectory}/:path*` + source: `/${subpath}/:path*`, + destination: `https://${subdomain}.mintlify.app/${subpath}/:path*` }, { source: "/mintlify-assets/:path+", @@ -71,12 +71,12 @@ export const VercelJsonGenerator = () => {
setSubdirectory(e.target.value)} + value={subpath} + onChange={(e) => setSubpath(e.target.value)} placeholder="docs" className="w-full p-1 text-sm rounded border dark:border-white/10 bg-transparent" /> diff --git a/snippets/zh/vercel-json-generator.mdx b/snippets/zh/vercel-json-generator.mdx index ea6cea794..f0c3aae49 100644 --- a/snippets/zh/vercel-json-generator.mdx +++ b/snippets/zh/vercel-json-generator.mdx @@ -1,6 +1,6 @@ export const VercelJsonGenerator = () => { const [subdomain, setSubdomain] = useState('[SUBDOMAIN]') - const [subdirectory, setSubdirectory] = useState('docs') + const [subpath, setSubpath] = useState('[SUBPATH]') const vercelConfig = { rewrites: [ @@ -13,28 +13,28 @@ export const VercelJsonGenerator = () => { destination: `https://${subdomain}.mintlify.app/_mintlify/api/request` }, { - source: `/${subdirectory}`, + source: `/${subpath}`, destination: `https://${subdomain}.mintlify.app` }, { - source: `/${subdirectory}/llms.txt`, + source: `/${subpath}/llms.txt`, destination: `https://${subdomain}.mintlify.app/llms.txt` }, { - source: `/${subdirectory}/llms-full.txt`, + source: `/${subpath}/llms-full.txt`, destination: `https://${subdomain}.mintlify.app/llms-full.txt` }, { - source: `/${subdirectory}/sitemap.xml`, + source: `/${subpath}/sitemap.xml`, destination: `https://${subdomain}.mintlify.app/sitemap.xml` }, { - source: `/${subdirectory}/robots.txt`, + source: `/${subpath}/robots.txt`, destination: `https://${subdomain}.mintlify.app/robots.txt` }, { - source: `/${subdirectory}/:path*`, - destination: `https://${subdomain}.mintlify.app/${subdirectory}/:path*` + source: `/${subpath}/:path*`, + destination: `https://${subdomain}.mintlify.app/${subpath}/:path*` }, { source: "/mintlify-assets/:path+", @@ -71,12 +71,12 @@ export const VercelJsonGenerator = () => {
setSubdirectory(e.target.value)} + value={subpath} + onChange={(e) => setSubpath(e.target.value)} placeholder="docs" className="w-full p-1 text-sm rounded border dark:border-white/10 bg-transparent" /> diff --git a/zh/deploy/vercel.mdx b/zh/deploy/vercel.mdx index cc65edb00..544ac139f 100644 --- a/zh/deploy/vercel.mdx +++ b/zh/deploy/vercel.mdx @@ -10,53 +10,64 @@ import { VercelJsonGenerator } from "/snippets/zh/vercel-json-generator.mdx"; ## vercel.json 文件
-`vercel.json` 文件用于配置项目的构建与部署方式。它位于项目根目录,控制部署的各个方面,包括路由、重定向、响应头和构建设置。 +`vercel.json` 文件用于配置项目的构建与部署方式。它位于项目根目录,控制部署的各个方面,包括路由、重定向、请求头和构建设置。 -我们使用 `rewrites` 配置,将来自主 domain 的请求代理到你的文档站点。 +我们使用 `rewrites` 配置将来自主 domain 的请求代理到你的文档站点。 -Rewrites 会在不更改浏览器中 URL 的情况下,将传入请求映射到不同的目标。当有人访问 `yoursite.com/docs` 时,Vercel 会在内部从 `your-subdomain.mintlify.dev/docs` 获取内容,但用户在浏览器中仍会看到 `yoursite.com/docs`。这不同于重定向,后者会将用户发送到完全不同的 URL。 +Rewrites 会在不更改浏览器中 URL 的情况下,将传入请求映射到不同的目标。当有人访问 `yoursite.com/docs` 时,Vercel 会在内部从 `your-subdomain.mintlify.dev/docs` 获取内容,但用户在浏览器中仍然看到 `yoursite.com/docs`。这与重定向不同,重定向会将用户带到另一个完全不同的 URL。 -你可以将子路径自定义为任意你喜欢的值,例如 `/docs`、`/help` 或 `/guides`。此外,你还可以使用更深层级的嵌套子路径,如 `/product/docs`。 - -
- ## 存储库结构 -
- -必须在存储库中按所选子路径结构组织文档文件。比如,如果希望文档位于 `yoursite.com/docs`,则需创建一个 `docs/` 目录,并将所有文档文件放入其中。 +你可以将子路径自定义为任意你喜欢的值,例如 `/docs`、`/help` 或 `/guides`。此外,你也可以使用更深层级的嵌套子路径,如 `/product/docs`。
## 配置
-若要在 Vercel 上将文档托管到自定义子路径,请在你的 `vercel.json` 文件中添加以下配置。本示例使用 `/docs`,你也可以替换为任意子路径: +
+ ### 从 `/docs` 提供托管 +
+ +1. 在你的控制台前往 [自定义 domain 设置](https://dashboard.mintlify.com/settings/deployment/custom-domain)。 +2. 将 **在 `/docs` 托管** 开关切换为开启。 + + + 自定义 domain 设置页面的截图。“在 `/docs` 托管”开关已开启,并用橙色矩形标出。 + + 自定义 domain 设置页面的截图。“在 `/docs` 托管”开关已开启,并用橙色矩形标出。 + + +3. 输入你的 domain。 +4. 选择 **添加 domain**。 +5. 将以下重写规则添加到你的 `vercel.json` 文件中。将 `[subdomain]` 替换为你的子域: ```json -{ - "rewrites": [ - { - "source": "/docs", - "destination": "https://[subdomain].mintlify.dev/docs" - }, - { - "source": "/docs/:match*", - "destination": "https://[subdomain].mintlify.dev/docs/:match*" - } - ] -} + { + "rewrites": [ + { + "source": "/docs", + "destination": "https://[subdomain].mintlify.dev/docs" + }, + { + "source": "/docs/:match*", + "destination": "https://[subdomain].mintlify.dev/docs/:match*" + } + ] + } ``` -* **`source`**: 会在你的 domain 上触发重写的路径模式。 +* **`source`**: 你在 domain 上用于触发重写的路径模式。 * **`destination`**: 请求应被代理到的目标地址。 * **`:match*`**: 一个通配符,用于捕获子路径之后的任意路径片段。 更多信息请参阅 Vercel 文档:[使用 vercel.json 配置项目:Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites)。 -
- ### 生成重写规则 +
+ ### 从自定义路径托管
-输入你的子域和自定义子目录,为 `vercel.json` 文件生成重写规则。 +要使用自定义子路径(`/docs` 之外的任意路径),必须在存储库中按该子路径的结构组织文档文件。举例来说,如果文档托管在 `yoursite.com/help`,则文档文件必须位于 `help/` 目录下。 + +使用下面的生成器创建重写配置,并将这些重写添加到 `vercel.json` 文件中。 diff --git a/zh/organize/settings.mdx b/zh/organize/settings.mdx index c1ccd64c4..390971565 100644 --- a/zh/organize/settings.mdx +++ b/zh/organize/settings.mdx @@ -133,9 +133,9 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 视觉样式配置。 - + - 页面 eyebrow 的样式。选择 `section` 显示所属分区名称,或选择 `breadcrumbs` 显示完整导航路径。默认值为 `section`。 + 页面眉部(eyebrow)的样式。选择 `section` 显示所属分区名称,或选择 `breadcrumbs` 显示完整导航路径。默认值为 `section`。 @@ -143,13 +143,13 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; **简单配置:** - * `"system"`:跟随当前站点模式(light 或 dark) + * `"system"`:与当前站点模式匹配(light 或 dark) * `"dark"`:始终使用 dark 模式 **自定义主题配置:** - * 使用字符串为所有代码块指定单个 [Shiki 主题](https://shiki.style/themes) - * 使用对象分别为 light 和 dark 模式指定 [Shiki 主题](https://shiki.style/themes) + * 使用字符串为所有代码块指定单一的 [Shiki 主题](https://shiki.style/themes) + * 使用对象分别为 light 和 dark 模式指定不同的 [Shiki 主题](https://shiki.style/themes) 一个同时用于 light 和 dark 模式的 Shiki 主题名称。 @@ -164,7 +164,7 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; - 为 light 和 dark 模式分别设置主题。 + 分别为 light 和 dark 模式设置主题。 @@ -194,80 +194,36 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; 图标库设置。 - + - 在整站文档中使用的图标库。默认值为 `fontawesome`。 + 在整个文档中使用的图标库。默认值为 `fontawesome`。 - 无论库设置如何,你都可以为任何单个图标指定外部托管图标的 URL、项目中图标文件的路径,或 JSX 兼容的 SVG 代码。 + 无论库设置为何,你都可以为任意单个图标指定外部托管图标的 URL、项目中的图标文件路径,或 JSX 兼容的 SVG 代码。 - 为文档配置字体。默认字体为 [Inter](https://fonts.google.com/specimen/Inter)。 + 文档中标题的字体配置。默认字体因主题而异。 - 字体系列,例如 “Open Sans”。 + 字体族,例如 “Open Sans”。 - 字重,例如 400 或 700。可变字体支持精确字重,例如 550。 + 字重,例如 400 或 700。可变字体支持更精确的字重,例如 550。 - 字体来源的 URL,例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2。指定 Google 字体的 `family` 名称时,会自动加载 [Google Fonts](https://fonts.google.com),无需提供 source 的 URL。 + 字体来源的 URL,例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2。指定 Google 字体的 `family` 名称时会自动加载 [Google Fonts](https://fonts.google.com),因此无需提供来源 URL。 字体文件格式。 - - - 为标题单独覆盖字体设置。 - - - - 字体系列,例如 “Open Sans”、“Playfair Display”。 - - - - 字重,例如 400、700。可变字体支持精确字重,例如 550。 - - - - 字体来源的 URL,例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2。指定 Google 字体的 `family` 名称时,会自动加载 [Google Fonts](https://fonts.google.com),无需提供 source 的 URL。 - - - - 字体文件格式。 - - - - - - 为正文单独覆盖字体设置。 - - - - 字体系列,例如 “Open Sans”、“Playfair Display”。 - - - - 字重,例如 400、700。可变字体支持精确字重,例如 550。 - - - - 字体来源的 URL,例如 https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2。指定 Google 字体的 `family` 名称时,会自动加载 [Google Fonts](https://fonts.google.com),无需提供 source 的 URL。 - - - - 字体文件格式。 - - - @@ -276,11 +232,11 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx"; - 默认主题模式。选择 `system` 以跟随用户的操作系统设置,或选择 `light`/`dark` 固定为特定模式。默认为 `system`。 + 默认主题模式。选择 `system` 以匹配用户的操作系统设置,或选择 `light` 或 `dark` 强制启用特定模式。默认值为 `system`。 - 是否隐藏明暗模式切换。默认为 `true`。 + 是否隐藏明暗模式切换。默认值为 `true`。