From 2d7e739c1bab4fe4c88575b7552278b7d85574d4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 6 Aug 2026 06:51:48 +0000 Subject: [PATCH] docs: improve SEO metadata --- api/search-index/contents.mdx | 1 - api/search-index/context.mdx | 1 - api/search-index/search.mdx | 1 - create/files.mdx | 2 +- customize/fonts.mdx | 2 +- customize/themes.mdx | 2 +- dashboard/roles.mdx | 2 +- deploy/deployments.mdx | 2 +- editor/configurations.mdx | 2 +- es/api-playground/overview.mdx | 2 +- es/api-playground/websocket-playground.mdx | 2 +- es/dashboard/roles.mdx | 2 +- es/index.mdx | 2 +- fr/agent/workflows.mdx | 2 +- fr/api-playground/overview.mdx | 2 +- fr/api-playground/websocket-playground.mdx | 2 +- fr/editor/configurations.mdx | 2 +- fr/guides/index.mdx | 2 +- fr/index.mdx | 2 +- fr/organize/navigation.mdx | 2 +- fr/organize/pages.mdx | 2 +- guides/index.mdx | 2 +- index.mdx | 2 +- optimize/analytics.mdx | 2 +- organize/navigation.mdx | 2 +- organize/pages.mdx | 2 +- organize/settings-integrations.mdx | 2 +- search-index/mcp.mdx | 2 +- zh/advanced-support.mdx | 2 +- zh/agent/customize.mdx | 2 +- zh/agent/effective-prompts.mdx | 2 +- zh/agent/index.mdx | 2 +- zh/agent/slack.mdx | 2 +- zh/agent/workflows.mdx | 4 ++-- zh/ai-native.mdx | 2 +- zh/ai/contextual-menu.mdx | 2 +- zh/ai/llmstxt.mdx | 2 +- zh/ai/markdown-export.mdx | 2 +- zh/ai/mintlify-mcp.mdx | 2 +- zh/ai/model-context-protocol.mdx | 2 +- zh/ai/skillmd.mdx | 2 +- zh/ai/slack-bot.mdx | 2 +- zh/api-playground/adding-sdk-examples.mdx | 2 +- zh/api-playground/asyncapi-setup.mdx | 2 +- zh/api-playground/complex-data-types.mdx | 2 +- zh/api-playground/graphql-setup.mdx | 2 +- zh/api-playground/managing-page-visibility.mdx | 2 +- zh/api-playground/mdx-setup.mdx | 2 +- zh/api-playground/multiple-responses.mdx | 2 +- zh/api-playground/openapi-setup.mdx | 2 +- zh/api-playground/overview.mdx | 2 +- zh/api-playground/troubleshooting.mdx | 2 +- zh/api-playground/websocket-playground.mdx | 4 ++-- zh/api/analytics/feedback-by-page.mdx | 2 +- zh/api/analytics/searches.mdx | 2 +- zh/api/analytics/views.mdx | 2 +- zh/api/analytics/visitors.mdx | 2 +- zh/api/introduction.mdx | 4 ++-- zh/api/static-export/overview.mdx | 2 +- zh/assistant/configure.mdx | 2 +- zh/assistant/customize.mdx | 2 +- zh/assistant/index.mdx | 2 +- zh/assistant/skills.mdx | 2 +- zh/assistant/use.mdx | 2 +- zh/assistant/widget.mdx | 2 +- zh/automations/create.mdx | 2 +- zh/automations/index.mdx | 2 +- zh/automations/manage.mdx | 2 +- zh/automations/reference.mdx | 2 +- zh/cli/commands.mdx | 2 +- zh/cli/preview.mdx | 2 +- zh/components/accordions.mdx | 2 +- zh/components/badge.mdx | 2 +- zh/components/banner.mdx | 2 +- zh/components/callouts.mdx | 2 +- zh/components/cards.mdx | 2 +- zh/components/code-groups.mdx | 2 +- zh/components/color.mdx | 2 +- zh/components/columns.mdx | 2 +- zh/components/examples.mdx | 2 +- zh/components/expandables.mdx | 2 +- zh/components/fields.mdx | 2 +- zh/components/frames.mdx | 2 +- zh/components/icons.mdx | 2 +- zh/components/index.mdx | 4 ++-- zh/components/mermaid-diagrams.mdx | 2 +- zh/components/panel.mdx | 2 +- zh/components/prompt.mdx | 2 +- zh/components/responses.mdx | 2 +- zh/components/steps.mdx | 2 +- zh/components/tabs.mdx | 2 +- zh/components/tiles.mdx | 2 +- zh/components/tooltips.mdx | 2 +- zh/components/tree.mdx | 2 +- zh/components/update.mdx | 2 +- zh/components/view.mdx | 2 +- zh/components/visibility.mdx | 2 +- zh/contact-support.mdx | 2 +- zh/create/changelogs.mdx | 2 +- zh/create/code.mdx | 2 +- zh/create/files.mdx | 4 ++-- zh/create/image-embeds.mdx | 2 +- zh/create/list-table.mdx | 2 +- zh/create/personalization.mdx | 2 +- zh/create/redirects.mdx | 2 +- zh/create/reusable-snippets.mdx | 2 +- zh/create/text.mdx | 2 +- zh/credits.mdx | 2 +- zh/customize/custom-404-page.mdx | 2 +- zh/customize/custom-domain.mdx | 2 +- zh/customize/custom-scripts.mdx | 2 +- zh/customize/fonts.mdx | 4 ++-- zh/customize/react-components.mdx | 2 +- zh/customize/themes.mdx | 4 ++-- zh/dashboard/audit-logs.mdx | 2 +- zh/dashboard/network-access.mdx | 2 +- zh/dashboard/permissions.mdx | 2 +- zh/dashboard/roles.mdx | 4 ++-- zh/dashboard/scim.mdx | 2 +- zh/dashboard/security-contact.mdx | 2 +- zh/dashboard/session-security.mdx | 2 +- zh/dashboard/sso.mdx | 2 +- zh/deploy/authentication-setup.mdx | 2 +- zh/deploy/ci.mdx | 2 +- zh/deploy/cloudflare-firewall-troubleshooting.mdx | 2 +- zh/deploy/cloudflare.mdx | 2 +- zh/deploy/csp-configuration.mdx | 2 +- zh/deploy/custom-portal.mdx | 2 +- zh/deploy/deployments.mdx | 4 ++-- zh/deploy/docs-subpath.mdx | 2 +- zh/deploy/export.mdx | 2 +- zh/deploy/ghes.mdx | 2 +- zh/deploy/github.mdx | 2 +- zh/deploy/gitlab-self-hosted.mdx | 2 +- zh/deploy/gitlab.mdx | 2 +- zh/deploy/monorepo.mdx | 2 +- zh/deploy/multi-repo.mdx | 2 +- zh/deploy/preview-deployments.mdx | 2 +- zh/deploy/reverse-proxy.mdx | 2 +- zh/deploy/route53-cloudfront.mdx | 2 +- zh/deploy/self-host.mdx | 2 +- zh/deploy/vercel-external-proxies.mdx | 2 +- zh/deploy/vercel.mdx | 2 +- zh/editor/agent.mdx | 2 +- zh/editor/branching-and-publishing.mdx | 2 +- zh/editor/collaborate.mdx | 2 +- zh/editor/comments.mdx | 4 ++-- zh/editor/configurations.mdx | 4 ++-- zh/editor/git-essentials.mdx | 2 +- zh/editor/index.mdx | 2 +- zh/editor/keyboard-shortcuts.mdx | 2 +- zh/editor/live-preview.mdx | 2 +- zh/editor/media.mdx | 2 +- zh/editor/navigation.mdx | 2 +- zh/editor/pages.mdx | 2 +- zh/editor/publish.mdx | 2 +- zh/editor/settings.mdx | 2 +- zh/editor/tutorial.mdx | 2 +- zh/guides/accessibility.mdx | 2 +- zh/guides/assistant-embed.mdx | 2 +- zh/guides/auth0.mdx | 2 +- zh/guides/branches.mdx | 2 +- zh/guides/claude-code.mdx | 2 +- zh/guides/codex.mdx | 2 +- zh/guides/configure-automerge.mdx | 2 +- zh/guides/content-templates.mdx | 2 +- zh/guides/content-types.mdx | 2 +- zh/guides/cursor.mdx | 2 +- zh/guides/custom-frontend.mdx | 2 +- zh/guides/custom-layouts.mdx | 2 +- zh/guides/developer-documentation.mdx | 2 +- zh/guides/devin-desktop.mdx | 2 +- zh/guides/geo.mdx | 2 +- zh/guides/git-concepts.mdx | 2 +- zh/guides/help-center.mdx | 2 +- zh/guides/improving-docs.mdx | 2 +- zh/guides/index.mdx | 4 ++-- zh/guides/internationalization.mdx | 2 +- zh/guides/knowledge-base.mdx | 2 +- zh/guides/linking.mdx | 2 +- zh/guides/maintenance.mdx | 2 +- zh/guides/media.mdx | 2 +- zh/guides/migrating-from-mdx.mdx | 2 +- zh/guides/navigation.mdx | 2 +- zh/guides/seo.mdx | 2 +- zh/guides/style-and-tone.mdx | 2 +- zh/guides/understand-your-audience.mdx | 2 +- zh/guides/use-automations.mdx | 2 +- zh/index.mdx | 4 ++-- zh/integrations/analytics/adobe.mdx | 2 +- zh/integrations/analytics/amplitude.mdx | 2 +- zh/integrations/analytics/clarity.mdx | 2 +- zh/integrations/analytics/clearbit.mdx | 2 +- zh/integrations/analytics/fathom.mdx | 2 +- zh/integrations/analytics/google-analytics.mdx | 2 +- zh/integrations/analytics/google-tag-manager.mdx | 2 +- zh/integrations/analytics/heap.mdx | 2 +- zh/integrations/analytics/hightouch.mdx | 2 +- zh/integrations/analytics/hotjar.mdx | 2 +- zh/integrations/analytics/logrocket.mdx | 2 +- zh/integrations/analytics/mixpanel.mdx | 2 +- zh/integrations/analytics/overview.mdx | 2 +- zh/integrations/analytics/pirsch.mdx | 2 +- zh/integrations/analytics/plausible.mdx | 2 +- zh/integrations/analytics/posthog.mdx | 2 +- zh/integrations/analytics/segment.mdx | 2 +- zh/integrations/privacy/osano.mdx | 2 +- zh/integrations/privacy/overview.mdx | 2 +- zh/integrations/privacy/transcend.mdx | 2 +- zh/integrations/sdks/speakeasy.mdx | 2 +- zh/integrations/sdks/stainless.mdx | 2 +- zh/integrations/support/front.mdx | 2 +- zh/integrations/support/intercom.mdx | 2 +- zh/integrations/support/overview.mdx | 2 +- zh/migration-services/enterprise.mdx | 2 +- zh/migration.mdx | 2 +- zh/optimize/analytics.mdx | 4 ++-- zh/optimize/feedback.mdx | 2 +- zh/optimize/pdf-exports.mdx | 2 +- zh/optimize/search-boost.mdx | 2 +- zh/optimize/search.mdx | 2 +- zh/optimize/seo.mdx | 2 +- zh/organize/hidden-page-example.mdx | 2 +- zh/organize/hidden-pages.mdx | 2 +- zh/organize/mintignore.mdx | 2 +- zh/organize/navigation.mdx | 4 ++-- zh/organize/pages.mdx | 2 +- zh/organize/related-pages.mdx | 2 +- zh/organize/settings-api.mdx | 2 +- zh/organize/settings-appearance.mdx | 2 +- zh/organize/settings-integrations.mdx | 4 ++-- zh/organize/settings-reference.mdx | 2 +- zh/organize/settings-seo.mdx | 2 +- zh/organize/settings-structure.mdx | 2 +- zh/organize/settings.mdx | 2 +- zh/status.mdx | 2 +- zh/what-is-mintlify.mdx | 2 +- 237 files changed, 250 insertions(+), 253 deletions(-) diff --git a/api/search-index/contents.mdx b/api/search-index/contents.mdx index fd28cb9743..7c32492a60 100644 --- a/api/search-index/contents.mdx +++ b/api/search-index/contents.mdx @@ -1,7 +1,6 @@ --- title: "Get result contents" sidebarTitle: "Contents" -description: "Retrieve content from Mintlify Index by result ID or result URL after searching." keywords: ["Mintlify Index", "contents API", "result IDs", "URLs"] openapi: "/index-openapi.json POST /v1/contents" --- diff --git a/api/search-index/context.mdx b/api/search-index/context.mdx index d9921083bf..01249740d5 100644 --- a/api/search-index/context.mdx +++ b/api/search-index/context.mdx @@ -1,7 +1,6 @@ --- title: "Build implementation context" sidebarTitle: "Context" -description: "Assemble source-cited technical context within a token budget for an application or agent." keywords: ["Mintlify Index", "context", "citations", "token budget"] openapi: "/index-openapi.json POST /v1/context" --- diff --git a/api/search-index/search.mdx b/api/search-index/search.mdx index 5690c8a5b3..3bc2c690cb 100644 --- a/api/search-index/search.mdx +++ b/api/search-index/search.mdx @@ -1,7 +1,6 @@ --- title: "Search technical knowledge" sidebarTitle: "Search" -description: "Search Mintlify Index for ranked technical documentation and web results." keywords: ["Mintlify Index", "search API", "technical documentation", "ranked results"] openapi: "/index-openapi.json POST /v1/search" --- diff --git a/create/files.mdx b/create/files.mdx index 2bef59c69c..001592f151 100644 --- a/create/files.mdx +++ b/create/files.mdx @@ -1,5 +1,5 @@ --- -title: "Files" +title: "Static files" description: "Serve static assets like images, videos, PDFs, and data files from your documentation repository with automatic optimization and CDN delivery." keywords: ["static assets","supported file types"] boost: 3 diff --git a/customize/fonts.mdx b/customize/fonts.mdx index d6bc0e1e7f..44c879e439 100644 --- a/customize/fonts.mdx +++ b/customize/fonts.mdx @@ -1,5 +1,5 @@ --- -title: "Fonts" +title: "Custom documentation fonts" description: "Customize typography on your documentation site with Google Fonts or self-hosted font files for headings, body text, and code blocks." keywords: ["Google Fonts", "local fonts", "custom typography"] boost: 3 diff --git a/customize/themes.mdx b/customize/themes.mdx index d5fd08cce9..6dce9a5db1 100644 --- a/customize/themes.mdx +++ b/customize/themes.mdx @@ -1,5 +1,5 @@ --- -title: "Themes" +title: "Documentation themes" description: "Choose and configure a theme to customize your documentation site's colors, dark mode behavior, layout style, and overall visual appearance." mode: "frame" keywords: ["theme selection", "Mint", "Maple", "Palm", "Willow", "Linden", "Almond", "Aspen", "Sequoia", "customize appearance"] diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index 0c2910b462..d8e380c835 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -1,5 +1,5 @@ --- -title: "Roles" +title: "Team roles and permissions" description: "Assign admin, editor, or viewer roles to team members to control access levels, editing permissions, and deployment capabilities in Mintlify." keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions", "revoke credentials", "session revocation"] boost: 3 diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index 2859ff253a..0463a959d4 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -1,5 +1,5 @@ --- -title: "Deployments" +title: "Manage documentation deployments" description: "Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, and troubleshooting." keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] boost: 3 diff --git a/editor/configurations.mdx b/editor/configurations.mdx index 59e6b8d65c..e243265a1b 100644 --- a/editor/configurations.mdx +++ b/editor/configurations.mdx @@ -1,5 +1,5 @@ --- -title: "Configurations" +title: "Editor configurations" 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 diff --git a/es/api-playground/overview.mdx b/es/api-playground/overview.mdx index dbd5efb11b..ad2a1599e7 100644 --- a/es/api-playground/overview.mdx +++ b/es/api-playground/overview.mdx @@ -1,5 +1,5 @@ --- -title: "Playground" +title: "Playground de API interactivo" description: "Permite a los desarrolladores probar endpoints de API en tu documentación con un playground interactivo que envía solicitudes y muestra respuestas." keywords: ["interactivo", "API", "pruebas de endpoints", "solicitudes de API en tiempo real", "generador de solicitudes"] boost: 3 diff --git a/es/api-playground/websocket-playground.mdx b/es/api-playground/websocket-playground.mdx index daf65a4789..6090fd4be9 100644 --- a/es/api-playground/websocket-playground.mdx +++ b/es/api-playground/websocket-playground.mdx @@ -1,5 +1,5 @@ --- -title: "Zona de pruebas" +title: "Playground interactivo de WebSocket" description: "Añade playgrounds interactivos de WebSocket a tu documentación para que los usuarios prueben conexiones, envíen mensajes y vean eventos." asyncapi: "/asyncapi.yaml channelOne" --- \ No newline at end of file diff --git a/es/dashboard/roles.mdx b/es/dashboard/roles.mdx index 03645691db..b57176d632 100644 --- a/es/dashboard/roles.mdx +++ b/es/dashboard/roles.mdx @@ -1,5 +1,5 @@ --- -title: "Roles" +title: "Roles y permisos del equipo" description: "Asigna roles de administrador, editor o lector a los miembros del equipo para controlar el acceso, la edición y los despliegues en Mintlify." keywords: ["RBAC", "control de acceso basado en roles", "administrador", "editor", "lector", "permisos", "revocar credenciales", "revocación de sesión"] boost: 3 diff --git a/es/index.mdx b/es/index.mdx index 87a080cc75..4525d4a2a1 100644 --- a/es/index.mdx +++ b/es/index.mdx @@ -1,5 +1,5 @@ --- -title: "Introducción" +title: "Plataforma de documentación Mintlify" description: "Mintlify es una plataforma de documentación nativa de IA para desarrolladores, con diseños atractivos, playgrounds de API interactivos y búsqueda inteligente." mode: "frame" keywords: ["descripción general", "plataforma", "primeros pasos", "características"] diff --git a/fr/agent/workflows.mdx b/fr/agent/workflows.mdx index bb2994a0cd..b34f8bf477 100644 --- a/fr/agent/workflows.mdx +++ b/fr/agent/workflows.mdx @@ -1,5 +1,5 @@ --- -title: "Workflows" +title: "Workflows d'agent" description: "Automatisez la maintenance de la documentation avec des tâches d'agent planifiées ou déclenchées par des événements via cron et webhooks." keywords: ["automation", "automate", "cron", "auto-update"] --- diff --git a/fr/api-playground/overview.mdx b/fr/api-playground/overview.mdx index 8f17fe84cd..19338fbff2 100644 --- a/fr/api-playground/overview.mdx +++ b/fr/api-playground/overview.mdx @@ -1,5 +1,5 @@ --- -title: "Playground" +title: "Playground d'API interactif" description: "Laissez les développeurs tester les endpoints d'API dans votre documentation avec un playground interactif qui envoie de vraies requêtes et réponses." keywords: ["interactif", "API", "test des endpoints", "requêtes API en direct", "générateur de requêtes"] boost: 3 diff --git a/fr/api-playground/websocket-playground.mdx b/fr/api-playground/websocket-playground.mdx index 42baa01d0c..e58367a8b5 100644 --- a/fr/api-playground/websocket-playground.mdx +++ b/fr/api-playground/websocket-playground.mdx @@ -1,5 +1,5 @@ --- -title: "Aire de test" +title: "Bac à sable WebSocket interactif" description: "Ajoutez des bacs à sable WebSocket interactifs à votre doc pour tester les connexions en temps réel, envoyer des messages et visualiser les flux d'événements." asyncapi: "/asyncapi.yaml channelOne" --- \ No newline at end of file diff --git a/fr/editor/configurations.mdx b/fr/editor/configurations.mdx index 97b69c9318..592e5b9797 100644 --- a/fr/editor/configurations.mdx +++ b/fr/editor/configurations.mdx @@ -1,5 +1,5 @@ --- -title: "Configurations" +title: "Configurations de l'éditeur" description: "Modifiez identité de marque, apparence, navigation et paramètres du site depuis le panneau Configurations de l'éditeur web Mintlify, en temps réel." keywords: ["editor", "configurations", "settings", "branding", "theme"] boost: 3 diff --git a/fr/guides/index.mdx b/fr/guides/index.mdx index e9497eb42e..15f6a71605 100644 --- a/fr/guides/index.mdx +++ b/fr/guides/index.mdx @@ -1,5 +1,5 @@ --- -title: "Guides" +title: "Guides de documentation" description: "Parcourez des guides sur les bonnes pratiques de documentation, la stratégie de contenu, le SEO, l'accessibilité et les workflows docs-as-code." boost: 3 --- diff --git a/fr/index.mdx b/fr/index.mdx index 3479577212..3acb2b8bf8 100644 --- a/fr/index.mdx +++ b/fr/index.mdx @@ -1,5 +1,5 @@ --- -title: "Introduction" +title: "Plateforme de documentation Mintlify" description: "Mintlify est une plateforme de documentation native à l'IA pour les développeurs, avec des designs soignés, des playgrounds d'API et une recherche intelligente." mode: "frame" keywords: ["vue d’ensemble", "plateforme", "mise en route", "fonctionnalités"] diff --git a/fr/organize/navigation.mdx b/fr/organize/navigation.mdx index 8495b25acb..4734585d07 100644 --- a/fr/organize/navigation.mdx +++ b/fr/organize/navigation.mdx @@ -1,5 +1,5 @@ --- -title: "Navigation" +title: "Navigation de la documentation" description: "Configurez la navigation de votre site avec des groupes, pages, menus déroulants, onglets et ancres dans docs.json pour bâtir votre barre latérale." keywords: ["structure de navigation", "configuration de la barre latérale", "organisation des pages", "groupes de navigation"] boost: 3 diff --git a/fr/organize/pages.mdx b/fr/organize/pages.mdx index d67761b939..aa5b235139 100644 --- a/fr/organize/pages.mdx +++ b/fr/organize/pages.mdx @@ -1,5 +1,5 @@ --- -title: "Pages" +title: "Configuration des pages" description: "Configurez les métadonnées, titres, descriptions, icônes et modes de mise en page via les propriétés YAML en haut de votre documentation MDX." keywords: ["tags", "tag", "frontmatter", "metadata", "layout"] boost: 3 diff --git a/guides/index.mdx b/guides/index.mdx index cf534f9cd4..2fd344475b 100644 --- a/guides/index.mdx +++ b/guides/index.mdx @@ -1,5 +1,5 @@ --- -title: "Guides" +title: "Documentation guides" description: "Browse guides on documentation best practices, content strategy, SEO optimization, accessibility, and docs-as-code workflows for your team." boost: 3 --- diff --git a/index.mdx b/index.mdx index a1efde0bac..ad780a9280 100644 --- a/index.mdx +++ b/index.mdx @@ -1,5 +1,5 @@ --- -title: "Introduction" +title: "Mintlify documentation platform" description: "Mintlify is an AI-native documentation platform built for developers, with beautiful defaults, interactive API playgrounds, and smart search." mode: "frame" keywords: ["overview", "platform", "getting started", "features"] diff --git a/optimize/analytics.mdx b/optimize/analytics.mdx index 0b369ea9b8..1ca046434e 100644 --- a/optimize/analytics.mdx +++ b/optimize/analytics.mdx @@ -1,5 +1,5 @@ --- -title: "Analytics" +title: "Documentation analytics" description: "Track traffic, search trends, assistant usage, and user feedback in the Mintlify analytics dashboard to improve content and report on effectiveness." keywords: ["analytics","metrics","page views","traffic","trends","insights","impressions","CTA","call-to-action"] boost: 3 diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 71ff82ecde..0ba403a03b 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -1,5 +1,5 @@ --- -title: "Navigation" +title: "Documentation navigation" description: "Configure your documentation site navigation with groups, pages, dropdowns, tabs, and anchors in docs.json to build a sidebar structure." keywords: ["navigation structure", "sidebar configuration", "page organization", "navigation groups"] boost: 3 diff --git a/organize/pages.mdx b/organize/pages.mdx index 8fefcc647e..db8a4f7563 100644 --- a/organize/pages.mdx +++ b/organize/pages.mdx @@ -1,5 +1,5 @@ --- -title: "Pages" +title: "Page metadata and settings" description: "Configure page metadata, titles, descriptions, icons, and layout modes using YAML frontmatter properties at the top of your MDX documentation." keywords: ["tags", "tag", "frontmatter", "metadata", "layout"] boost: 3 diff --git a/organize/settings-integrations.mdx b/organize/settings-integrations.mdx index 91d774fbb3..4510363694 100644 --- a/organize/settings-integrations.mdx +++ b/organize/settings-integrations.mdx @@ -1,5 +1,5 @@ --- -title: "Integrations" +title: "Documentation integrations" description: "Connect analytics platforms, chat widgets, and third-party services to your Mintlify documentation site through the docs.json integrations config." keywords: ["integrations", "analytics", "google analytics", "posthog", "segment", "intercom", "hotjar", "mixpanel", "amplitude", "docs.json"] boost: 3 diff --git a/search-index/mcp.mdx b/search-index/mcp.mdx index 09e0328048..970e9eb4f4 100644 --- a/search-index/mcp.mdx +++ b/search-index/mcp.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify Index MCP server" sidebarTitle: "MCP reference" -description: "Reference for the public Mintlify Index MCP server, including its context tool, parameters, output, and rate limits." +description: "Reference for the public Mintlify Index MCP server, including its context tool, parameters, output, and rate limits for AI tools in production." keywords: ["Mintlify Index", "MCP server", "context tool", "rate limits"] --- diff --git a/zh/advanced-support.mdx b/zh/advanced-support.mdx index a609e44fc4..20bc0b012b 100644 --- a/zh/advanced-support.mdx +++ b/zh/advanced-support.mdx @@ -1,6 +1,6 @@ --- title: "高级支持" -description: "获取 Mintlify 高级支持服务：按优先级设定的响应时间目标、专属 Slack 频道、专属客户成功经理，以及针对文档站点问题的优先协助与工程升级。" +description: "获取 Mintlify 高级支持服务：按优先级设定的响应时间目标、专属 Slack 频道、专属客户成功经理，以及针对文档站点问题的优先协助与工程升级。本文介绍高级支持服务的响应目标、专属渠道和工程升级流程，帮助团队获得及时的文档支持。这些说明适合开发者和文档维护者查阅。" keywords: ["support", "CSM", "enterprise"] --- diff --git a/zh/agent/customize.mdx b/zh/agent/customize.mdx index 547c52faf5..f38c624764 100644 --- a/zh/agent/customize.mdx +++ b/zh/agent/customize.mdx @@ -1,6 +1,6 @@ --- title: "自定义 Agent 行为" -description: "使用 `AGENTS.md` 配置文件自定义 agent 行为，控制其处理文档任务和遵循约定的方式。" +description: "使用 `AGENTS.md` 配置文件自定义 agent 行为，控制其处理文档任务和遵循约定的方式。本文介绍 Agent 功能的配置方式和使用场景，帮助团队自动化文档维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["AGENTS.md", "Agent 配置", "自定义说明", "Agent 自定义"] --- diff --git a/zh/agent/effective-prompts.mdx b/zh/agent/effective-prompts.mdx index d52a905dd5..3f1d2919ed 100644 --- a/zh/agent/effective-prompts.mdx +++ b/zh/agent/effective-prompts.mdx @@ -1,6 +1,6 @@ --- title: "编写高效提示词" -description: "编写清晰、具体的提示词以从 Mintlify agent 获得更好的结果，包含有效指令示例和常见模式的实用技巧。" +description: "编写清晰、具体的提示词以从 Mintlify agent 获得更好的结果，包含有效指令示例和常见模式的实用技巧。本文介绍 Agent 功能的配置方式和使用场景，帮助团队自动化文档维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["prompts", "agent prompts", "effective prompting", "agent usage"] --- diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index 5b72f4e9ec..03622433ca 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -1,6 +1,6 @@ --- title: "什么是 agent？" -description: "使用 Mintlify agent 自动化文档更新。可通过 Slack 消息、pull request 或 API 调用触发变更。" +description: "使用 Mintlify agent 自动化文档更新。可通过 Slack 消息、pull request 或 API 调用触发变更。本文介绍 Agent 功能的配置方式和使用场景，帮助团队自动化文档维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- diff --git a/zh/agent/slack.mdx b/zh/agent/slack.mdx index 0be3317c4f..65209bb4d6 100644 --- a/zh/agent/slack.mdx +++ b/zh/agent/slack.mdx @@ -1,6 +1,6 @@ --- title: "将 agent 添加到 Slack" -description: "在 Slack 中安装 Mintlify agent，用于询问产品相关问题、根据团队对话创建内容更新，并将知识沉淀到 pull request 中。" +description: "在 Slack 中安装 Mintlify agent，用于询问产品相关问题、根据团队对话创建内容更新，并将知识沉淀到 pull request 中。本文介绍 Agent 功能的配置方式和使用场景，帮助团队自动化文档维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", "知识沉淀"] --- diff --git a/zh/agent/workflows.mdx b/zh/agent/workflows.mdx index d615ea61e8..3d95eab5c1 100644 --- a/zh/agent/workflows.mdx +++ b/zh/agent/workflows.mdx @@ -1,6 +1,6 @@ --- -title: "工作流" -description: "通过定时或事件触发的 agent 任务自动维护文档，包括 cron 计划和基于 webhook 的自动化。" +title: "AI agent 工作流" +description: "通过定时或事件触发的 agent 任务自动维护文档，包括 cron 计划和基于 webhook 的自动化。本文介绍 Agent 功能的配置方式和使用场景，帮助团队自动化文档维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["automation", "automate", "cron", "auto-update"] --- diff --git a/zh/ai-native.mdx b/zh/ai-native.mdx index 5dbe10ef0a..cf7e2f2591 100644 --- a/zh/ai-native.mdx +++ b/zh/ai-native.mdx @@ -1,7 +1,7 @@ --- title: "AI 原生文档" sidebarTitle: "AI 原生" -description: "了解 AI 原生功能如何通过助手、agent 和 MCP 服务器提升文档的阅读、创作和发现体验。" +description: "了解 AI 原生功能如何通过助手、agent 和 MCP 服务器提升文档的阅读、创作和发现体验。本文介绍 AI 原生文档的核心功能、使用场景和工作方式，帮助你改善文档阅读、创作和发现体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"] --- diff --git a/zh/ai/contextual-menu.mdx b/zh/ai/contextual-menu.mdx index 1922ddab32..bd80b4663d 100644 --- a/zh/ai/contextual-menu.mdx +++ b/zh/ai/contextual-menu.mdx @@ -1,6 +1,6 @@ --- title: "上下文菜单" -description: "为你的文档添加上下文菜单，一键集成 ChatGPT、Claude、Perplexity、Google AI Studio、Devin、Devin Desktop 和 MCP 工具。" +description: "为你的文档添加上下文菜单，一键集成 ChatGPT、Claude、Perplexity、Google AI Studio、Devin、Devin Desktop 和 MCP 工具。本文介绍 AI 工具与 Mintlify 文档的集成方式和使用场景，帮助你配置 AI 工作流并维护内容。" keywords: ["AI 工具", "ChatGPT", "Claude", "Perplexity", "MCP", "Grok", "cursor", "vscode", "vs code", "Google AI Studio", "aistudio", "Devin", "Windsurf", "Devin Desktop", "pdf", "复制页面", "复制按钮", "复制 markdown", "复制为 markdown", "以 markdown 查看", "上下文菜单", "页面菜单", "AI 菜单", "AI 操作", "打开于", "下载 pdf", "导出 pdf", "询问 AI", "openapi", "下载规范"] --- diff --git a/zh/ai/llmstxt.mdx b/zh/ai/llmstxt.mdx index 4755a8ce0a..172fd4f022 100644 --- a/zh/ai/llmstxt.mdx +++ b/zh/ai/llmstxt.mdx @@ -1,6 +1,6 @@ --- title: "llms.txt" -description: "自动生成 llms.txt 和 llms-full.txt 文件，使 ChatGPT 和 Claude 等 AI 工具能够索引并理解你的文档。" +description: "自动生成 llms.txt 和 llms-full.txt 文件，使 ChatGPT 和 Claude 等 AI 工具能够索引并理解你的文档。本文介绍 AI 工具与 Mintlify 文档的集成方式和使用场景，帮助你配置 AI 工作流并维护内容。这些说明适合开发者和文档维护者查阅。" keywords: ["llms.txt", "LLM 索引编入", "AEO", "GEO", "内容发现"] boost: 3 --- diff --git a/zh/ai/markdown-export.mdx b/zh/ai/markdown-export.mdx index 9a50c793f3..f4d28f59e1 100644 --- a/zh/ai/markdown-export.mdx +++ b/zh/ai/markdown-export.mdx @@ -1,6 +1,6 @@ --- title: "Markdown 导出" -description: "将文档页面导出为整洁的 Markdown 格式，用于 AI 工具、LLM 集成和自动化内容处理工作流程。" +description: "将文档页面导出为整洁的 Markdown 格式，用于 AI 工具、LLM 集成和自动化内容处理工作流程。本文介绍 AI 工具与 Mintlify 文档的集成方式和使用场景，帮助你配置 AI 工作流并维护内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["markdown", "token 效率", "AI 处理"] --- diff --git a/zh/ai/mintlify-mcp.mdx b/zh/ai/mintlify-mcp.mdx index d3b860ab12..985eef6256 100644 --- a/zh/ai/mintlify-mcp.mdx +++ b/zh/ai/mintlify-mcp.mdx @@ -1,7 +1,7 @@ --- title: "管理员 Model Context Protocol (MCP) 服务器" sidebarTitle: "管理员 MCP" -description: "让 Claude、ChatGPT 和 Cursor 等 AI 工具获得对你的 Mintlify 内容和控制台的写入权限，从而编辑页面、更新设置并提交 PR。" +description: "让 Claude、ChatGPT 和 Cursor 等 AI 工具获得对你的 Mintlify 内容和控制台的写入权限，从而编辑页面、更新设置并提交 PR。本页补充「管理员 Model Context Protocol (MCP) 服务器」的相关概念和使用要点。" keywords: ["MCP", "写入权限", "AI", "编辑", "Claude", "ChatGPT", "Cursor", "branch", "pull request"] --- diff --git a/zh/ai/model-context-protocol.mdx b/zh/ai/model-context-protocol.mdx index acb485d655..b0c2915612 100644 --- a/zh/ai/model-context-protocol.mdx +++ b/zh/ai/model-context-protocol.mdx @@ -1,6 +1,6 @@ --- title: "Model Context Protocol (MCP)（模型上下文协议）" -description: "将 Claude、Cursor、ChatGPT 等 AI 工具连接到托管的搜索 MCP 服务器，让它们能够搜索并检索你站点上的文档内容和 API 端点。" +description: "将 Claude、Cursor、ChatGPT 等 AI 工具连接到托管的搜索 MCP 服务器，让它们能够搜索并检索你站点上的文档内容和 API 端点。本页补充「Model Context Protocol (MCP)（模型上下文协议）」的相关概念和使用要点。" keywords: ["MCP", "AI 工具", "Claude", "Cursor"] --- diff --git a/zh/ai/skillmd.mdx b/zh/ai/skillmd.mdx index 0a5d58591b..2ec61f8659 100644 --- a/zh/ai/skillmd.mdx +++ b/zh/ai/skillmd.mdx @@ -1,6 +1,6 @@ --- title: "skill.md" -description: "通过自动生成的 skill.md 能力文件，让你的文档随时可供 AI 智能体使用，并向其描述产品可用的能力。" +description: "通过自动生成的 skill.md 能力文件，让你的文档随时可供 AI 智能体使用，并向其描述产品可用的能力。本文介绍 AI 工具与 Mintlify 文档的集成方式和使用场景，帮助你配置 AI 工作流并维护内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["AI 智能体", "技能", "智能体技能", "智能体"] boost: 3 --- diff --git a/zh/ai/slack-bot.mdx b/zh/ai/slack-bot.mdx index 55a16528e1..6785a8b6a3 100644 --- a/zh/ai/slack-bot.mdx +++ b/zh/ai/slack-bot.mdx @@ -1,6 +1,6 @@ --- title: "Slack 机器人" -description: "设置一个 Slack 机器人，以你的文档作为知识库回答团队问题，并提供来源引用和后续跟进。" +description: "设置一个 Slack 机器人，以你的文档作为知识库回答团队问题，并提供来源引用和后续跟进。本文介绍 AI 工具与 Mintlify 文档的集成方式和使用场景，帮助你配置 AI 工作流并维护内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["bot", "workspace", "Q&A", "Slack", "app"] --- diff --git a/zh/api-playground/adding-sdk-examples.mdx b/zh/api-playground/adding-sdk-examples.mdx index 0033e99365..2041b3746b 100644 --- a/zh/api-playground/adding-sdk-examples.mdx +++ b/zh/api-playground/adding-sdk-examples.mdx @@ -1,6 +1,6 @@ --- title: "添加 SDK 示例" -description: "为你的 API 文档添加 SDK 代码示例，使用 Speakeasy 和 Stainless 自动生成的多语言示例。" +description: "为你的 API 文档添加 SDK 代码示例，使用 Speakeasy 和 Stainless 自动生成的多语言示例。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["x-codeSamples", "SDK examples"] --- diff --git a/zh/api-playground/asyncapi-setup.mdx b/zh/api-playground/asyncapi-setup.mdx index 86699889f2..ea741d43b7 100644 --- a/zh/api-playground/asyncapi-setup.mdx +++ b/zh/api-playground/asyncapi-setup.mdx @@ -1,6 +1,6 @@ --- title: "AsyncAPI 配置" -description: "使用 AsyncAPI 规范文件设置实时 WebSocket 文档，生成交互式频道和消息参考页面。" +description: "使用 AsyncAPI 规范文件设置实时 WebSocket 文档，生成交互式频道和消息参考页面。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["asyncapi", "websocket"] --- diff --git a/zh/api-playground/complex-data-types.mdx b/zh/api-playground/complex-data-types.mdx index 446561260e..bfdb59857a 100644 --- a/zh/api-playground/complex-data-types.mdx +++ b/zh/api-playground/complex-data-types.mdx @@ -1,6 +1,6 @@ --- title: "复杂数据类型" -description: "使用 oneOf、anyOf 和 allOf 关键字描述具有灵活 schema 的 API，支持可选属性、多态性和多种数据格式。" +description: "使用 oneOf、anyOf 和 allOf 关键字描述具有灵活 schema 的 API，支持可选属性、多态性和多种数据格式。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["oneOf", "anyOf", "allOf", "schema composition", "polymorphic schemas"] --- diff --git a/zh/api-playground/graphql-setup.mdx b/zh/api-playground/graphql-setup.mdx index 7ad6e1b803..e8dd70e84c 100644 --- a/zh/api-playground/graphql-setup.mdx +++ b/zh/api-playground/graphql-setup.mdx @@ -1,6 +1,6 @@ --- title: "GraphQL 设置" -description: "从 schema 定义文件为你的 GraphQL API 生成参考页面，包含相互链接的类型以及示例 query、mutation 和响应。" +description: "从 schema 定义文件为你的 GraphQL API 生成参考页面，包含相互链接的类型以及示例 query、mutation 和响应。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["graphql", "schema", "sdl"] --- diff --git a/zh/api-playground/managing-page-visibility.mdx b/zh/api-playground/managing-page-visibility.mdx index 8643e7ca8f..552edfc058 100644 --- a/zh/api-playground/managing-page-visibility.mdx +++ b/zh/api-playground/managing-page-visibility.mdx @@ -1,6 +1,6 @@ --- title: "管理页面可见性" -description: "通过隐藏、过滤或整理自动生成的 OpenAPI 页面，控制哪些 API 端点出现在文档导航中。" +description: "通过隐藏、过滤或整理自动生成的 OpenAPI 页面，控制哪些 API 端点出现在文档导航中。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["x-hidden", "x-excluded", "隐藏端点", "页面可见性", "内部端点"] --- diff --git a/zh/api-playground/mdx-setup.mdx b/zh/api-playground/mdx-setup.mdx index 4592c9a2fd..96b06acaa6 100644 --- a/zh/api-playground/mdx-setup.mdx +++ b/zh/api-playground/mdx-setup.mdx @@ -1,6 +1,6 @@ --- title: "手动创建 API 文档页面" -description: "当你需要完全控制布局时，使用 MDX 文件手动创建 API 参考页面，适用于小型 API、原型开发或自定义文档。" +description: "当你需要完全控制布局时，使用 MDX 文件手动创建 API 参考页面，适用于小型 API、原型开发或自定义文档。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["API 文档", "端点文档"] --- diff --git a/zh/api-playground/multiple-responses.mdx b/zh/api-playground/multiple-responses.mdx index f5bc1125fa..ab14ecf81f 100644 --- a/zh/api-playground/multiple-responses.mdx +++ b/zh/api-playground/multiple-responses.mdx @@ -1,6 +1,6 @@ --- title: "多种响应" -description: "为 API 端点记录多种响应变体，包括成功和错误情况，并附带状态码和示例 payload。" +description: "为 API 端点记录多种响应变体，包括成功和错误情况，并附带状态码和示例 payload。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["response examples", "conditional responses", "response variations", "examples property"] --- diff --git a/zh/api-playground/openapi-setup.mdx b/zh/api-playground/openapi-setup.mdx index e6e26fe1ff..ecfbbd0cd2 100644 --- a/zh/api-playground/openapi-setup.mdx +++ b/zh/api-playground/openapi-setup.mdx @@ -1,6 +1,6 @@ --- title: "OpenAPI 设置" -description: "从 OpenAPI 规范文件生成交互式 API 文档，自动创建端点页面、请求构建器和导航结构。" +description: "从 OpenAPI 规范文件生成交互式 API 文档，自动创建端点页面、请求构建器和导航结构。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["OpenAPI", "API 规范", "Swagger"] --- diff --git a/zh/api-playground/overview.mdx b/zh/api-playground/overview.mdx index e1c4e95511..e8ac10ca49 100644 --- a/zh/api-playground/overview.mdx +++ b/zh/api-playground/overview.mdx @@ -1,6 +1,6 @@ --- title: "操作台" -description: "让开发者在文档中直接测试 API 端点，交互式演练场可发送真实请求并显示响应结果。" +description: "让开发者在文档中直接测试 API 端点，交互式演练场可发送真实请求并显示响应结果。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["交互式", "API", "端点测试", "实时 API 请求", "请求构造器"] boost: 3 --- diff --git a/zh/api-playground/troubleshooting.mdx b/zh/api-playground/troubleshooting.mdx index 6d4b1c6768..209f1c0b58 100644 --- a/zh/api-playground/troubleshooting.mdx +++ b/zh/api-playground/troubleshooting.mdx @@ -1,6 +1,6 @@ --- title: "故障排查" -description: "排查 API 演练场配置中的常见问题，包括 OpenAPI 验证错误、缺失的端点和身份验证问题。" +description: "排查 API 演练场配置中的常见问题，包括 OpenAPI 验证错误、缺失的端点和身份验证问题。本文说明 API 演练场的使用方法和配置要点，方便开发者测试接口并验证响应。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["API 故障排查", "OpenAPI 无效", "配置问题"] boost: 3 --- diff --git a/zh/api-playground/websocket-playground.mdx b/zh/api-playground/websocket-playground.mdx index df810ac52c..8a2c671b6d 100644 --- a/zh/api-playground/websocket-playground.mdx +++ b/zh/api-playground/websocket-playground.mdx @@ -1,5 +1,5 @@ --- -title: "演练场" -description: "在文档中添加交互式 WebSocket 演练场，让用户可以测试实时连接、发送消息并查看事件流。" +title: "WebSocket 交互式演练场" +description: "在文档中添加交互式 WebSocket 演练场，让用户测试实时连接、发送消息并查看事件流。本文介绍演练场的配置和使用方法，帮助开发者验证实时 API 集成、调试频道事件并维护相关文档，适合需要展示实时通信能力的团队查阅。你可以使用它演示频道消息、检查连接行为，并为 API 使用者提供更直观的调试体验。" asyncapi: "/asyncapi.yaml channelOne" --- \ No newline at end of file diff --git a/zh/api/analytics/feedback-by-page.mdx b/zh/api/analytics/feedback-by-page.mdx index 9dacd32526..70a00b4bdd 100644 --- a/zh/api/analytics/feedback-by-page.mdx +++ b/zh/api/analytics/feedback-by-page.mdx @@ -1,6 +1,6 @@ --- title: "按页面获取反馈" -description: "按页面获取 Mintlify 文档的用户反馈汇总数据，包括每个页面的赞、踩、代码片段复制次数以及反馈总数。" +description: "导出 Mintlify 文档按页面汇总的用户反馈数据，查看赞、踩、代码片段复制次数和反馈总数，并按日期、来源与状态筛选结果，帮助分析内容质量与读者意见。结果支持分页和定期导出，适合通过 Analytics API 比较不同页面表现，定位需要改进的文档内容并跟踪反馈趋势。" openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page keywords: ["analytics", "反馈", "导出", "按页面", "汇总"] --- diff --git a/zh/api/analytics/searches.mdx b/zh/api/analytics/searches.mdx index 44f1992d8b..859519ba8d 100644 --- a/zh/api/analytics/searches.mdx +++ b/zh/api/analytics/searches.mdx @@ -1,6 +1,6 @@ --- title: "获取搜索查询" -description: "导出 Mintlify 文档的搜索查询记录，包含每个搜索词的命中数、点击率以及最近一次被搜索的时间，便于分析用户搜索行为。" +description: "导出 Mintlify 文档的搜索查询记录，查看每个搜索词的命中数、点击率和最近搜索时间，分析用户搜索行为与内容需求。结果支持按日期范围筛选并使用游标分页，适合通过 Analytics API 发现热门问题、识别缺失内容、优化页面结构和改进站内搜索体验，为内容团队制定更新计划。" openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/searches keywords: ["analytics", "搜索", "导出", "查询", "搜索词"] --- diff --git a/zh/api/analytics/views.mdx b/zh/api/analytics/views.mdx index d9f81ab715..f01f66714a 100644 --- a/zh/api/analytics/views.mdx +++ b/zh/api/analytics/views.mdx @@ -1,6 +1,6 @@ --- title: "获取页面浏览量" -description: "获取 Mintlify 文档的页面浏览量统计，按路径细分，并区分来自真实用户与 AI 爬虫或代理的流量来源。" +description: "导出 Mintlify 文档的页面浏览量统计，按页面路径查看站点总量和明细，并区分真实用户、AI 爬虫与代理流量。结果支持按日期范围筛选和偏移量分页，适合通过 Analytics API 比较页面表现、识别热门内容、分析访问趋势并优化文档信息架构，为内容团队制定更新计划。" openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/views keywords: ["analytics", "浏览量", "页面浏览量", "流量", "导出"] --- diff --git a/zh/api/analytics/visitors.mdx b/zh/api/analytics/visitors.mdx index b338f670d7..a6845ab8ad 100644 --- a/zh/api/analytics/visitors.mdx +++ b/zh/api/analytics/visitors.mdx @@ -1,6 +1,6 @@ --- title: "获取唯一访客" -description: "获取 Mintlify 文档的唯一访客数量，按路径与站点整体统计，并区分真实用户流量与 AI 爬虫或代理产生的访问。" +description: "导出 Mintlify 文档的唯一访客统计，按页面路径查看站点总量和明细，并区分真实用户、AI 爬虫与代理流量。结果支持按日期范围筛选和偏移量分页，适合通过 Analytics API 衡量内容覆盖范围、比较页面表现、分析访问趋势并优化文档体验，为内容团队制定更新计划。" openapi: /zh/analytics.openapi.json GET /v1/analytics/{projectId}/visitors keywords: ["analytics", "访客", "唯一访客", "流量", "导出"] --- diff --git a/zh/api/introduction.mdx b/zh/api/introduction.mdx index 9d21848e8a..b927d35dcc 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -1,6 +1,6 @@ --- -title: "简介" -description: "使用 Mintlify REST API 触发部署、嵌入 AI 助手、导出 Analytics 数据，并以编程方式管理文档。" +title: "Mintlify REST API 简介" +description: "使用 Mintlify REST API 触发部署、嵌入 AI 助手、导出 Analytics 数据，并以编程方式管理文档。本页介绍 API 端点、身份验证、部署自动化和常见集成方式，帮助开发者维护可靠的文档工作流。适合需要以代码管理部署、分析和内容发布的团队查阅。" keywords: ["REST API", "endpoints", "API keys"] boost: 3 --- diff --git a/zh/api/static-export/overview.mdx b/zh/api/static-export/overview.mdx index 4cbe17dd5f..106e86251a 100644 --- a/zh/api/static-export/overview.mdx +++ b/zh/api/static-export/overview.mdx @@ -1,6 +1,6 @@ --- title: "静态导出" -description: "通过 Mintlify REST API 生成自包含的文档静态导出，并以单个包的形式下载。" +description: "通过 Mintlify REST API 生成自包含的文档静态导出，并以单个包的形式下载。本文说明 API 端点、请求参数和返回结果，方便开发者在 Mintlify 项目中快速集成并排查问题。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["static export", "static site", "bundle", "self-host", "enterprise"] --- diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index 9a7ba6297e..81420b46df 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -1,6 +1,6 @@ --- title: "配置 AI 助手" -description: "在 Mintlify 仪表盘中配置 AI 助手：启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。" +description: "在 Mintlify 仪表盘中配置 AI 助手：启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。本文说明 AI 助手的配置方式和使用场景，帮助你改善文档发现和用户支持。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["assistant", "设置", "转接", "机器人防护", "计费"] --- diff --git a/zh/assistant/customize.mdx b/zh/assistant/customize.mdx index 47cd005eb8..d404edc043 100644 --- a/zh/assistant/customize.mdx +++ b/zh/assistant/customize.mdx @@ -1,6 +1,6 @@ --- title: "自定义 AI 助手行为" -description: "通过在文档中添加包含系统指令的 Assistant.md 文件来自定义 AI 助手，塑造其语气、角色定位、关注领域、回答格式与整体响应行为。" +description: "通过在文档中添加包含系统指令的 Assistant.md 文件来自定义 AI 助手，塑造其语气、角色定位、关注领域、回答格式与整体响应行为。本文说明 AI 助手的配置方式和使用场景，帮助你改善文档发现和用户支持。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["assistant", "自定义指令", "Assistant.md", "系统提示", "角色"] --- diff --git a/zh/assistant/index.mdx b/zh/assistant/index.mdx index 99bd864bae..2c81c0ec5e 100644 --- a/zh/assistant/index.mdx +++ b/zh/assistant/index.mdx @@ -1,6 +1,6 @@ --- title: "AI 助手" -description: "为你的文档站点添加由 AI 驱动的聊天助手，实时回答用户问题、引用文档来源、按需生成代码示例，并支持自定义指令与多模态输入。" +description: "为你的文档站点添加由 AI 驱动的聊天助手，实时回答用户问题、引用文档来源、按需生成代码示例，并支持自定义指令与多模态输入。本文说明 AI 助手的配置方式和使用场景，帮助你改善文档发现和用户支持。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["聊天", "用户支持", "多模态"] boost: 3 --- diff --git a/zh/assistant/skills.mdx b/zh/assistant/skills.mdx index ac56fbfbd4..d398eb4547 100644 --- a/zh/assistant/skills.mdx +++ b/zh/assistant/skills.mdx @@ -1,6 +1,6 @@ --- title: "添加 assistant skills" -description: "编写专家级 Markdown 指南（skills），AI 助手在需要时按需加载，使用你的团队手写、有明确观点的内容来回答用户问题并遵循内部规范。" +description: "编写专家级 Markdown 指南（skills），AI 助手在需要时按需加载，使用你的团队手写、有明确观点的内容来回答用户问题并遵循内部规范。本文说明 AI 助手的配置方式和使用场景，帮助你改善文档发现和用户支持。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["assistant", "skills", "loadSkill", "指南", "系统提示"] --- diff --git a/zh/assistant/use.mdx b/zh/assistant/use.mdx index dc03e6143c..64f0809edf 100644 --- a/zh/assistant/use.mdx +++ b/zh/assistant/use.mdx @@ -1,6 +1,6 @@ --- title: "使用 AI 助手" -description: "通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手，在本地预览环境中测试助手响应、指令与自定义配置的行为。" +description: "通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手，在本地预览环境中测试助手响应、指令与自定义配置的行为。本文说明 AI 助手的配置方式和使用场景，帮助你改善文档发现和用户支持。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["assistant", "键盘快捷键", "文件附件", "本地预览", "URL 参数"] --- diff --git a/zh/assistant/widget.mdx b/zh/assistant/widget.mdx index a0cc1a62a2..a4412a8222 100644 --- a/zh/assistant/widget.mdx +++ b/zh/assistant/widget.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify 小组件" sidebarTitle: "小组件" -description: "安装并配置 Mintlify 小组件,在任意网站或 Web 应用中嵌入基于你的内容训练的 AI 助手。" +description: "安装并配置 Mintlify 小组件,在任意网站或 Web 应用中嵌入基于你的内容训练的 AI 助手。本文说明 AI 助手的配置方式和使用场景，帮助你改善文档发现和用户支持。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["assistant", "chat", "embed"] mode: "wide" --- diff --git a/zh/automations/create.mdx b/zh/automations/create.mdx index eabad6ac42..3ae9a1375c 100644 --- a/zh/automations/create.mdx +++ b/zh/automations/create.mdx @@ -1,6 +1,6 @@ --- title: "创建自定义自动化" -description: "创建 Mintlify 自动化，按计划、仓库推送或集成事件运行。添加上下文仓库和自定义 agent 提示词。" +description: "创建 Mintlify 自动化，按计划、仓库推送或集成事件运行。添加上下文仓库和自定义 agent 提示词。本文介绍 Mintlify 自动化的配置、触发方式和运行管理，帮助团队自动维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["automation", "automate", "cron", "agent", "custom automation"] --- diff --git a/zh/automations/index.mdx b/zh/automations/index.mdx index 0b0eaf2854..13f97873b6 100644 --- a/zh/automations/index.mdx +++ b/zh/automations/index.mdx @@ -1,7 +1,7 @@ --- title: "自动化概览" sidebarTitle: "概览" -description: "使用 Mintlify 自动化，自动维护内容：按计划、在仓库推送时或在已连接集成的事件上运行 agent。" +description: "使用 Mintlify 自动化，自动维护内容：按计划、在仓库推送时或在已连接集成的事件上运行 agent。本文介绍 Mintlify 自动化的配置、触发方式和运行管理，帮助团队自动维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["automation", "automate", "cron", "agent", "automations"] boost: 5 --- diff --git a/zh/automations/manage.mdx b/zh/automations/manage.mdx index 94297e7d5d..a906dbac52 100644 --- a/zh/automations/manage.mdx +++ b/zh/automations/manage.mdx @@ -1,6 +1,6 @@ --- title: "管理自动化" -description: "从控制台启用、禁用、触发和删除自动化。配置仓库、计划和集成触发器、上下文仓库及 automerge。" +description: "从控制台启用、禁用、触发和删除自动化。配置仓库、计划和集成触发器、上下文仓库及 automerge。本文介绍 Mintlify 自动化的配置、触发方式和运行管理，帮助团队自动维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"] --- diff --git a/zh/automations/reference.mdx b/zh/automations/reference.mdx index f8cb86214b..20423f237f 100644 --- a/zh/automations/reference.mdx +++ b/zh/automations/reference.mdx @@ -1,6 +1,6 @@ --- title: "预定义自动化" -description: "所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。" +description: "所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。本文介绍 Mintlify 自动化的配置、触发方式和运行管理，帮助团队自动维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["predefined", "automation", "default"] --- diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 736a7a304e..0ec08c9c4b 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify CLI 命令参考" sidebarTitle: "命令参考" -description: "Mintlify CLI 所有命令和选项的完整参考，涵盖 mint dev、mint build、mint validate、mint broken-links、mint signup 等命令的用法与标志说明。" +description: "Mintlify CLI 所有命令和选项的完整参考，涵盖 mint dev、mint build、mint validate、mint broken-links、mint signup 等命令的用法与标志说明。本页补充「Mintlify CLI 命令参考」的相关概念和使用要点。" keywords: ["CLI", "mint", "命令", "选项", "参考"] boost: 3 --- diff --git a/zh/cli/preview.mdx b/zh/cli/preview.mdx index 6f4577e773..3adea2d8c7 100644 --- a/zh/cli/preview.mdx +++ b/zh/cli/preview.mdx @@ -1,6 +1,6 @@ --- title: "本地预览" -description: "使用 mint dev 运行 Mintlify 文档站点的本地预览，支持实时重载、全文搜索和 AI 助手。" +description: "使用 mint dev 运行 Mintlify 文档站点的本地预览，支持实时重载、全文搜索和 AI 助手。本文介绍 Mintlify CLI 的使用步骤和常见工作流，帮助开发者在本地预览并维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["mint dev", "本地预览", "localhost", "mint login", "搜索", "助手"] --- diff --git a/zh/components/accordions.mdx b/zh/components/accordions.mdx index 8256a79455..3ca75b9bdb 100644 --- a/zh/components/accordions.mdx +++ b/zh/components/accordions.mdx @@ -1,6 +1,6 @@ --- title: "折叠面板" -description: "使用折叠面板组件在文档中显示和隐藏内容区块、组织相关信息，并实现渐进式信息披露。" +description: "使用折叠面板组件在文档中显示和隐藏内容区块、组织相关信息，并实现渐进式信息披露。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["accordions", "collapsible content", "expandable sections", "progressive disclosure"] boost: 3 --- diff --git a/zh/components/badge.mdx b/zh/components/badge.mdx index 6eda912925..8247657787 100644 --- a/zh/components/badge.mdx +++ b/zh/components/badge.mdx @@ -1,6 +1,6 @@ --- title: "徽章" -description: "使用徽章组件高亮显示状态指示器、版本标签或内联元数据，支持自定义颜色和悬停提示。" +description: "使用徽章组件高亮显示状态指示器、版本标签或内联元数据，支持自定义颜色和悬停提示。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["badge", "label", "tag", "status", "indicator"] boost: 3 --- diff --git a/zh/components/banner.mdx b/zh/components/banner.mdx index 73a596cea3..4734b2456a 100644 --- a/zh/components/banner.mdx +++ b/zh/components/banner.mdx @@ -1,6 +1,6 @@ --- title: "横幅" -description: "在文档站点顶部添加可关闭的横幅，用于显示重要公告、发行说明或通知。" +description: "在文档站点顶部添加可关闭的横幅，用于显示重要公告、发行说明或通知。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["banner", "announcements", "site-wide"] boost: 3 --- diff --git a/zh/components/callouts.mdx b/zh/components/callouts.mdx index a7c9b49cfb..7d40de1653 100644 --- a/zh/components/callouts.mdx +++ b/zh/components/callouts.mdx @@ -1,6 +1,6 @@ --- title: "标注框" -description: "添加 info、note、tip、check、warning、danger 和自定义标注框组件，在文档中突出显示重要信息。" +description: "添加 info、note、tip、check、warning、danger 和自定义标注框组件，在文档中突出显示重要信息。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"] boost: 3 --- diff --git a/zh/components/cards.mdx b/zh/components/cards.mdx index 73d77e8037..dfcafe0d47 100644 --- a/zh/components/cards.mdx +++ b/zh/components/cards.mdx @@ -1,6 +1,6 @@ --- title: "卡片" -description: "使用卡片组件以可视化容器的形式展示链接、图标、图片和分组内容，从而组织导航。" +description: "使用卡片组件以可视化容器的形式展示链接、图标、图片和分组内容，从而组织导航。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["卡片", "可视化容器"] boost: 3 --- diff --git a/zh/components/code-groups.mdx b/zh/components/code-groups.mdx index 3952c31502..e89df1f2fb 100644 --- a/zh/components/code-groups.mdx +++ b/zh/components/code-groups.mdx @@ -1,6 +1,6 @@ --- title: "代码分组" -description: "使用 CodeGroup 组件在标签页界面中展示多个代码示例，让读者可以比较不同编程语言的实现方式。" +description: "使用 CodeGroup 组件在标签页界面中展示多个代码示例，让读者可以比较不同编程语言的实现方式。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["code groups", "tabbed code", "multi-language examples", "CodeGroup"] --- diff --git a/zh/components/color.mdx b/zh/components/color.mdx index bb8f137f72..b067df1877 100644 --- a/zh/components/color.mdx +++ b/zh/components/color.mdx @@ -1,6 +1,6 @@ --- title: "颜色" -description: "使用颜色组件展示带有十六进制值和点击复制功能的色板，适用于设计系统和品牌规范文档。" +description: "使用颜色组件展示带有十六进制值和点击复制功能的色板，适用于设计系统和品牌规范文档。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["color", "palette", "colors", "design system", "hex", "rgb", "rgba", "hsl", "oklch"] boost: 3 --- diff --git a/zh/components/columns.mdx b/zh/components/columns.mdx index 34961c8fa1..8f3e366c5c 100644 --- a/zh/components/columns.mdx +++ b/zh/components/columns.mdx @@ -1,6 +1,6 @@ --- title: "列" -description: "使用 columns 组件将卡片和其他组件排列在响应式多列网格布局中，支持自定义列数。" +description: "使用 columns 组件将卡片和其他组件排列在响应式多列网格布局中，支持自定义列数。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ['卡片分组', '网格布局', '多列布局'] boost: 3 --- diff --git a/zh/components/examples.mdx b/zh/components/examples.mdx index 7d7d30d459..afed54c75b 100644 --- a/zh/components/examples.mdx +++ b/zh/components/examples.mdx @@ -1,6 +1,6 @@ --- title: "示例" -description: "在桌面设备右侧边栏面板中展示代码示例，与 API 文档并排显示请求和响应样本。" +description: "在桌面设备右侧边栏面板中展示代码示例，与 API 文档并排显示请求和响应样本。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"] boost: 3 --- diff --git a/zh/components/expandables.mdx b/zh/components/expandables.mdx index 920d06b471..012f48c39e 100644 --- a/zh/components/expandables.mdx +++ b/zh/components/expandables.mdx @@ -1,6 +1,6 @@ --- title: "可展开项" -description: "使用可展开组件在 API 文档中切换嵌套对象属性的显示，展示请求和响应对象的子字段。" +description: "使用可展开组件在 API 文档中切换嵌套对象属性的显示，展示请求和响应对象的子字段。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["expandables", "nested properties", "expandable fields", "toggle content"] boost: 3 --- diff --git a/zh/components/fields.mdx b/zh/components/fields.mdx index 0a5540ef4b..8cc87030f5 100644 --- a/zh/components/fields.mdx +++ b/zh/components/fields.mdx @@ -1,6 +1,6 @@ --- title: "字段" -description: "使用 ParamField 和 ResponseField 组件，通过类型、默认值和验证规则为 API 请求和响应参数编写文档。" +description: "使用 ParamField 和 ResponseField 组件，通过类型、默认值和验证规则为 API 请求和响应参数编写文档。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。" keywords: ["ParamField", "ResponseField", "request parameters", "response documentation"] boost: 3 --- diff --git a/zh/components/frames.mdx b/zh/components/frames.mdx index 21ab0ab10a..b1e7604c87 100644 --- a/zh/components/frames.mdx +++ b/zh/components/frames.mdx @@ -1,6 +1,6 @@ --- title: "Frames" -description: "使用 frame 组件为图片、视频和其他内容添加样式化边框、说明文字和视觉强调效果。" +description: "使用 frame 组件为图片、视频和其他内容添加样式化边框、说明文字和视觉强调效果。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["image frames", "visual emphasis", "captions", "border"] boost: 3 --- diff --git a/zh/components/icons.mdx b/zh/components/icons.mdx index b36f3482fa..83019ed45b 100644 --- a/zh/components/icons.mdx +++ b/zh/components/icons.mdx @@ -1,6 +1,6 @@ --- title: "图标" -description: "使用图标组件将 Font Awesome、Lucide、Tabler 或自定义来源的图标添加到文档页面，支持尺寸和颜色选项。" +description: "使用图标组件将 Font Awesome、Lucide、Tabler 或自定义来源的图标添加到文档页面，支持尺寸和颜色选项。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"] boost: 3 --- diff --git a/zh/components/index.mdx b/zh/components/index.mdx index d6f60f885f..e9d0cd8aa6 100644 --- a/zh/components/index.mdx +++ b/zh/components/index.mdx @@ -1,6 +1,6 @@ --- -title: "概览" -description: "浏览 Mintlify 完整组件库，包含适用于 MDX 页面的布局、强调、API 文档和导航元素组件。" +title: "Mintlify 组件概览" +description: "浏览 Mintlify 完整组件库，包含适用于 MDX 页面的布局、强调、API 文档和导航元素组件。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["MDX 组件", "文档组件", "UI 组件", "组件"] boost: 3 diff --git a/zh/components/mermaid-diagrams.mdx b/zh/components/mermaid-diagrams.mdx index db9d6145b1..2723f614ae 100644 --- a/zh/components/mermaid-diagrams.mdx +++ b/zh/components/mermaid-diagrams.mdx @@ -1,6 +1,6 @@ --- title: "Mermaid" -description: "使用 Mermaid 语法在文档中创建流程图、序列图和其他可视化图表，并自动渲染。" +description: "使用 Mermaid 语法在文档中创建流程图、序列图和其他可视化图表，并自动渲染。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Mermaid", "flowcharts", "diagrams"] boost: 3 --- diff --git a/zh/components/panel.mdx b/zh/components/panel.mdx index d134aa363c..0e59decde6 100644 --- a/zh/components/panel.mdx +++ b/zh/components/panel.mdx @@ -1,6 +1,6 @@ --- title: "Panel" -description: "自定义文档页面右侧面板的内容，用于显示补充信息、示例或导航元素。" +description: "自定义文档页面右侧面板的内容，用于显示补充信息、示例或导航元素。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["sidebar"] boost: 3 --- diff --git a/zh/components/prompt.mdx b/zh/components/prompt.mdx index a612352108..db51b9ad33 100644 --- a/zh/components/prompt.mdx +++ b/zh/components/prompt.mdx @@ -1,6 +1,6 @@ --- title: "提示" -description: "展示预置的 AI 提示，提供一键复制和 Cursor 集成按钮，方便用户在 AI 工具中快速使用。" +description: "展示预置的 AI 提示，提供一键复制和 Cursor 集成按钮，方便用户在 AI 工具中快速使用。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["提示", "AI", "cursor", "复制", "提示卡片"] boost: 3 --- diff --git a/zh/components/responses.mdx b/zh/components/responses.mdx index 63e29ba1bf..e296d4a59b 100644 --- a/zh/components/responses.mdx +++ b/zh/components/responses.mdx @@ -1,6 +1,6 @@ --- title: "响应字段" -description: "使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。" +description: "使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["API 输出", "返回值", "响应结构"] --- diff --git a/zh/components/steps.mdx b/zh/components/steps.mdx index fc37cc5979..b1574aa26c 100644 --- a/zh/components/steps.mdx +++ b/zh/components/steps.mdx @@ -1,6 +1,6 @@ --- title: "步骤" -description: "使用 steps 组件创建带编号的分步流程，引导用户完成顺序任务、教程和设置工作流。" +description: "使用 steps 组件创建带编号的分步流程，引导用户完成顺序任务、教程和设置工作流。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"] boost: 3 --- diff --git a/zh/components/tabs.mdx b/zh/components/tabs.mdx index 728d9d4160..487a7497a7 100644 --- a/zh/components/tabs.mdx +++ b/zh/components/tabs.mdx @@ -1,6 +1,6 @@ --- title: "选项卡" -description: "使用 tab 组件将内容组织成可切换的面板，用于展示不同选项、平台版本或语言示例。" +description: "使用 tab 组件将内容组织成可切换的面板，用于展示不同选项、平台版本或语言示例。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["标签式内容", "内容面板", "可切换内容"] boost: 3 --- diff --git a/zh/components/tiles.mdx b/zh/components/tiles.mdx index e73faaa214..8a7b2182f3 100644 --- a/zh/components/tiles.mdx +++ b/zh/components/tiles.mdx @@ -1,6 +1,6 @@ --- title: "磁贴" -description: "使用 tiles 组件在响应式网格布局中展示带有图片缩略图、标题和描述的视觉预览。" +description: "使用 tiles 组件在响应式网格布局中展示带有图片缩略图、标题和描述的视觉预览。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["磁贴", "视觉预览", "网格", "展示"] boost: 3 --- diff --git a/zh/components/tooltips.mdx b/zh/components/tooltips.mdx index 5e1881a9a8..516e837d19 100644 --- a/zh/components/tooltips.mdx +++ b/zh/components/tooltips.mdx @@ -1,6 +1,6 @@ --- title: "工具提示" -description: "添加工具提示，在用户悬停在文档中的术语、缩写或技术概念上时显示上下文定义和解释。" +description: "添加工具提示，在用户悬停在文档中的术语、缩写或技术概念上时显示上下文定义和解释。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"] boost: 3 --- diff --git a/zh/components/tree.mdx b/zh/components/tree.mdx index fb04d75b61..5345d7d4ea 100644 --- a/zh/components/tree.mdx +++ b/zh/components/tree.mdx @@ -1,6 +1,6 @@ --- title: "树" -description: "使用树组件显示带有可折叠节点和路径名语法高亮的层级文件与文件夹结构。" +description: "使用树组件显示带有可折叠节点和路径名语法高亮的层级文件与文件夹结构。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["树", "文件树", "文件夹结构", "层级导航", "文件系统"] boost: 3 --- diff --git a/zh/components/update.mdx b/zh/components/update.mdx index 52aa9215e4..17c6d516e9 100644 --- a/zh/components/update.mdx +++ b/zh/components/update.mdx @@ -1,6 +1,6 @@ --- title: "Update" -description: "使用 update 组件以带日期的结构化时间轴格式展示产品更新、发行说明和更新日志条目。" +description: "使用 update 组件以带日期的结构化时间轴格式展示产品更新、发行说明和更新日志条目。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["更新日志", "产品更新", "版本说明"] boost: 3 --- diff --git a/zh/components/view.mdx b/zh/components/view.mdx index 616acbc44c..e716991078 100644 --- a/zh/components/view.mdx +++ b/zh/components/view.mdx @@ -1,6 +1,6 @@ --- title: "视图" -description: "使用 view 组件为不同编程语言、框架或配置方案创建可切换的内容面板。" +description: "使用 view 组件为不同编程语言、框架或配置方案创建可切换的内容面板。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["选择器", "特定语言内容", "内容切换"] boost: 3 --- diff --git a/zh/components/visibility.mdx b/zh/components/visibility.mdx index cc08aacdae..bedbbaa9f0 100644 --- a/zh/components/visibility.mdx +++ b/zh/components/visibility.mdx @@ -1,6 +1,6 @@ --- title: "Visibility" -description: "使用 visibility 组件向网页界面上的人类用户和 Markdown 输出中的 AI 代理展示不同内容，实现条件渲染。" +description: "使用 visibility 组件向网页界面上的人类用户和 Markdown 输出中的 AI 代理展示不同内容，实现条件渲染。本文说明组件的使用方法、关键属性和注意事项，帮助你在 Mintlify 页面中快速应用并持续维护。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["visibility", "agents", "humans", "markdown", "AI", "conditional content"] boost: 3 --- diff --git a/zh/contact-support.mdx b/zh/contact-support.mdx index aafe49d98f..90bd23493f 100644 --- a/zh/contact-support.mdx +++ b/zh/contact-support.mdx @@ -1,6 +1,6 @@ --- title: "联系支持团队" -description: "联系 Mintlify 支持团队，获取文档站点的技术支持与账户帮助，包括初始配置、部署故障、订阅计费、企业销售咨询以及功能与集成相关问题。" +description: "联系 Mintlify 支持团队，获取文档站点的技术支持与账户帮助，包括初始配置、部署故障、订阅计费、企业销售咨询以及功能与集成相关问题。本文介绍如何联系 Mintlify 支持团队、准备问题信息并处理技术、账户和计费事项。这些说明适合开发者和文档维护者查阅。" ---
diff --git a/zh/create/changelogs.mdx b/zh/create/changelogs.mdx index 09685758e2..980123183d 100644 --- a/zh/create/changelogs.mdx +++ b/zh/create/changelogs.mdx @@ -1,6 +1,6 @@ --- title: "更新日志" -description: "创建包含基于日期条目、RSS 订阅支持和订阅者通知功能的产品更新日志，让用户及时了解最新动态。" +description: "创建包含基于日期条目、RSS 订阅支持和订阅者通知功能的产品更新日志，让用户及时了解最新动态。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["product updates", "release notes", "RSS"] boost: 3 --- diff --git a/zh/create/code.mdx b/zh/create/code.mdx index c7e3c84fd2..816b46e754 100644 --- a/zh/create/code.mdx +++ b/zh/create/code.mdx @@ -1,6 +1,6 @@ --- title: "格式化代码" -description: "在文档中格式化代码，支持语法高亮、行号、差异对比、复制按钮和 MDX 中的交互式代码组功能。" +description: "在文档中格式化代码，支持语法高亮、行号、差异对比、复制按钮和 MDX 中的交互式代码组功能。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["代码块", "语法高亮", "代码样式"] --- diff --git a/zh/create/files.mdx b/zh/create/files.mdx index fba8c360f9..0bfe251cc9 100644 --- a/zh/create/files.mdx +++ b/zh/create/files.mdx @@ -1,6 +1,6 @@ --- -title: "文件" -description: "从你的文档仓库提供图片、视频、PDF 和数据文件等静态资产，支持自动优化和 CDN 分发。" +title: "文档静态文件" +description: "从你的文档仓库提供图片、视频、PDF 和数据文件等静态资产，支持自动优化和 CDN 分发。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["静态资产","支持的文件类型"] boost: 3 --- diff --git a/zh/create/image-embeds.mdx b/zh/create/image-embeds.mdx index 152840fb77..deac3dd4fe 100644 --- a/zh/create/image-embeds.mdx +++ b/zh/create/image-embeds.mdx @@ -1,6 +1,6 @@ --- title: "图片与嵌入" -description: "在 MDX 页面中添加图片、嵌入 YouTube 视频和 iframe，以视觉和互动内容丰富文档。" +description: "在 MDX 页面中添加图片、嵌入 YouTube 视频和 iframe，以视觉和互动内容丰富文档。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["images", "videos", "iframes", "media", "svg"] --- diff --git a/zh/create/list-table.mdx b/zh/create/list-table.mdx index e009416c5c..ef6b08db05 100644 --- a/zh/create/list-table.mdx +++ b/zh/create/list-table.mdx @@ -1,6 +1,6 @@ --- title: "列表与表格" -description: "使用 Markdown 表格、有序列表、无序列表、嵌套结构和任务列表复选框在文档中呈现结构化数据。" +description: "使用 Markdown 表格、有序列表、无序列表、嵌套结构和任务列表复选框在文档中呈现结构化数据。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["有序列表", "无序列表", "Markdown 表格", "表格格式"] --- diff --git a/zh/create/personalization.mdx b/zh/create/personalization.mdx index 7c576521e2..f33c3fd83e 100644 --- a/zh/create/personalization.mdx +++ b/zh/create/personalization.mdx @@ -1,6 +1,6 @@ --- title: "个性化内容" -description: "根据用户身份验证数据、群组成员资格和自定义变量显示个性化内容，为不同受众量身定制文档。" +description: "根据用户身份验证数据、群组成员资格和自定义变量显示个性化内容，为不同受众量身定制文档。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["内容个性化", "个性化", "用户数据", "分组", "动态", "预填充"] --- diff --git a/zh/create/redirects.mdx b/zh/create/redirects.mdx index 951189aeb8..afe5d3f14d 100644 --- a/zh/create/redirects.mdx +++ b/zh/create/redirects.mdx @@ -1,6 +1,6 @@ --- title: "重定向" -description: "在 docs.json 中配置 URL 重定向规则，为已移动、重命名或删除的文档页面保留 SEO 排名，并防止读者遇到失效链接。" +description: "在 docs.json 中配置 URL 重定向规则，为已移动、重命名或删除的文档页面保留 SEO 排名，并防止读者遇到失效链接。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["redirects"] boost: 3 --- diff --git a/zh/create/reusable-snippets.mdx b/zh/create/reusable-snippets.mdx index eae1a5837a..7d35115cb3 100644 --- a/zh/create/reusable-snippets.mdx +++ b/zh/create/reusable-snippets.mdx @@ -1,6 +1,6 @@ --- title: "可复用片段" -description: "创建带有变量的可复用内容片段，在文档页面间保持一致性并减少 MDX 文件中的重复内容。" +description: "创建带有变量的可复用内容片段，在文档页面间保持一致性并减少 MDX 文件中的重复内容。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["content snippets", "reusable content", "variables"] --- diff --git a/zh/create/text.mdx b/zh/create/text.mdx index 85f957636a..94baf770a1 100644 --- a/zh/create/text.mdx +++ b/zh/create/text.mdx @@ -1,6 +1,6 @@ --- title: "文本格式" -description: "在 MDX 页面中使用 Markdown 标题、粗体、斜体、链接、引用块和其他内联样式选项格式化文档文本。" +description: "在 MDX 页面中使用 Markdown 标题、粗体、斜体、链接、引用块和其他内联样式选项格式化文档文本。本文介绍内容创建步骤和使用要点，帮助你高效编写并维护文档页面。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Markdown 格式", "文本样式", "标题", "锚点链接", "custom heading IDs"] --- diff --git a/zh/credits.mdx b/zh/credits.mdx index c8b0a927e7..1ac964c740 100644 --- a/zh/credits.mdx +++ b/zh/credits.mdx @@ -1,6 +1,6 @@ --- title: "积分定价" -description: "了解组织的积分余额如何运作、哪些功能会消耗积分，以及我们如何对积分套餐、超额使用和结转进行计费。" +description: "了解组织的积分余额如何运作、哪些功能会消耗积分，以及我们如何对积分套餐、超额使用和结转进行计费。本文说明积分的消耗方式、套餐规则和超额使用，帮助团队规划 Mintlify 的使用成本。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["积分", "计费", "定价", "组织", "assistant", "agent", "自动化", "套餐", "超额使用", "结转", "用量", "导出", "CSV", "活动日志"] --- diff --git a/zh/customize/custom-404-page.mdx b/zh/customize/custom-404-page.mdx index 0985d5ebac..c062e89fd2 100644 --- a/zh/customize/custom-404-page.mdx +++ b/zh/customize/custom-404-page.mdx @@ -1,6 +1,6 @@ --- title: "自定义 404 页面" -description: "自定义文档站点 404 错误页面的标题、描述和外观，以匹配你的品牌风格并引导访客。" +description: "自定义文档站点 404 错误页面的标题、描述和外观，以匹配你的品牌风格并引导访客。本文说明相关配置步骤、可选项和注意事项，帮助你自定义站点并保持品牌体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["404 error page", "custom error pages"] --- diff --git a/zh/customize/custom-domain.mdx b/zh/customize/custom-domain.mdx index 749599ef81..7cbfa6ef00 100644 --- a/zh/customize/custom-domain.mdx +++ b/zh/customize/custom-domain.mdx @@ -1,6 +1,6 @@ --- title: "自定义域名" -description: "使用 DNS 记录、自动 TLS 证书以及 Mintlify 托管或代理流量路由，将你的站点托管在自己的域名、子域名或子路径下。" +description: "使用 DNS 记录、自动 TLS 证书以及 Mintlify 托管或代理流量路由，将你的站点托管在自己的域名、子域名或子路径下。本文说明相关配置步骤、可选项和注意事项，帮助你自定义站点并保持品牌体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["自定义域名配置", "DNS 配置", "CNAME 记录", "TLS 证书", "子路径", "托管", "基础路径", "顶级域名", "CNAME flattening", "ALIAS 记录"] --- diff --git a/zh/customize/custom-scripts.mdx b/zh/customize/custom-scripts.mdx index 1595f91ca9..53702eee1c 100644 --- a/zh/customize/custom-scripts.mdx +++ b/zh/customize/custom-scripts.mdx @@ -1,6 +1,6 @@ --- title: "自定义脚本" -description: "为你的文档站点添加自定义 JavaScript 和 CSS 脚本，用于分析、小组件、样式覆盖和第三方集成。" +description: "为你的文档站点添加自定义 JavaScript 和 CSS 脚本，用于分析、小组件、样式覆盖和第三方集成。本文说明相关配置步骤、可选项和注意事项，帮助你自定义站点并保持品牌体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["CSS", "JavaScript", "Tailwind CSS", "样式定制"] --- diff --git a/zh/customize/fonts.mdx b/zh/customize/fonts.mdx index fe21c49503..9c18538355 100644 --- a/zh/customize/fonts.mdx +++ b/zh/customize/fonts.mdx @@ -1,6 +1,6 @@ --- -title: "字体" -description: "使用 Google Fonts 或自托管字体文件，为标题、正文和代码块自定义文档站点的排版样式。" +title: "文档字体设置" +description: "使用 Google Fonts 或自托管字体文件，为标题、正文和代码块自定义文档站点的排版样式。本文说明相关配置步骤、可选项和注意事项，帮助你自定义站点并保持品牌体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Google Fonts", "本地字体", "自定义排版"] boost: 3 --- diff --git a/zh/customize/react-components.mdx b/zh/customize/react-components.mdx index 7e36f558ca..8b33b4431b 100644 --- a/zh/customize/react-components.mdx +++ b/zh/customize/react-components.mdx @@ -1,6 +1,6 @@ --- title: "React" -description: "使用 JSX、状态和客户端逻辑，在你的 Mintlify 文档中通过自定义 React 组件构建交互且可复用的元素。" +description: "使用 JSX、状态和客户端逻辑，在你的 Mintlify 文档中通过自定义 React 组件构建交互且可复用的元素。本文说明相关配置步骤、可选项和注意事项，帮助你自定义站点并保持品牌体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["React 组件", "交互式组件", "JSX", "自定义组件"] boost: 3 --- diff --git a/zh/customize/themes.mdx b/zh/customize/themes.mdx index a0184dae65..1ff32b572d 100644 --- a/zh/customize/themes.mdx +++ b/zh/customize/themes.mdx @@ -1,6 +1,6 @@ --- -title: "主题" -description: "选择一个主题，自定义文档的外观样式。" +title: "文档主题设置" +description: "选择一个主题，自定义文档的外观样式。本文说明相关配置步骤、可选项和注意事项，帮助你自定义站点并保持品牌体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。也可作为后续更新文档时的参考。" mode: "frame" keywords: ["主题选择", "Mint", "Maple", "Palm", "Willow", "Linden", "Almond", "Aspen", "Sequoia", "自定义外观"] boost: 3 diff --git a/zh/dashboard/audit-logs.mdx b/zh/dashboard/audit-logs.mdx index 722855c721..ff4217527a 100644 --- a/zh/dashboard/audit-logs.mdx +++ b/zh/dashboard/audit-logs.mdx @@ -1,6 +1,6 @@ --- title: "审计日志" -description: "查看审计日志，追踪组织成员执行的操作，包括部署、配置更改和权限更新。" +description: "查看审计日志，追踪组织成员执行的操作，包括部署、配置更改和权限更新。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["监控", "活动追踪", "安全", "合规"] --- diff --git a/zh/dashboard/network-access.mdx b/zh/dashboard/network-access.mdx index efa6fa4559..0c7c62570e 100644 --- a/zh/dashboard/network-access.mdx +++ b/zh/dashboard/network-access.mdx @@ -1,7 +1,7 @@ --- title: "Dashboard 访问策略" sidebarTitle: "访问策略" -description: "将 Mintlify dashboard 的访问限制为受信任的 IP 地址，并通过空闲超时和最大会话有效期控制 dashboard 会话的有效时长。" +description: "将 Mintlify dashboard 的访问限制为受信任的 IP 地址，并通过空闲超时和最大会话有效期控制 dashboard 会话的有效时长。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["IP 允许列表", "网络访问", "CIDR", "IP 限制", "安全", "dashboard 访问", "受信任的 IP", "会话有效期", "空闲超时", "会话时长"] --- diff --git a/zh/dashboard/permissions.mdx b/zh/dashboard/permissions.mdx index 3222506a83..a04a236c2f 100644 --- a/zh/dashboard/permissions.mdx +++ b/zh/dashboard/permissions.mdx @@ -1,6 +1,6 @@ --- title: "部署权限" -description: "了解组织成员与外部贡献者的部署权限级别，包括 branch 保护和合并访问权限。" +description: "了解组织成员与外部贡献者的部署权限级别，包括 branch 保护和合并访问权限。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["editor access", "permissions", "team", "seats", "deployment"] --- diff --git a/zh/dashboard/roles.mdx b/zh/dashboard/roles.mdx index a74a5e9bbf..443f7ed6d9 100644 --- a/zh/dashboard/roles.mdx +++ b/zh/dashboard/roles.mdx @@ -1,6 +1,6 @@ --- -title: "角色" -description: "为团队成员分配管理员、编辑者或查看者角色，控制 Mintlify 中的访问级别、编辑权限和部署能力。" +title: "组织角色与权限" +description: "为团队成员分配管理员、编辑者或查看者角色，控制 Mintlify 中的访问级别、编辑权限和部署能力。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["RBAC", "基于角色的访问控制", "管理员", "编辑者", "查看者", "权限", "撤销凭证", "会话撤销"] boost: 3 --- diff --git a/zh/dashboard/scim.mdx b/zh/dashboard/scim.mdx index 5e140d6279..3ad6ea5b56 100644 --- a/zh/dashboard/scim.mdx +++ b/zh/dashboard/scim.mdx @@ -1,6 +1,6 @@ --- title: "SCIM 预配" -description: "使用 SCIM 从你的身份提供商为控制台成员进行预配和取消预配。" +description: "使用 SCIM 从你的身份提供商为控制台成员进行预配和取消预配。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["SCIM", "Okta", "身份提供商", "用户管理", "RBAC"] --- diff --git a/zh/dashboard/security-contact.mdx b/zh/dashboard/security-contact.mdx index b06ff9d230..31fc6725e3 100644 --- a/zh/dashboard/security-contact.mdx +++ b/zh/dashboard/security-contact.mdx @@ -1,6 +1,6 @@ --- title: "安全联系人" -description: "为你的组织配置安全联系人邮箱地址，用于接收漏洞报告、安全警报和合规更新。" +description: "为你的组织配置安全联系人邮箱地址，用于接收漏洞报告、安全警报和合规更新。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["security", "notifications", "compliance"] --- diff --git a/zh/dashboard/session-security.mdx b/zh/dashboard/session-security.mdx index b385591650..33311ad032 100644 --- a/zh/dashboard/session-security.mdx +++ b/zh/dashboard/session-security.mdx @@ -1,6 +1,6 @@ --- title: "会话安全" -description: "配置仪表盘会话超时、最长会话生命周期以及 IP 允许列表，以实施更严格的身份验证和网络访问策略。" +description: "配置仪表盘会话超时、最长会话生命周期以及 IP 允许列表，以实施更严格的身份验证和网络访问策略。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["session", "timeout", "authentication", "security", "SSO", "IP allowlist"] --- diff --git a/zh/dashboard/sso.mdx b/zh/dashboard/sso.mdx index b55e566729..450cac46ed 100644 --- a/zh/dashboard/sso.mdx +++ b/zh/dashboard/sso.mdx @@ -1,6 +1,6 @@ --- title: "单点登录（SSO）" -description: "使用 Okta、Azure AD 和 Google Workspace 等 SAML 或 OIDC 身份提供商设置单点登录，实现安全的团队身份验证。" +description: "使用 Okta、Azure AD 和 Google Workspace 等 SAML 或 OIDC 身份提供商设置单点登录，实现安全的团队身份验证。本文说明控制台中的配置步骤和权限影响，帮助团队安全管理文档项目。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["SSO", "SAML 认证", "Okta 集成", "Microsoft Entra", "身份提供商", "JIT", "预配", "OIDC"] --- diff --git a/zh/deploy/authentication-setup.mdx b/zh/deploy/authentication-setup.mdx index 626bc59140..c6783d9d5a 100644 --- a/zh/deploy/authentication-setup.mdx +++ b/zh/deploy/authentication-setup.mdx @@ -1,6 +1,6 @@ --- title: "认证设置" -description: "为你的站点配置用户认证，以控制对页面和 API 参考的访问权限。将页面设为仅对你的 Mintlify 组织可见，或使用密码、OAuth 或 JWT 认证。" +description: "为你的站点配置用户认证，以控制对页面和 API 参考的访问权限。将页面设为仅对你的 Mintlify 组织可见，或使用密码、OAuth 或 JWT 认证。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。" keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password', 'private'] --- diff --git a/zh/deploy/ci.mdx b/zh/deploy/ci.mdx index dd579839bf..590e970872 100644 --- a/zh/deploy/ci.mdx +++ b/zh/deploy/ci.mdx @@ -1,6 +1,6 @@ --- title: "CI 检查" -description: "在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测、代码检查、语法校验和构建预览。" +description: "在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测、代码检查、语法校验和构建预览。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- diff --git a/zh/deploy/cloudflare-firewall-troubleshooting.mdx b/zh/deploy/cloudflare-firewall-troubleshooting.mdx index 22742df8b5..157eeea86a 100644 --- a/zh/deploy/cloudflare-firewall-troubleshooting.mdx +++ b/zh/deploy/cloudflare-firewall-troubleshooting.mdx @@ -1,6 +1,6 @@ --- title: "Cloudflare 防火墙故障排查" -description: "排查通过 Cloudflare Workers 提供 Mintlify 文档时被拦截的请求并解决 Cloudflare WAF 规则冲突。" +description: "排查通过 Cloudflare Workers 提供 Mintlify 文档时被拦截的请求并解决 Cloudflare WAF 规则冲突。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Cloudflare WAF", "firewall rules", "Bot Fight Mode", "403 errors"] --- diff --git a/zh/deploy/cloudflare.mdx b/zh/deploy/cloudflare.mdx index 5186d7d847..b92a0f9c10 100644 --- a/zh/deploy/cloudflare.mdx +++ b/zh/deploy/cloudflare.mdx @@ -1,7 +1,7 @@ --- title: "使用 Cloudflare Workers 在子路径下部署" sidebarTitle: "Cloudflare" -description: "通过 Cloudflare Workers 将你的 Mintlify 文档部署到域名的子路径，包含分步设置和 DNS 配置说明。" +description: "通过 Cloudflare Workers 将你的 Mintlify 文档部署到域名的子路径，包含分步设置和 DNS 配置说明。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Cloudflare Workers", "子路径路由", "反向代理设置", "Worker 配置"] boost: 3 --- diff --git a/zh/deploy/csp-configuration.mdx b/zh/deploy/csp-configuration.mdx index 3b5a006646..7eab144e3b 100644 --- a/zh/deploy/csp-configuration.mdx +++ b/zh/deploy/csp-configuration.mdx @@ -1,7 +1,7 @@ --- title: "内容安全策略（CSP）配置" sidebarTitle: "CSP 配置" -description: "配置内容安全策略标头，在允许 Mintlify 资源的同时，为反向代理和严格网络策略维护安全性。" +description: "配置内容安全策略标头，在允许 Mintlify 资源的同时，为反向代理和严格网络策略维护安全性。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["内容安全策略", "CSP", "指令", "安全标头", "防火墙", "XSS 防护"] --- diff --git a/zh/deploy/custom-portal.mdx b/zh/deploy/custom-portal.mdx index 03c534dab7..3b14f6dd7a 100644 --- a/zh/deploy/custom-portal.mdx +++ b/zh/deploy/custom-portal.mdx @@ -1,6 +1,6 @@ --- title: "定制开发者门户" -description: "在自托管 Mintlify 之上部署完全定制的开发者门户，由 Mintlify 设计和构建，并通过版本化发布交付。" +description: "在自托管 Mintlify 之上部署完全定制的开发者门户，由 Mintlify 设计和构建，并通过版本化发布交付。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["developer portal", "custom presentation layer", "API marketplace", "self-host", "on-prem", "white label", "enterprise"] --- diff --git a/zh/deploy/deployments.mdx b/zh/deploy/deployments.mdx index 5c9266ed22..47826fc859 100644 --- a/zh/deploy/deployments.mdx +++ b/zh/deploy/deployments.mdx @@ -1,6 +1,6 @@ --- -title: "部署" -description: "在 Mintlify 控制台中管理文档部署，包括查看部署历史、监控构建状态和故障排查。" +title: "文档部署管理" +description: "在 Mintlify 控制台中管理文档部署，包括查看部署历史、监控构建状态和故障排查。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] boost: 3 --- diff --git a/zh/deploy/docs-subpath.mdx b/zh/deploy/docs-subpath.mdx index 1d3c8a58b8..69be6dbf33 100644 --- a/zh/deploy/docs-subpath.mdx +++ b/zh/deploy/docs-subpath.mdx @@ -1,6 +1,6 @@ --- title: "在子路径下托管文档" -description: "使用 Cloudflare Workers、Vercel 重写规则或 nginx 反向代理，将你的 Mintlify 文档托管在主域名的类似 /docs 的子路径下。" +description: "使用 Cloudflare Workers、Vercel 重写规则或 nginx 反向代理，将你的 Mintlify 文档托管在主域名的类似 /docs 的子路径下。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。" keywords: ["子路径路由", "/docs 设置", "基础路径"] boost: 3 --- diff --git a/zh/deploy/export.mdx b/zh/deploy/export.mdx index 0ab7b06edf..28822f7a8b 100644 --- a/zh/deploy/export.mdx +++ b/zh/deploy/export.mdx @@ -1,6 +1,6 @@ --- title: "离线导出" -description: "将文档站点导出为自包含的 zip 压缩包，用于离线查看、内部分发或隔离环境托管。" +description: "将文档站点导出为自包含的 zip 压缩包，用于离线查看、内部分发或隔离环境托管。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["导出", "离线", "zip", "静态站点", "分发", "mint export"] --- diff --git a/zh/deploy/ghes.mdx b/zh/deploy/ghes.mdx index 4de2df91b2..06e8105110 100644 --- a/zh/deploy/ghes.mdx +++ b/zh/deploy/ghes.mdx @@ -1,6 +1,6 @@ --- title: "GitHub Enterprise Server" -description: "在你的 GitHub Enterprise Server 实例上安装和配置 Mintlify GitHub 应用，实现文档自动部署和同步。" +description: "在你的 GitHub Enterprise Server 实例上安装和配置 Mintlify GitHub 应用，实现文档自动部署和同步。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["GitHub Enterprise Server", "GHES", "GitHub Enterprise"] --- diff --git a/zh/deploy/github.mdx b/zh/deploy/github.mdx index e64c2a1b1e..8dfbf34dba 100644 --- a/zh/deploy/github.mdx +++ b/zh/deploy/github.mdx @@ -1,6 +1,6 @@ --- title: "GitHub" -description: "将你的 GitHub 仓库连接到 Mintlify，实现自动部署、拉取请求预览构建和持续文档同步。" +description: "将你的 GitHub 仓库连接到 Mintlify，实现自动部署、拉取请求预览构建和持续文档同步。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["GitHub App", "repository connection", "automated deployments"] boost: 3 --- diff --git a/zh/deploy/gitlab-self-hosted.mdx b/zh/deploy/gitlab-self-hosted.mdx index 89aedf4ac6..23ed0f7171 100644 --- a/zh/deploy/gitlab-self-hosted.mdx +++ b/zh/deploy/gitlab-self-hosted.mdx @@ -1,6 +1,6 @@ --- title: "自托管 GitLab OAuth" -description: "通过 OAuth 将自托管的 GitLab 实例连接到 Mintlify，让自动化能够代表你克隆存储库、推送提交和发起合并请求。" +description: "通过 OAuth 将自托管的 GitLab 实例连接到 Mintlify，让自动化能够代表你克隆存储库、推送提交和发起合并请求。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["GitLab", "自托管", "OAuth", "自动化", "企业"] --- diff --git a/zh/deploy/gitlab.mdx b/zh/deploy/gitlab.mdx index e25d249f95..8ab20da0c4 100644 --- a/zh/deploy/gitlab.mdx +++ b/zh/deploy/gitlab.mdx @@ -1,6 +1,6 @@ --- title: "GitLab" -description: "将 GitLab 仓库连接到 Mintlify，实现自动化文档部署、合并请求预览和持续同步。" +description: "将 GitLab 仓库连接到 Mintlify，实现自动化文档部署、合并请求预览和持续同步。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["GitLab 集成", "访问令牌", "合并请求预览", "自托管", "实例"] boost: 3 --- diff --git a/zh/deploy/monorepo.mdx b/zh/deploy/monorepo.mdx index 3741dae804..db77ba5f56 100644 --- a/zh/deploy/monorepo.mdx +++ b/zh/deploy/monorepo.mdx @@ -1,6 +1,6 @@ --- title: "Monorepo 设置" -description: "在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。" +description: "在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["monorepo", "content 目录", "多项目存储库"] --- diff --git a/zh/deploy/multi-repo.mdx b/zh/deploy/multi-repo.mdx index 9349c780f3..9756e4e67d 100644 --- a/zh/deploy/multi-repo.mdx +++ b/zh/deploy/multi-repo.mdx @@ -1,6 +1,6 @@ --- title: "多仓库部署" -description: "将多个 Git 仓库中的文件合并到一个 Mintlify 站点，并为每个源仓库分配独立的 URL 路径。" +description: "将多个 Git 仓库中的文件合并到一个 Mintlify 站点，并为每个源仓库分配独立的 URL 路径。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["multi-repo", "multiple repositories", "git sources", "URL path"] --- diff --git a/zh/deploy/preview-deployments.mdx b/zh/deploy/preview-deployments.mdx index afdcb69d91..2eeaf8a7e3 100644 --- a/zh/deploy/preview-deployments.mdx +++ b/zh/deploy/preview-deployments.mdx @@ -1,6 +1,6 @@ --- title: "预览部署" -description: "为每个拉取请求获取唯一的预览 URL，让审阅者可以在实时环境中查看文档更改，然后再合并到生产环境。" +description: "为每个拉取请求获取唯一的预览 URL，让审阅者可以在实时环境中查看文档更改，然后再合并到生产环境。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["preview URLs", "pull request previews", "branch previews", "staging environments"] --- diff --git a/zh/deploy/reverse-proxy.mdx b/zh/deploy/reverse-proxy.mdx index 1e6a768b55..6fcc0f7bcc 100644 --- a/zh/deploy/reverse-proxy.mdx +++ b/zh/deploy/reverse-proxy.mdx @@ -1,6 +1,6 @@ --- title: "反向代理" -description: "使用 Nginx、Apache 或 Caddy 配置自定义反向代理，在你自己的域名子路径上提供 Mintlify 文档服务。" +description: "使用 Nginx、Apache 或 Caddy 配置自定义反向代理，在你自己的域名子路径上提供 Mintlify 文档服务。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["反向代理配置","nginx","代理路由","请求头转发"] --- diff --git a/zh/deploy/route53-cloudfront.mdx b/zh/deploy/route53-cloudfront.mdx index 37698ca203..bb5bc369e5 100644 --- a/zh/deploy/route53-cloudfront.mdx +++ b/zh/deploy/route53-cloudfront.mdx @@ -1,7 +1,7 @@ --- title: "使用 AWS Route 53 和 CloudFront 在子路径下部署" sidebarTitle: "AWS" -description: "使用 AWS Route 53 进行 DNS 路由，并通过 CloudFront CDN 和 Lambda@Edge 函数将你的 Mintlify 文档部署到子路径。" +description: "使用 AWS Route 53 进行 DNS 路由，并通过 CloudFront CDN 和 Lambda@Edge 函数将你的 Mintlify 文档部署到子路径。本页补充「使用 AWS Route 53 和 CloudFront 在子路径下部署」的相关概念和使用要点。" keywords: ["AWS 部署", "Route 53 DNS（域名系统）", "CloudFront CDN", "缓存策略"] --- diff --git a/zh/deploy/self-host.mdx b/zh/deploy/self-host.mdx index 130a7f4206..3e0b500a78 100644 --- a/zh/deploy/self-host.mdx +++ b/zh/deploy/self-host.mdx @@ -1,6 +1,6 @@ --- title: "自托管" -description: "在你自己的云或本地环境中运行 Mintlify，可部署在 AWS 或任何 Kubernetes 平台上，包括 Azure、Google Cloud、Oracle Cloud 和 OpenShift。" +description: "在你自己的云或本地环境中运行 Mintlify，可部署在 AWS 或任何 Kubernetes 平台上，包括 Azure、Google Cloud、Oracle Cloud 和 OpenShift。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。" keywords: ["self-host", "self-hosted", "on-prem", "deploy", "AWS", "CDK", "Helm", "Kubernetes", "OpenShift", "air gap", "enterprise"] --- diff --git a/zh/deploy/vercel-external-proxies.mdx b/zh/deploy/vercel-external-proxies.mdx index cf8f0101c9..dc628e10de 100644 --- a/zh/deploy/vercel-external-proxies.mdx +++ b/zh/deploy/vercel-external-proxies.mdx @@ -1,6 +1,6 @@ --- title: "在 Vercel 前使用外部代理" -description: "在你的 Vercel 部署前配置 Cloudflare 或 Nginx 等外部反向代理，以在自定义子路径下提供 Mintlify 文档。" +description: "在你的 Vercel 部署前配置 Cloudflare 或 Nginx 等外部反向代理，以在自定义子路径下提供 Mintlify 文档。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Vercel", "外部代理", "CloudFront", "域名验证", "SSL 证书"] --- diff --git a/zh/deploy/vercel.mdx b/zh/deploy/vercel.mdx index 82c92f4dac..51ed188f01 100644 --- a/zh/deploy/vercel.mdx +++ b/zh/deploy/vercel.mdx @@ -1,7 +1,7 @@ --- title: "使用 Vercel 在子路径下部署" sidebarTitle: "Vercel" -description: "通过 Vercel 重写规则将你的 Mintlify 站点托管在主域名的子路径下，并附有分步的 vercel.json 配置演练。" +description: "通过 Vercel 重写规则将你的 Mintlify 站点托管在主域名的子路径下，并附有分步的 vercel.json 配置演练。本文说明部署流程、配置要点和故障处理方法，帮助你稳定发布并维护文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["vercel.json", "Vercel 部署", "重写规则配置", "子路径路由"] boost: 3 --- diff --git a/zh/editor/agent.mdx b/zh/editor/agent.mdx index a154eaf143..aed68d8572 100644 --- a/zh/editor/agent.mdx +++ b/zh/editor/agent.mdx @@ -1,6 +1,6 @@ --- title: "向代理提问" -description: "使用编辑器内置的 AI 代理，通过聊天界面撰写内容、编辑页面、跨站点搜索、上传文件并配置设置。" +description: "使用编辑器内置的 AI 代理，通过聊天界面撰写内容、编辑页面、跨站点搜索、上传文件并配置设置。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["编辑器", "AI", "助手", "代理", "聊天", "code mode", "文件上传"] --- diff --git a/zh/editor/branching-and-publishing.mdx b/zh/editor/branching-and-publishing.mdx index 215674780d..ab479a33f9 100644 --- a/zh/editor/branching-and-publishing.mdx +++ b/zh/editor/branching-and-publishing.mdx @@ -1,6 +1,6 @@ --- title: "分支与发布" -description: "了解分支及保护规则如何决定发布时所发生的操作，以及如何管理完整的审查与部署工作流。" +description: "了解分支及保护规则如何决定发布时所发生的操作，以及如何管理完整的审查与部署工作流。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["编辑器", "分支", "发布", "拉取请求", "预览", "git", "合并", "部署"] --- diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index b262e215ed..af4d972fb8 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -1,7 +1,7 @@ --- title: "在 Web 编辑器中协作" sidebarTitle: "协作" -description: "通过实时协作、实时光标、可分享的编辑器链接、branch 以及拉取请求审查工作流，与团队一起编辑文档。" +description: "通过实时协作、实时光标、可分享的编辑器链接、branch 以及拉取请求审查工作流，与团队一起编辑文档。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["编辑器", "协作", "实时", "实时编辑", "branch", "拉取请求", "预览部署", "可分享链接"] --- diff --git a/zh/editor/comments.mdx b/zh/editor/comments.mdx index c959613763..53dcda22d4 100644 --- a/zh/editor/comments.mdx +++ b/zh/editor/comments.mdx @@ -1,6 +1,6 @@ --- -title: "评论" -description: "在编辑器中对页面留下行内评论，与团队成员反馈意见、提出问题并讨论更改。" +title: "编辑器页面评论" +description: "在编辑器中对页面留下行内评论，与团队成员反馈意见、提出问题并讨论更改。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["editor", "评论", "协作", "反馈", "提及", "讨论线程"] --- diff --git a/zh/editor/configurations.mdx b/zh/editor/configurations.mdx index d5ec7d6567..45ab889500 100644 --- a/zh/editor/configurations.mdx +++ b/zh/editor/configurations.mdx @@ -1,6 +1,6 @@ --- -title: "配置" -description: "使用 Mintlify 网页编辑器侧边栏中的可视化配置表单编辑页面元数据、导航元素和媒体设置。" +title: "编辑器页面配置" +description: "使用 Mintlify 网页编辑器侧边栏中的可视化配置表单编辑页面元数据、导航元素和媒体设置。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["editor", "configurations", "settings"] boost: 3 --- diff --git a/zh/editor/git-essentials.mdx b/zh/editor/git-essentials.mdx index 607030d557..342cfae7a3 100644 --- a/zh/editor/git-essentials.mdx +++ b/zh/editor/git-essentials.mdx @@ -1,7 +1,7 @@ --- title: "编辑器中的 Git 基础" sidebarTitle: "Git 基础" -description: "了解 Mintlify 编辑器背后的 Git 版本控制概念，包括 branch、commit、拉取请求和合并工作流。" +description: "了解 Mintlify 编辑器背后的 Git 版本控制概念，包括 branch、commit、拉取请求和合并工作流。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["git", "版本控制", "Web 编辑器", "分支", "提交", "拉取请求（PR）", "PR"] --- diff --git a/zh/editor/index.mdx b/zh/editor/index.mdx index 309d49cde2..241a0d22df 100644 --- a/zh/editor/index.mdx +++ b/zh/editor/index.mdx @@ -1,7 +1,7 @@ --- title: "编辑器概览" sidebarTitle: "概览" -description: "在浏览器中创建、编辑和发布文档，支持团队实时协作、自动保存、实时预览以及与 Git 持续同步。" +description: "在浏览器中创建、编辑和发布文档，支持团队实时协作、自动保存、实时预览以及与 Git 持续同步。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["editor", "visual", "collaborative", "web editor"] --- diff --git a/zh/editor/keyboard-shortcuts.mdx b/zh/editor/keyboard-shortcuts.mdx index 03a35dd0da..38cea6b877 100644 --- a/zh/editor/keyboard-shortcuts.mdx +++ b/zh/editor/keyboard-shortcuts.mdx @@ -1,6 +1,6 @@ --- title: "键盘快捷键" -description: "查看 Mintlify 网页编辑器的完整键盘快捷键列表，包括文本格式、导航和编辑命令。" +description: "查看 Mintlify 网页编辑器的完整键盘快捷键列表，包括文本格式、导航和编辑命令。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["编辑器", "快捷键", "键盘", "快捷方式"] --- diff --git a/zh/editor/live-preview.mdx b/zh/editor/live-preview.mdx index 9f2b380fa0..f20dc7612d 100644 --- a/zh/editor/live-preview.mdx +++ b/zh/editor/live-preview.mdx @@ -1,6 +1,6 @@ --- title: "实时预览" -description: "在编辑时实时预览你的文档站点，持续更新会即时渲染内容、导航和配置的更改。" +description: "在编辑时实时预览你的文档站点，持续更新会即时渲染内容、导航和配置的更改。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["editor", "preview", "live preview"] --- diff --git a/zh/editor/media.mdx b/zh/editor/media.mdx index 88f3f34011..4d988d7b7e 100644 --- a/zh/editor/media.mdx +++ b/zh/editor/media.mdx @@ -1,6 +1,6 @@ --- title: "添加媒体" -description: "使用 Mintlify 网页编辑器内置的文件管理器，在文档页面中上传、管理和嵌入图片及其他媒体资源。" +description: "使用 Mintlify 网页编辑器内置的文件管理器，在文档页面中上传、管理和嵌入图片及其他媒体资源。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["editor","media","images","assets"] --- diff --git a/zh/editor/navigation.mdx b/zh/editor/navigation.mdx index 9587bbe6fd..217f5ef37f 100644 --- a/zh/editor/navigation.mdx +++ b/zh/editor/navigation.mdx @@ -1,6 +1,6 @@ --- title: "组织导航" -description: "通过在 Mintlify Web 编辑器中拖放，重新排序页面、添加分组并管理文档侧边栏结构，无需修改 docs.json。" +description: "通过在 Mintlify Web 编辑器中拖放，重新排序页面、添加分组并管理文档侧边栏结构，无需修改 docs.json。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["编辑器", "导航", "侧边栏", "结构"] --- diff --git a/zh/editor/pages.mdx b/zh/editor/pages.mdx index ed5152dcec..185c40a119 100644 --- a/zh/editor/pages.mdx +++ b/zh/editor/pages.mdx @@ -1,6 +1,6 @@ --- title: "创建和编辑页面" -description: "在 Web 编辑器中创建、编辑和组织文档页面。" +description: "在 Web 编辑器中创建、编辑和组织文档页面。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。也可作为后续更新文档时的参考。" keywords: ["编辑器","内容","页面","文件"] --- diff --git a/zh/editor/publish.mdx b/zh/editor/publish.mdx index 87d9012073..91751ef37e 100644 --- a/zh/editor/publish.mdx +++ b/zh/editor/publish.mdx @@ -1,7 +1,7 @@ --- title: "在 Web 编辑器中发布更改" sidebarTitle: "发布" -description: "保存你的工作并发布你对文档站点的更改。" +description: "保存你的工作并发布你对文档站点的更改。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。也可作为后续更新文档时的参考。" keywords: ["编辑器", "发布", "更改", "branches", "拉取请求（PR；亦称“合并请求”/Merge Request）"] --- diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 6207c2c822..74da52e616 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -1,6 +1,6 @@ --- title: "用于 AI 与发布的编辑器设置" -description: "配置 AI 指令、pull request 默认值以及默认合并方式，以控制 Mintlify Web 编辑器发布变更的方式。" +description: "配置 AI 指令、pull request 默认值以及默认合并方式，以控制 Mintlify Web 编辑器发布变更的方式。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["编辑器", "设置", "ai", "指令", "发布", "pull request", "合并", "锁定分支"] --- diff --git a/zh/editor/tutorial.mdx b/zh/editor/tutorial.mdx index d0649823ce..6a7ff7aaae 100644 --- a/zh/editor/tutorial.mdx +++ b/zh/editor/tutorial.mdx @@ -1,6 +1,6 @@ --- title: "如何使用编辑器" -description: "Mintlify 编辑器的分步演练：创建分支、编辑页面、分享预览部署以供审查，然后发布你的更改。" +description: "Mintlify 编辑器的分步演练：创建分支、编辑页面、分享预览部署以供审查，然后发布你的更改。本文介绍编辑器中的操作步骤和注意事项，帮助你高效完成相关工作并维护文档内容。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["编辑器", "教程", "分支", "发布"] --- diff --git a/zh/guides/accessibility.mdx b/zh/guides/accessibility.mdx index c940277801..054ad7f5a8 100644 --- a/zh/guides/accessibility.mdx +++ b/zh/guides/accessibility.mdx @@ -1,7 +1,7 @@ --- title: "如何创建无障碍文档" sidebarTitle: "无障碍访问" -description: "遵循 WCAG 指南创建无障碍文档，包括语义化 HTML、键盘导航、替代文本和包容性内容实践。" +description: "遵循 WCAG 指南创建无障碍文档，包括语义化 HTML、键盘导航、替代文本和包容性内容实践。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["无障碍文档", "WCAG", "a11y", "屏幕阅读器", "无障碍"] --- diff --git a/zh/guides/assistant-embed.mdx b/zh/guides/assistant-embed.mdx index 5446c071a0..2aa9cde717 100644 --- a/zh/guides/assistant-embed.mdx +++ b/zh/guides/assistant-embed.mdx @@ -1,7 +1,7 @@ --- title: "构建应用内助手" sidebarTitle: "构建应用内助手" -description: "构建并嵌入一个应用内文档助手，使用来自你的 Mintlify 文档站点的引用信息回答用户问题。" +description: "构建并嵌入一个应用内文档助手，使用来自你的 Mintlify 文档站点的引用信息回答用户问题。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["assistant embed", "in-app chat", "widget", "chatbot"] --- diff --git a/zh/guides/auth0.mdx b/zh/guides/auth0.mdx index fe65a3e0a0..38c067d696 100644 --- a/zh/guides/auth0.mdx +++ b/zh/guides/auth0.mdx @@ -1,6 +1,6 @@ --- title: "使用 Auth0 完成 OAuth 握手" -description: "将 Auth0 配置为 Mintlify 文档认证的 OAuth 提供方，包括应用程序设置、回调 URL 和令牌流程。" +description: "将 Auth0 配置为 Mintlify 文档认证的 OAuth 提供方，包括应用程序设置、回调 URL 和令牌流程。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Auth0", "OAuth flow"] --- diff --git a/zh/guides/branches.mdx b/zh/guides/branches.mdx index 289d8e0644..7d2635ff33 100644 --- a/zh/guides/branches.mdx +++ b/zh/guides/branches.mdx @@ -1,6 +1,6 @@ --- title: "使用 branch" -description: "创建和管理文档 branch，以预览变更、与团队成员协作，并在发布到生产环境之前合并更新。" +description: "创建和管理文档 branch，以预览变更、与团队成员协作，并在发布到生产环境之前合并更新。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Git","branches","branch workflow","creating branches","deployment branch"] --- diff --git a/zh/guides/claude-code.mdx b/zh/guides/claude-code.mdx index 5bcbda657d..4f3cc375fb 100644 --- a/zh/guides/claude-code.mdx +++ b/zh/guides/claude-code.mdx @@ -1,7 +1,7 @@ --- title: "使用 Claude Code 编写文档" sidebarTitle: "Claude Code" -description: "通过 CLAUDE.md 项目说明配置 Claude Code，按照你的风格指南撰写、审阅和更新你的 Mintlify 文档。" +description: "通过 CLAUDE.md 项目说明配置 Claude Code，按照你的风格指南撰写、审阅和更新你的 Mintlify 文档。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Claude Code", "CLAUDE.md", "AI 文档", "Anthropic", "Claude"] --- diff --git a/zh/guides/codex.mdx b/zh/guides/codex.mdx index dfd94328b8..3381d7fab8 100644 --- a/zh/guides/codex.mdx +++ b/zh/guides/codex.mdx @@ -1,7 +1,7 @@ --- title: "使用 Codex 编写文档" sidebarTitle: "Codex" -description: "通过项目说明和 MCP 配置 OpenAI Codex CLI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。" +description: "通过项目说明和 MCP 配置 OpenAI Codex CLI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Codex", "OpenAI Codex", "AGENTS.md", "AI 文档", "Codex CLI"] --- diff --git a/zh/guides/configure-automerge.mdx b/zh/guides/configure-automerge.mdx index 66e15551d9..e67351e282 100644 --- a/zh/guides/configure-automerge.mdx +++ b/zh/guides/configure-automerge.mdx @@ -1,7 +1,7 @@ --- title: "配置 GitHub 应用的自动合并" sidebarTitle: "配置自动合并" -description: "通过将 Mintlify 机器人添加到仓库规则集的绕过列表，设置 GitHub 工作流以自动合并 Mintlify pull request。" +description: "通过将 Mintlify 机器人添加到仓库规则集的绕过列表，设置 GitHub 工作流以自动合并 Mintlify pull request。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。" keywords: ["automerge", "ruleset", "分支保护", "bypass"] --- diff --git a/zh/guides/content-templates.mdx b/zh/guides/content-templates.mdx index 064006f661..3ecb885e42 100644 --- a/zh/guides/content-templates.mdx +++ b/zh/guides/content-templates.mdx @@ -1,7 +1,7 @@ --- title: "文档内容模板" sidebarTitle: "内容模板" -description: "复制并修改即用型 MDX 模板，用于在文档中撰写操作指南、教程、概念解释和 API 参考页面。" +description: "复制并修改即用型 MDX 模板，用于在文档中撰写操作指南、教程、概念解释和 API 参考页面。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档模板", "操作指南模板", "教程模板", "参考模板", "MDX 模板"] --- diff --git a/zh/guides/content-types.mdx b/zh/guides/content-types.mdx index 652e1f9db7..4894550422 100644 --- a/zh/guides/content-types.mdx +++ b/zh/guides/content-types.mdx @@ -1,7 +1,7 @@ --- title: "文档内容类型" sidebarTitle: "内容类型" -description: "使用 Diátaxis 框架为每个页面选择合适的文档类型：教程、操作指南、参考和解释。" +description: "使用 Diátaxis 框架为每个页面选择合适的文档类型：教程、操作指南、参考和解释。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Diátaxis", "文档类型", "教程", "操作指南", "参考文档", "技术文档类型"] --- diff --git a/zh/guides/cursor.mdx b/zh/guides/cursor.mdx index 960ddc6181..ca46c04cdf 100644 --- a/zh/guides/cursor.mdx +++ b/zh/guides/cursor.mdx @@ -1,7 +1,7 @@ --- title: "使用 Cursor 编写文档" sidebarTitle: "Cursor" -description: "使用项目规则配置 Cursor，以编写遵循你的样式指南、组件使用规范和 MDX 约定的 Mintlify 文档。" +description: "使用项目规则配置 Cursor，以编写遵循你的样式指南、组件使用规范和 MDX 约定的 Mintlify 文档。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Cursor", "Cursor rules", "project rules", "AI 文档", "Cursor 文档"] --- diff --git a/zh/guides/custom-frontend.mdx b/zh/guides/custom-frontend.mdx index e8f1ec9071..9af3ac77b8 100644 --- a/zh/guides/custom-frontend.mdx +++ b/zh/guides/custom-frontend.mdx @@ -1,7 +1,7 @@ --- title: "无头文档与自定义前端" sidebarTitle: "无头 / 自定义前端" -description: "使用 Astro 构建无头文档前端，同时借助 Mintlify 进行内容管理、AI 搜索和助手功能。" +description: "使用 Astro 构建无头文档前端，同时借助 Mintlify 进行内容管理、AI 搜索和助手功能。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Astro", "headless", "自托管", "自定义", "无头文档", "无头 CMS"] --- diff --git a/zh/guides/custom-layouts.mdx b/zh/guides/custom-layouts.mdx index 7ff2b4b570..681f4ef0a1 100644 --- a/zh/guides/custom-layouts.mdx +++ b/zh/guides/custom-layouts.mdx @@ -1,7 +1,7 @@ --- title: "构建自定义页面布局" sidebarTitle: "自定义页面布局" -description: "使用页面模式和组件在 Mintlify 文档中构建自定义落地页、营销页面及其他非标准布局。" +description: "使用页面模式和组件在 Mintlify 文档中构建自定义落地页、营销页面及其他非标准布局。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["landing page", "page mode", "custom mode", "frame mode", "hero section", "landing pages"] --- diff --git a/zh/guides/developer-documentation.mdx b/zh/guides/developer-documentation.mdx index ec433cf5ef..9516534e8f 100644 --- a/zh/guides/developer-documentation.mdx +++ b/zh/guides/developer-documentation.mdx @@ -1,7 +1,7 @@ --- title: "创建开发者文档" sidebarTitle: "开发者文档" -description: "构建帮助工程师集成你的 API、SDK 和工具的开发者文档，包括快速入门、参考文档和使用指南。" +description: "构建帮助工程师集成你的 API、SDK 和工具的开发者文档，包括快速入门、参考文档和使用指南。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["开发者文档", "API 文档", "SDK 文档", "技术文档", "开发者门户"] --- diff --git a/zh/guides/devin-desktop.mdx b/zh/guides/devin-desktop.mdx index cf57b1e414..5b45eb2982 100644 --- a/zh/guides/devin-desktop.mdx +++ b/zh/guides/devin-desktop.mdx @@ -1,7 +1,7 @@ --- title: "使用 Devin Desktop 编写文档" sidebarTitle: "Devin Desktop" -description: "使用工作区规则配置 Devin Desktop 的 Cascade AI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。" +description: "使用工作区规则配置 Devin Desktop 的 Cascade AI，以编写遵循你的样式指南和 MDX 标准的 Mintlify 文档。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。" keywords: ["Devin Desktop", "Windsurf", "Cascade", "workspace rules", "AI 文档", "Devin 文档"] --- diff --git a/zh/guides/geo.mdx b/zh/guides/geo.mdx index 2d41e7ccc9..394a11147d 100644 --- a/zh/guides/geo.mdx +++ b/zh/guides/geo.mdx @@ -1,7 +1,7 @@ --- title: "GEO 指南：为 AI 搜索和答案引擎优化文档" sidebarTitle: "GEO" -description: "使用 Generative Engine Optimization 技术，为 ChatGPT、Perplexity 和 Google AI Overviews 等 AI 驱动的答案引擎优化你的文档。" +description: "使用 Generative Engine Optimization 技术，为 ChatGPT、Perplexity 和 Google AI Overviews 等 AI 驱动的答案引擎优化你的文档。本页补充「GEO 指南：为 AI 搜索和答案引擎优化文档」的相关概念和使用要点。" keywords: ["Generative Engine Optimization", "GEO", "AI 搜索", "Perplexity", "ChatGPT 搜索", "Google AI Overviews", "AEO"] --- diff --git a/zh/guides/git-concepts.mdx b/zh/guides/git-concepts.mdx index 4366f32b51..82fe52f6cc 100644 --- a/zh/guides/git-concepts.mdx +++ b/zh/guides/git-concepts.mdx @@ -1,6 +1,6 @@ --- title: "文档相关的 Git 概念" -description: "学习用于文档即代码工作流的 Git 版本控制基础知识，包括仓库、branch、commit 和拉取请求协作。" +description: "学习用于文档即代码工作流的 Git 版本控制基础知识，包括仓库、branch、commit 和拉取请求协作。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Git", "version control", "collaboration", "commits", "pull requests", "merge requests"] --- diff --git a/zh/guides/help-center.mdx b/zh/guides/help-center.mdx index 3aad55c660..b06a90df9a 100644 --- a/zh/guides/help-center.mdx +++ b/zh/guides/help-center.mdx @@ -1,7 +1,7 @@ --- title: "创建帮助中心" sidebarTitle: "帮助中心" -description: "在 Mintlify 上构建自助式帮助中心，帮助客户找到答案，减少支持工单量，并随团队规模扩展。" +description: "在 Mintlify 上构建自助式帮助中心，帮助客户找到答案，减少支持工单量，并随团队规模扩展。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["support", "customer", "self-service", "FAQ"] --- diff --git a/zh/guides/improving-docs.mdx b/zh/guides/improving-docs.mdx index 890f442390..bc2732f3f8 100644 --- a/zh/guides/improving-docs.mdx +++ b/zh/guides/improving-docs.mdx @@ -1,7 +1,7 @@ --- title: "如何衡量和提升文档质量" sidebarTitle: "改善你的文档" -description: "使用分析数据、用户反馈和内容审计来识别文档中的不足，并改善对用户最重要的页面。" +description: "使用分析数据、用户反馈和内容审计来识别文档中的不足，并改善对用户最重要的页面。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档质量", "文档指标", "改善文档", "内容分析", "文档反馈"] --- diff --git a/zh/guides/index.mdx b/zh/guides/index.mdx index 8eca068b77..66a54fc2f1 100644 --- a/zh/guides/index.mdx +++ b/zh/guides/index.mdx @@ -1,6 +1,6 @@ --- -title: "指南" -description: "浏览文档最佳实践、内容策略、SEO 优化、可访问性和 docs-as-code 工作流程的实用指南。" +title: "文档创作指南" +description: "浏览文档最佳实践、内容策略、SEO 优化、可访问性和 docs-as-code 工作流程的实用指南。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" boost: 3 --- diff --git a/zh/guides/internationalization.mdx b/zh/guides/internationalization.mdx index aa269402f4..5045ba4c24 100644 --- a/zh/guides/internationalization.mdx +++ b/zh/guides/internationalization.mdx @@ -1,7 +1,7 @@ --- title: "如何设置多语言文档" sidebarTitle: "国际化" -description: "设置多语言文档，支持基于语言区域的路由、语言切换导航和翻译内容，以覆盖全球用户。" +description: "设置多语言文档，支持基于语言区域的路由、语言切换导航和翻译内容，以覆盖全球用户。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["国际化", "i18n", "多语言文档", "翻译", "本地化", "语言切换器"] --- diff --git a/zh/guides/knowledge-base.mdx b/zh/guides/knowledge-base.mdx index 92e69121db..2910744845 100644 --- a/zh/guides/knowledge-base.mdx +++ b/zh/guides/knowledge-base.mdx @@ -1,7 +1,7 @@ --- title: "创建知识库" sidebarTitle: "知识库" -description: "在 Mintlify 上托管团队内部知识库，以整合信息、提升搜索效果，并降低维护成本。" +description: "在 Mintlify 上托管团队内部知识库，以整合信息、提升搜索效果，并降低维护成本。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["知识库", "内部文档", "私有文档", "kb", "知识管理", "知识捕获"] --- diff --git a/zh/guides/linking.mdx b/zh/guides/linking.mdx index 05022f620d..e8e536d415 100644 --- a/zh/guides/linking.mdx +++ b/zh/guides/linking.mdx @@ -1,7 +1,7 @@ --- title: "如何有效地链接文档页面" sidebarTitle: "链接" -description: "在文档中创建内部链接、锚点链接和深层链接，并通过重定向和断链检查维护链接完整性。" +description: "在文档中创建内部链接、锚点链接和深层链接，并通过重定向和断链检查维护链接完整性。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档链接", "内部链接", "锚点链接", "断链", "深层链接", "交叉引用"] --- diff --git a/zh/guides/maintenance.mdx b/zh/guides/maintenance.mdx index df38caf869..ebfeaf8edf 100644 --- a/zh/guides/maintenance.mdx +++ b/zh/guides/maintenance.mdx @@ -1,7 +1,7 @@ --- title: "如何长期维护文档" sidebarTitle: "维护" -description: "通过审查计划、责任模型、自动化检查和内容生命周期实践，保持文档的准确性和时效性。" +description: "通过审查计划、责任模型、自动化检查和内容生命周期实践，保持文档的准确性和时效性。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档维护", "保持文档更新", "内容生命周期", "过时文档", "文档责任制"] --- diff --git a/zh/guides/media.mdx b/zh/guides/media.mdx index 1b98d25469..f4403fb192 100644 --- a/zh/guides/media.mdx +++ b/zh/guides/media.mdx @@ -1,7 +1,7 @@ --- title: "如何在文档中使用图片、截图和视频" sidebarTitle: "媒体" -description: "了解何时以及如何在文档中使用截图、GIF 和视频，包括格式选择、替代文本和长期维护方面的指导。" +description: "了解何时以及如何在文档中使用截图、GIF 和视频，包括格式选择、替代文本和长期维护方面的指导。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档图片", "截图", "文档视频", "GIF", "媒体最佳实践", "替代文本"] --- diff --git a/zh/guides/migrating-from-mdx.mdx b/zh/guides/migrating-from-mdx.mdx index 9db85da630..1036ebc4e4 100644 --- a/zh/guides/migrating-from-mdx.mdx +++ b/zh/guides/migrating-from-mdx.mdx @@ -1,7 +1,7 @@ --- title: "将 MDX API 页面迁移到 OpenAPI 导航" sidebarTitle: "从 MDX 迁移到 OAS" -description: "迁移到通过 OpenAPI 自动生成、并具有灵活导航结构的文档。" +description: "迁移到通过 OpenAPI 自动生成、并具有灵活导航结构的文档。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["API 迁移", "OpenAPI 迁移", "x-mint 扩展"] --- diff --git a/zh/guides/navigation.mdx b/zh/guides/navigation.mdx index caa12992a9..e70dd09b31 100644 --- a/zh/guides/navigation.mdx +++ b/zh/guides/navigation.mdx @@ -1,7 +1,7 @@ --- title: "如何构建文档导航结构" sidebarTitle: "导航" -description: "设计文档导航，通过清晰的信息架构、逻辑分组和经过验证的结构，帮助用户找到所需内容。" +description: "设计文档导航，通过清晰的信息架构、逻辑分组和经过验证的结构，帮助用户找到所需内容。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档导航", "信息架构", "文档结构", "侧边栏导航", "导航设计"] --- diff --git a/zh/guides/seo.mdx b/zh/guides/seo.mdx index 16d7018382..65b50877a3 100644 --- a/zh/guides/seo.mdx +++ b/zh/guides/seo.mdx @@ -1,7 +1,7 @@ --- title: "如何改善文档 SEO" sidebarTitle: "SEO" -description: "通过页面标题、关键词研究、内部链接和技术 SEO 技巧，提升文档在搜索引擎中的排名。" +description: "通过页面标题、关键词研究、内部链接和技术 SEO 技巧，提升文档在搜索引擎中的排名。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档 SEO", "搜索引擎优化", "关键词研究", "技术 SEO", "元描述"] --- diff --git a/zh/guides/style-and-tone.mdx b/zh/guides/style-and-tone.mdx index b978f378e0..0b5d9dc2fd 100644 --- a/zh/guides/style-and-tone.mdx +++ b/zh/guides/style-and-tone.mdx @@ -1,7 +1,7 @@ --- title: "如何撰写技术文档" sidebarTitle: "风格与语气" -description: "撰写清晰、一致的技术文档，包含关于语气、结构、术语和文风的实用指导，适用于开发者文档和产品文档。" +description: "撰写清晰、一致的技术文档，包含关于语气、结构、术语和文风的实用指导，适用于开发者文档和产品文档。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["技术写作", "文档风格指南", "写作规范", "语气与文风", "技术文档"] --- diff --git a/zh/guides/understand-your-audience.mdx b/zh/guides/understand-your-audience.mdx index bb13ac0e2f..d2adf8e194 100644 --- a/zh/guides/understand-your-audience.mdx +++ b/zh/guides/understand-your-audience.mdx @@ -1,7 +1,7 @@ --- title: "如何了解你的文档受众" sidebarTitle: "了解你的受众" -description: "定义你的文档受众，研究他们的目标和知识水平，并将这些洞察应用到编写帮助他们成功的内容中。" +description: "定义你的文档受众，研究他们的目标和知识水平，并将这些洞察应用到编写帮助他们成功的内容中。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["文档受众", "用户研究", "受众画像", "技术写作受众", "用户反馈"] --- diff --git a/zh/guides/use-automations.mdx b/zh/guides/use-automations.mdx index 0e8b0f4a60..51d823fbc6 100644 --- a/zh/guides/use-automations.mdx +++ b/zh/guides/use-automations.mdx @@ -1,6 +1,6 @@ --- title: "使用自动化" -description: "使用 Mintlify 自动化来自动执行周期性的文档维护：选择合适的触发器、撰写有效的指令，并获得一致的 agent 结果。" +description: "使用 Mintlify 自动化来自动执行周期性的文档维护：选择合适的触发器、撰写有效的指令，并获得一致的 agent 结果。本文结合实践建议和操作步骤，帮助你在 Mintlify 项目中完成相关工作并持续维护文档。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["automations", "automation", "automate", "automation guide", "automation instructions", "agent automation", "self updating"] --- diff --git a/zh/index.mdx b/zh/index.mdx index 22d9eafdb6..f44a2f1c59 100644 --- a/zh/index.mdx +++ b/zh/index.mdx @@ -1,6 +1,6 @@ --- -title: "简介" -description: "邂逅新一代文档体验：AI 原生、开箱即用且美观，为开发者打造。" +title: "Mintlify 文档简介" +description: "探索 Mintlify 新一代文档平台，了解 AI 原生功能、开箱即用的设计和面向开发者的体验，快速开始创建美观、智能的产品文档。本页介绍平台核心能力、适用场景和入门方向，帮助你选择合适的文档工作流并开始使用 Mintlify。适合首次了解 Mintlify 的开发者、技术写作者和产品团队查阅。" mode: "frame" keywords: ["概览", "平台", "快速开始", "功能"] boost: 3 diff --git a/zh/integrations/analytics/adobe.mdx b/zh/integrations/analytics/adobe.mdx index 3828dd3fb4..6a8ba3022e 100644 --- a/zh/integrations/analytics/adobe.mdx +++ b/zh/integrations/analytics/adobe.mdx @@ -1,6 +1,6 @@ --- title: "Adobe Analytics" -description: "使用 Adobe Experience Platform Launch 标签将 Adobe Analytics 集成到你的 Mintlify 文档站点，实现详细的使用情况跟踪。" +description: "使用 Adobe Experience Platform Launch 标签将 Adobe Analytics 集成到你的 Mintlify 文档站点，实现详细的使用情况跟踪。本页补充「Adobe Analytics」的相关概念和使用要点。内容也便于后续参考。" keywords: ["Adobe Analytics", "Adobe Launch", "Adobe Experience Platform", "site analytics"] --- diff --git a/zh/integrations/analytics/amplitude.mdx b/zh/integrations/analytics/amplitude.mdx index a837ab4ab5..f4e2688c49 100644 --- a/zh/integrations/analytics/amplitude.mdx +++ b/zh/integrations/analytics/amplitude.mdx @@ -1,6 +1,6 @@ --- title: "Amplitude" -description: "将 Amplitude Analytics 集成到你的 Mintlify 文档站点，以跟踪用户行为、页面浏览量和内容参与指标。" +description: "将 Amplitude Analytics 集成到你的 Mintlify 文档站点，以跟踪用户行为、页面浏览量和内容参与指标。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Amplitude 集成", "Amplitude API key", "用户行为跟踪", "产品分析"] boost: 3 --- diff --git a/zh/integrations/analytics/clarity.mdx b/zh/integrations/analytics/clarity.mdx index 58f5ec467f..1150e8a4e5 100644 --- a/zh/integrations/analytics/clarity.mdx +++ b/zh/integrations/analytics/clarity.mdx @@ -1,6 +1,6 @@ --- title: "Clarity" -description: "将 Microsoft Clarity 集成到你的 Mintlify 文档站点，以捕获会话录制、热图和用户交互分析。" +description: "将 Microsoft Clarity 集成到你的 Mintlify 文档站点，以捕获会话录制、热图和用户交互分析。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Microsoft Clarity", "session recording", "heatmaps", "user sessions"] boost: 3 --- diff --git a/zh/integrations/analytics/clearbit.mdx b/zh/integrations/analytics/clearbit.mdx index a0e7a8cdad..fa6fe2ceaf 100644 --- a/zh/integrations/analytics/clearbit.mdx +++ b/zh/integrations/analytics/clearbit.mdx @@ -1,6 +1,6 @@ --- title: "Clearbit" -description: "将 Clearbit 与你的 Mintlify 文档集成，丰富访客数据、识别访问企业并追踪企业级互动。" +description: "将 Clearbit 与你的 Mintlify 文档集成，丰富访客数据、识别访问企业并追踪企业级互动。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Clearbit 集成", "用户数据丰富", "访客情报", "public API key"] boost: 3 --- diff --git a/zh/integrations/analytics/fathom.mdx b/zh/integrations/analytics/fathom.mdx index 86c58c3d50..1ae965f8f6 100644 --- a/zh/integrations/analytics/fathom.mdx +++ b/zh/integrations/analytics/fathom.mdx @@ -1,6 +1,6 @@ --- title: "Fathom" -description: "将 Fathom Analytics 集成到你的 Mintlify 文档，通过简单的站点 ID 配置实现符合 GDPR、注重隐私的访客跟踪。" +description: "将 Fathom Analytics 集成到你的 Mintlify 文档，通过简单的站点 ID 配置实现符合 GDPR、注重隐私的访客跟踪。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["Fathom Analytics", "注重隐私的分析", "站点 ID", "简洁分析"] boost: 3 --- diff --git a/zh/integrations/analytics/google-analytics.mdx b/zh/integrations/analytics/google-analytics.mdx index ce81a91338..4908a73fbf 100644 --- a/zh/integrations/analytics/google-analytics.mdx +++ b/zh/integrations/analytics/google-analytics.mdx @@ -1,6 +1,6 @@ --- title: "Google Analytics 4" -description: "将 Google Analytics 4 集成到你的 Mintlify 文档，通过 GA4 ID 跟踪访客行为、页面浏览量和内容参与情况。" +description: "将 Google Analytics 4 集成到你的 Mintlify 文档，通过 GA4 ID 跟踪访客行为、页面浏览量和内容参与情况。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["GA4 integration", "measurement ID", "web stream", "Universal Analytics"] --- diff --git a/zh/integrations/analytics/google-tag-manager.mdx b/zh/integrations/analytics/google-tag-manager.mdx index 20239eadb0..7c8eeb86a6 100644 --- a/zh/integrations/analytics/google-tag-manager.mdx +++ b/zh/integrations/analytics/google-tag-manager.mdx @@ -1,6 +1,6 @@ --- title: "Google Tag Manager" -description: "将 Google Tag Manager 集成到你的 Mintlify 文档，集中管理分析标签、转化跟踪和营销事件。" +description: "将 Google Tag Manager 集成到你的 Mintlify 文档，集中管理分析标签、转化跟踪和营销事件。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["GTM integration", "tag management", "tag ID", "cookie consent"] --- diff --git a/zh/integrations/analytics/heap.mdx b/zh/integrations/analytics/heap.mdx index 6e70f85e05..511917187d 100644 --- a/zh/integrations/analytics/heap.mdx +++ b/zh/integrations/analytics/heap.mdx @@ -1,6 +1,6 @@ --- title: "Heap" -description: "将 Heap 分析集成到 Mintlify 文档站点，自动捕获用户交互和事件，进行行为分析。" +description: "将 Heap 分析集成到 Mintlify 文档站点，自动捕获用户交互和事件，进行行为分析。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["Heap Analytics", "自动事件跟踪", "Heap app ID", "用户交互跟踪"] boost: 3 --- diff --git a/zh/integrations/analytics/hightouch.mdx b/zh/integrations/analytics/hightouch.mdx index 1dbad4ef39..9a99f6ea2b 100644 --- a/zh/integrations/analytics/hightouch.mdx +++ b/zh/integrations/analytics/hightouch.mdx @@ -1,6 +1,6 @@ --- title: "Hightouch" -description: "将 Hightouch 集成到你的 Mintlify 文档，同步分析数据以实现受众激活、分群和下游工具路由。" +description: "将 Hightouch 集成到你的 Mintlify 文档，同步分析数据以实现受众激活、分群和下游工具路由。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Hightouch 集成", "数据激活", "write key", "受众同步"] boost: 3 --- diff --git a/zh/integrations/analytics/hotjar.mdx b/zh/integrations/analytics/hotjar.mdx index 629993e5e4..ca4fd2f1c3 100644 --- a/zh/integrations/analytics/hotjar.mdx +++ b/zh/integrations/analytics/hotjar.mdx @@ -1,6 +1,6 @@ --- title: "Hotjar" -description: "将 Hotjar 集成到你的 Mintlify 文档站点，捕获会话录制、热图和用户反馈，获取体验洞察。" +description: "将 Hotjar 集成到你的 Mintlify 文档站点，捕获会话录制、热图和用户反馈，获取体验洞察。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Hotjar integration", "user feedback", "session recordings", "behavior analytics"] boost: 3 --- diff --git a/zh/integrations/analytics/logrocket.mdx b/zh/integrations/analytics/logrocket.mdx index d5c9b32a5c..9b9b227e87 100644 --- a/zh/integrations/analytics/logrocket.mdx +++ b/zh/integrations/analytics/logrocket.mdx @@ -1,6 +1,6 @@ --- title: "LogRocket" -description: "将 LogRocket 集成到你的 Mintlify 文档，回放用户会话、监控前端错误，并详细调试交互问题。" +description: "将 LogRocket 集成到你的 Mintlify 文档，回放用户会话、监控前端错误，并详细调试交互问题。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["LogRocket 集成", "会话回放", "错误监控", "app ID"] boost: 3 --- diff --git a/zh/integrations/analytics/mixpanel.mdx b/zh/integrations/analytics/mixpanel.mdx index 0b595b53b9..522bc8e7c8 100644 --- a/zh/integrations/analytics/mixpanel.mdx +++ b/zh/integrations/analytics/mixpanel.mdx @@ -1,6 +1,6 @@ --- title: "Mixpanel" -description: "将 Mixpanel 集成到你的 Mintlify 文档站点，以跟踪产品分析、用户行为漏斗和内容参与事件。" +description: "将 Mixpanel 集成到你的 Mintlify 文档站点，以跟踪产品分析、用户行为漏斗和内容参与事件。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Mixpanel 集成", "产品分析", "事件跟踪", "token"] boost: 3 --- diff --git a/zh/integrations/analytics/overview.mdx b/zh/integrations/analytics/overview.mdx index 91ddc90176..7de89ca798 100644 --- a/zh/integrations/analytics/overview.mdx +++ b/zh/integrations/analytics/overview.mdx @@ -1,6 +1,6 @@ --- title: "Analytics 集成" -description: "将 Mintlify 文档连接到 Google Analytics、Mixpanel、PostHog 等分析平台，追踪访客参与情况。" +description: "将 Mintlify 文档连接到 Google Analytics、Mixpanel、PostHog 等分析平台，追踪访客参与情况。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["third-party analytics", "engagement tracking", "analytics platforms", "usage tracking"] --- diff --git a/zh/integrations/analytics/pirsch.mdx b/zh/integrations/analytics/pirsch.mdx index d0582cf9a5..ad81acec13 100644 --- a/zh/integrations/analytics/pirsch.mdx +++ b/zh/integrations/analytics/pirsch.mdx @@ -1,6 +1,6 @@ --- title: "Pirsch" -description: "将 Pirsch 集成到你的 Mintlify 文档，实现符合 GDPR 的无 Cookie 分析跟踪，不收集个人数据。" +description: "将 Pirsch 集成到你的 Mintlify 文档，实现符合 GDPR 的无 Cookie 分析跟踪，不收集个人数据。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Pirsch Analytics", "隐私分析", "identification code", "符合 GDPR"] boost: 3 --- diff --git a/zh/integrations/analytics/plausible.mdx b/zh/integrations/analytics/plausible.mdx index 79c0231d5c..7a21f44df3 100644 --- a/zh/integrations/analytics/plausible.mdx +++ b/zh/integrations/analytics/plausible.mdx @@ -1,6 +1,6 @@ --- title: "Plausible" -description: "将 Plausible Analytics 集成到你的 Mintlify 文档，实现轻量级、尊重隐私的访客跟踪，无需 Cookie 或同意横幅。" +description: "将 Plausible Analytics 集成到你的 Mintlify 文档，实现轻量级、尊重隐私的访客跟踪，无需 Cookie 或同意横幅。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["Plausible Analytics", "privacy-respecting analytics", "self-hosted analytics", "domain configuration"] boost: 3 --- diff --git a/zh/integrations/analytics/posthog.mdx b/zh/integrations/analytics/posthog.mdx index def8713f59..79c07a9d46 100644 --- a/zh/integrations/analytics/posthog.mdx +++ b/zh/integrations/analytics/posthog.mdx @@ -1,6 +1,6 @@ --- title: "PostHog" -description: "将 PostHog 集成到你的 Mintlify 文档站点，使用 API 密钥跟踪产品分析、功能使用情况和用户行为。" +description: "将 PostHog 集成到你的 Mintlify 文档站点，使用 API 密钥跟踪产品分析、功能使用情况和用户行为。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["PostHog 集成", "产品分析", "功能开关", "自托管 PostHog"] boost: 3 --- diff --git a/zh/integrations/analytics/segment.mdx b/zh/integrations/analytics/segment.mdx index cdfd1b5236..a5d8b70d00 100644 --- a/zh/integrations/analytics/segment.mdx +++ b/zh/integrations/analytics/segment.mdx @@ -1,6 +1,6 @@ --- title: "Segment" -description: "将 Segment 集成到你的 Mintlify 文档，将分析事件路由到数据仓库、CRM 和营销平台等下游工具。" +description: "将 Segment 集成到你的 Mintlify 文档，将分析事件路由到数据仓库、CRM 和营销平台等下游工具。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Segment integration", "write key", "event streaming", "CDP integration"] boost: 3 --- diff --git a/zh/integrations/privacy/osano.mdx b/zh/integrations/privacy/osano.mdx index db1ea702e9..560b39a734 100644 --- a/zh/integrations/privacy/osano.mdx +++ b/zh/integrations/privacy/osano.mdx @@ -1,6 +1,6 @@ --- title: "Osano" -description: "将 Osano 集成到你的 Mintlify 文档站点，管理 Cookie 同意横幅、隐私偏好设置和监管合规要求。" +description: "将 Osano 集成到你的 Mintlify 文档站点，管理 Cookie 同意横幅、隐私偏好设置和监管合规要求。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Osano 集成", "Cookie 同意管理器", "GDPR 合规"] boost: 3 --- diff --git a/zh/integrations/privacy/overview.mdx b/zh/integrations/privacy/overview.mdx index 61d6ceae63..66b7e77c0e 100644 --- a/zh/integrations/privacy/overview.mdx +++ b/zh/integrations/privacy/overview.mdx @@ -1,6 +1,6 @@ --- title: "隐私集成" -description: "将你的 Mintlify 文档站点连接到 Osano、Transcend 等隐私平台，管理 Cookie 同意、合规横幅和用户偏好设置。" +description: "将你的 Mintlify 文档站点连接到 Osano、Transcend 等隐私平台，管理 Cookie 同意、合规横幅和用户偏好设置。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["数据隐私平台", "合规集成", "隐私工具", "Cookie 同意"] --- diff --git a/zh/integrations/privacy/transcend.mdx b/zh/integrations/privacy/transcend.mdx index 98aaed6454..b4ca9a43c3 100644 --- a/zh/integrations/privacy/transcend.mdx +++ b/zh/integrations/privacy/transcend.mdx @@ -1,6 +1,6 @@ --- title: "Transcend" -description: "将 Transcend 同意管理与你的 Mintlify 文档集成，使用你现有的 Transcend bundle 在获得访客同意后再加载分析。" +description: "将 Transcend 同意管理与你的 Mintlify 文档集成，使用你现有的 Transcend bundle 在获得访客同意后再加载分析。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["Transcend 集成", "同意管理", "Cookie 同意", "GDPR 合规"] --- diff --git a/zh/integrations/sdks/speakeasy.mdx b/zh/integrations/sdks/speakeasy.mdx index eb2d8eb41e..cdc62bd0af 100644 --- a/zh/integrations/sdks/speakeasy.mdx +++ b/zh/integrations/sdks/speakeasy.mdx @@ -1,6 +1,6 @@ --- title: "Speakeasy" -description: "在你的 API 操作台中展示由 Speakeasy 自动生成的 SDK 代码示例，支持 Python、TypeScript、Go 等多种语言。" +description: "在你的 API 操作台中展示由 Speakeasy 自动生成的 SDK 代码示例，支持 Python、TypeScript、Go 等多种语言。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["Speakeasy SDK", "autogenerated SDKs", "SDK code samples", "API playground integration"] boost: 3 --- diff --git a/zh/integrations/sdks/stainless.mdx b/zh/integrations/sdks/stainless.mdx index 09246e43c7..2b052a9da8 100644 --- a/zh/integrations/sdks/stainless.mdx +++ b/zh/integrations/sdks/stainless.mdx @@ -1,6 +1,6 @@ --- title: "Stainless" -description: "在你的 API 操作台中展示由 Stainless 自动生成的类型安全 SDK 代码示例，支持 Python、TypeScript 等多种语言。" +description: "在你的 API 操作台中展示由 Stainless 自动生成的类型安全 SDK 代码示例，支持 Python、TypeScript 等多种语言。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。" keywords: ["Stainless SDK", "SDK 生成", "API 客户端库", "类型安全的 SDK"] boost: 3 --- diff --git a/zh/integrations/support/front.mdx b/zh/integrations/support/front.mdx index 46ba1b8c01..fa43cec63a 100644 --- a/zh/integrations/support/front.mdx +++ b/zh/integrations/support/front.mdx @@ -1,6 +1,6 @@ --- title: "Front" -description: "将 Front 聊天集成到你的 Mintlify 文档站点，让访客可以直接从文档页面发起客户支持会话。" +description: "将 Front 聊天集成到你的 Mintlify 文档站点，让访客可以直接从文档页面发起客户支持会话。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Front Chat", "聊天小组件集成", "chat ID", "客户会话"] boost: 3 --- diff --git a/zh/integrations/support/intercom.mdx b/zh/integrations/support/intercom.mdx index b93b775b7f..8f6ccc83bb 100644 --- a/zh/integrations/support/intercom.mdx +++ b/zh/integrations/support/intercom.mdx @@ -1,6 +1,6 @@ --- title: "Intercom" -description: "将 Intercom 聊天小部件集成到你的 Mintlify 文档站点，提供实时客户消息、支持和引导帮助。" +description: "将 Intercom 聊天小部件集成到你的 Mintlify 文档站点，提供实时客户消息、支持和引导帮助。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["Intercom 集成", "Intercom 小部件", "app ID", "应用内消息"] boost: 3 --- diff --git a/zh/integrations/support/overview.mdx b/zh/integrations/support/overview.mdx index cd5ec7272c..c1702edd5e 100644 --- a/zh/integrations/support/overview.mdx +++ b/zh/integrations/support/overview.mdx @@ -1,6 +1,6 @@ --- title: "支持平台集成" -description: "将你的 Mintlify 文档连接到 Intercom 和 Front 等支持平台，让访客可以直接从文档页面获得实时帮助。" +description: "将你的 Mintlify 文档连接到 Intercom 和 Front 等支持平台，让访客可以直接从文档页面获得实时帮助。本文说明第三方集成的配置步骤、使用场景和维护要点，帮助你连接 Mintlify 与外部服务。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["客户支持平台", "工单系统集成", "支持组件", "客户协助"] --- diff --git a/zh/migration-services/enterprise.mdx b/zh/migration-services/enterprise.mdx index d487a873ef..878a81d26f 100644 --- a/zh/migration-services/enterprise.mdx +++ b/zh/migration-services/enterprise.mdx @@ -1,6 +1,6 @@ --- title: "企业版迁移" -description: "了解全流程企业迁移服务，包括专属项目管理、交付周期和质量审查阶段。" +description: "了解全流程企业迁移服务，包括专属项目管理、交付周期和质量审查阶段。本文介绍企业迁移服务的项目流程、交付周期和质量审查，帮助团队规划文档迁移。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" ---
diff --git a/zh/migration.mdx b/zh/migration.mdx index 55c8e02989..88fc6c69f8 100644 --- a/zh/migration.mdx +++ b/zh/migration.mdx @@ -1,6 +1,6 @@ --- title: "迁移到 Mintlify" -description: "从 Docusaurus、ReadMe、GitBook 或其他平台将文档迁移到 Mintlify，提供逐步说明和 CLI 工具支持。" +description: "从 Docusaurus、ReadMe、GitBook 或其他平台将文档迁移到 Mintlify，提供逐步说明和 CLI 工具支持。本文介绍迁移到 Mintlify 的准备工作、实施步骤和上线注意事项，帮助团队平稳切换文档平台。这些说明适合开发者和文档维护者查阅。" keywords: ["migration", "Docusaurus", "ReadMe", "import"] --- diff --git a/zh/optimize/analytics.mdx b/zh/optimize/analytics.mdx index 8241f007c9..5ccfb52821 100644 --- a/zh/optimize/analytics.mdx +++ b/zh/optimize/analytics.mdx @@ -1,6 +1,6 @@ --- -title: "分析" -description: "在 Mintlify 分析仪表板中跟踪流量、搜索趋势、助手使用情况和用户反馈，以改进内容并评估效果。" +title: "Mintlify 文档分析" +description: "在 Mintlify 分析仪表板中跟踪流量、搜索趋势、助手使用情况和用户反馈，以改进内容并评估效果。本文介绍优化方法和关键指标，帮助你提升文档质量、搜索效果和用户体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["analytics","metrics","page views","traffic","trends","insights","impressions","CTA","call-to-action"] boost: 3 --- diff --git a/zh/optimize/feedback.mdx b/zh/optimize/feedback.mdx index 7880685508..23b1af7f6b 100644 --- a/zh/optimize/feedback.mdx +++ b/zh/optimize/feedback.mdx @@ -1,6 +1,6 @@ --- title: "收集来自用户和 AI 智能体的页面反馈" -description: "启用反馈小部件、页面评分、上下文备注、代码片段反应以及智能体反馈，帮助你发现并修复文档中的问题。" +description: "启用反馈小部件、页面评分、上下文备注、代码片段反应以及智能体反馈，帮助你发现并修复文档中的问题。本文介绍优化方法和关键指标，帮助你提升文档质量、搜索效果和用户体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction", "agents"] boost: 3 --- diff --git a/zh/optimize/pdf-exports.mdx b/zh/optimize/pdf-exports.mdx index 64ee9fdde3..7c4a931762 100644 --- a/zh/optimize/pdf-exports.mdx +++ b/zh/optimize/pdf-exports.mdx @@ -1,6 +1,6 @@ --- title: "导出 PDF" -description: "将整个文档站点导出为带有可导航目录的单个 PDF 文件，便于离线阅读、分享和打印。" +description: "将整个文档站点导出为带有可导航目录的单个 PDF 文件，便于离线阅读、分享和打印。本文介绍优化方法和关键指标，帮助你提升文档质量、搜索效果和用户体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["PDF", "离线文档"] --- diff --git a/zh/optimize/search-boost.mdx b/zh/optimize/search-boost.mdx index 5639b62928..76a218b12a 100644 --- a/zh/optimize/search-boost.mdx +++ b/zh/optimize/search-boost.mdx @@ -1,6 +1,6 @@ --- title: "搜索加权" -description: "通过在页面 frontmatter 或 `docs.json` 导航中设置数值加权乘数，使你的文档站点内置搜索的排名向特定页面或章节倾斜。" +description: "通过在页面 frontmatter 或 `docs.json` 导航中设置数值加权乘数，使你的文档站点内置搜索的排名向特定页面或章节倾斜。本文介绍优化方法和关键指标，帮助你提升文档质量、搜索效果和用户体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["搜索排名", "搜索加权", "加权", "搜索优先级"] --- diff --git a/zh/optimize/search.mdx b/zh/optimize/search.mdx index bea7771d92..fc486d7d5c 100644 --- a/zh/optimize/search.mdx +++ b/zh/optimize/search.mdx @@ -1,7 +1,7 @@ --- title: "配置站内搜索的排名、结果和筛选器" sidebarTitle: "搜索" -description: "配置你的 Mintlify 文档站点上的站内搜索栏：排名加权、每次查询的最大结果数，以及按产品和版本进行的搜索筛选器。" +description: "配置你的 Mintlify 文档站点上的站内搜索栏：排名加权、每次查询的最大结果数，以及按产品和版本进行的搜索筛选器。本文介绍优化方法和关键指标，帮助你提升文档质量、搜索效果和用户体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["搜索", "搜索排名", "搜索加权", "加权", "搜索优先级", "最大搜索结果数", "最大结果数", "searchable", "从搜索中排除", "筛选器"] --- diff --git a/zh/optimize/seo.mdx b/zh/optimize/seo.mdx index e41fa29d9f..316ba87cb8 100644 --- a/zh/optimize/seo.mdx +++ b/zh/optimize/seo.mdx @@ -1,6 +1,6 @@ --- title: "SEO（搜索引擎优化）" -description: "配置元标签、Open Graph 属性、规范 URL 和页面级 SEO 设置，提升文档在搜索引擎中的排名。" +description: "配置元标签、Open Graph 属性、规范 URL 和页面级 SEO 设置，提升文档在搜索引擎中的排名。本文介绍优化方法和关键指标，帮助你提升文档质量、搜索效果和用户体验。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["meta tags", "sitemap", "robots.txt", "SEO", "search engine optimization"] boost: 3 --- diff --git a/zh/organize/hidden-page-example.mdx b/zh/organize/hidden-page-example.mdx index dddf85c909..7249187a2d 100644 --- a/zh/organize/hidden-page-example.mdx +++ b/zh/organize/hidden-page-example.mdx @@ -1,6 +1,6 @@ --- title: "隐藏页面示例" -description: "探索 Mintlify 中隐藏页面的使用场景，包括 Beta 文档、AI 上下文文件、旧版内容存档和内部工具参考。" +description: "探索 Mintlify 中隐藏页面的使用场景，包括 Beta 文档、AI 上下文文件、旧版内容存档和内部工具参考。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" --- 这是一个隐藏页面。它不会出现在 `docs.json` 的导航中，因此你只能通过其 URL 访问。 diff --git a/zh/organize/hidden-pages.mdx b/zh/organize/hidden-pages.mdx index f7dbead652..b65d705a4b 100644 --- a/zh/organize/hidden-pages.mdx +++ b/zh/organize/hidden-pages.mdx @@ -1,6 +1,6 @@ --- title: "隐藏页面" -description: "将文档页面从侧边栏导航中隐藏，同时仍可通过直接 URL、站内搜索或 AI 助手访问，适用于内部参考、AI 上下文等特殊场景。" +description: "将文档页面从侧边栏导航中隐藏，同时仍可通过直接 URL、站内搜索或 AI 助手访问，适用于内部参考、AI 上下文等特殊场景。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["从导航中隐藏", "未列出", "页面可见性"] --- diff --git a/zh/organize/mintignore.mdx b/zh/organize/mintignore.mdx index 31d6f8afbc..d3e86a3885 100644 --- a/zh/organize/mintignore.mdx +++ b/zh/organize/mintignore.mdx @@ -1,7 +1,7 @@ --- title: "从发布中排除文件" sidebarTitle: "排除文件" -description: "使用带有 glob 模式的 .mintignore 文件将特定文件和目录排除在已发布文档之外，语法类似 .gitignore。" +description: "使用带有 glob 模式的 .mintignore 文件将特定文件和目录排除在已发布文档之外，语法类似 .gitignore。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["排除", "忽略", "gitignore", "草稿", "私有"] --- diff --git a/zh/organize/navigation.mdx b/zh/organize/navigation.mdx index ed9af22a7c..92cbd11d94 100644 --- a/zh/organize/navigation.mdx +++ b/zh/organize/navigation.mdx @@ -1,6 +1,6 @@ --- -title: "导航" -description: "在 docs.json 中使用分组、页面、下拉菜单、标签页和锚点配置文档站点导航，构建侧边栏结构。" +title: "文档导航配置" +description: "在 docs.json 中使用分组、页面、下拉菜单、标签页和锚点配置文档站点导航，构建侧边栏结构。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["导航结构", "侧边栏配置", "页面组织", "导航分组"] boost: 3 --- diff --git a/zh/organize/pages.mdx b/zh/organize/pages.mdx index 2384f6c4e4..187ef66bdc 100644 --- a/zh/organize/pages.mdx +++ b/zh/organize/pages.mdx @@ -1,5 +1,5 @@ --- -title: "页面" +title: "页面元数据与设置" description: "使用 MDX 文件顶部的 YAML frontmatter 配置页面标题、描述、侧边栏、图标、标签、搜索与 SEO 元数据，并了解页面布局模式、API 页面、外部链接和时间戳设置。本文完整介绍隐藏、索引、可搜索性、搜索加权、相关页面、访问组和上下文菜单等字段，帮助你为文档页面选择合适的布局与行为。" keywords: ["tags", "tag", "frontmatter", "metadata", "layout"] boost: 3 diff --git a/zh/organize/related-pages.mdx b/zh/organize/related-pages.mdx index e69ee266fd..352c3530d1 100644 --- a/zh/organize/related-pages.mdx +++ b/zh/organize/related-pages.mdx @@ -1,6 +1,6 @@ --- title: "相关页面" -description: "使用自动推荐或在页面 frontmatter 中手动整理的链接，在每个页面底部添加“相关主题”版块。" +description: "使用自动推荐或在页面 frontmatter 中手动整理的链接，在每个页面底部添加“相关主题”版块。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["相关", "相关页面", "相关主题", "推荐", "frontmatter"] --- diff --git a/zh/organize/settings-api.mdx b/zh/organize/settings-api.mdx index a5a0325dbd..217097a54f 100644 --- a/zh/organize/settings-api.mdx +++ b/zh/organize/settings-api.mdx @@ -1,6 +1,6 @@ --- title: "API 设置" -description: "在 docs.json 文件中配置 OpenAPI 和 AsyncAPI 规范、交互式 API 演练场、SDK 代码示例和身份验证设置。" +description: "在 docs.json 文件中配置 OpenAPI 和 AsyncAPI 规范、交互式 API 演练场、SDK 代码示例和身份验证设置。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" keywords: ["api", "openapi", "asyncapi", "演练场", "docs.json", "api 参考"] --- diff --git a/zh/organize/settings-appearance.mdx b/zh/organize/settings-appearance.mdx index c488a1bd51..8e4cfd3860 100644 --- a/zh/organize/settings-appearance.mdx +++ b/zh/organize/settings-appearance.mdx @@ -1,6 +1,6 @@ --- title: "外观与品牌" -description: "在 docs.json 中配置主题、颜色、logo、favicon、字体和背景。" +description: "在 docs.json 中配置主题、颜色、logo、favicon、字体和背景。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["主题", "颜色", "logo", "favicon", "字体", "背景", "外观", "品牌", "深色模式", "图标", "样式", "docs.json"] --- diff --git a/zh/organize/settings-integrations.mdx b/zh/organize/settings-integrations.mdx index d7ee15971b..ede329078c 100644 --- a/zh/organize/settings-integrations.mdx +++ b/zh/organize/settings-integrations.mdx @@ -1,6 +1,6 @@ --- -title: "集成" -description: "通过 docs.json 中的集成配置，将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。" +title: "文档集成配置" +description: "通过 docs.json 中的集成配置，将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["集成", "分析", "google analytics", "posthog", "segment", "intercom", "hotjar", "mixpanel", "amplitude", "docs.json"] boost: 3 --- diff --git a/zh/organize/settings-reference.mdx b/zh/organize/settings-reference.mdx index 88fff90c64..012284ce45 100644 --- a/zh/organize/settings-reference.mdx +++ b/zh/organize/settings-reference.mdx @@ -1,6 +1,6 @@ --- title: "docs.json schema 参考" -description: "所有 `docs.json` 配置属性的完整参考，包含类型、默认值和描述。" +description: "所有 `docs.json` 配置属性的完整参考，包含类型、默认值和描述。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["docs.json", "schema", "参考", "配置", "所有设置", "属性", "完整"] --- diff --git a/zh/organize/settings-seo.mdx b/zh/organize/settings-seo.mdx index 7025ea6bf3..69afc162dc 100644 --- a/zh/organize/settings-seo.mdx +++ b/zh/organize/settings-seo.mdx @@ -1,6 +1,6 @@ --- title: "SEO 和搜索" -description: "在 docs.json 中配置 SEO 设置，包括站点描述、搜索引擎索引、meta 标签、搜索栏占位符和页面时间戳。" +description: "在 docs.json 中配置 SEO 设置，包括站点描述、搜索引擎索引、meta 标签、搜索栏占位符和页面时间戳。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["SEO", "搜索", "索引", "meta 标签", "描述", "时间戳", "最后修改", "docs.json"] --- diff --git a/zh/organize/settings-structure.mdx b/zh/organize/settings-structure.mdx index 9d9f088743..27b88bac81 100644 --- a/zh/organize/settings-structure.mdx +++ b/zh/organize/settings-structure.mdx @@ -1,6 +1,6 @@ --- title: "站点结构" -description: "在 docs.json 中配置导航栏、页脚、横幅、重定向和其他结构设置。" +description: "在 docs.json 中配置导航栏、页脚、横幅、重定向和其他结构设置。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。请根据项目需求选择合适的配置方式。" keywords: ["导航栏", "导航", "页脚", "横幅", "上下文", "重定向", "变量", "元数据", "docs.json"] --- diff --git a/zh/organize/settings.mdx b/zh/organize/settings.mdx index 077b430a90..e8a381a973 100644 --- a/zh/organize/settings.mdx +++ b/zh/organize/settings.mdx @@ -1,6 +1,6 @@ --- title: "全局设置" -description: "使用 docs.json 配置你的 Mintlify 文档站点，该文件控制导航、外观和集成。" +description: "使用 docs.json 配置你的 Mintlify 文档站点，该文件控制导航、外观和集成。本文说明配置字段、使用场景和维护要点，帮助你组织内容并管理文档站点。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。相关做法也便于团队后续维护和协作。" keywords: ["docs.json", "配置", "设置", "mint.json"] --- diff --git a/zh/status.mdx b/zh/status.mdx index 3e5857c8b6..fbd84195fb 100644 --- a/zh/status.mdx +++ b/zh/status.mdx @@ -1,6 +1,6 @@ --- title: "状态页面" -description: "查看 Mintlify 实时服务状态、浏览事故历史记录，并订阅服务中断和维护窗口的电子邮件通知。" +description: "查看 Mintlify 实时服务状态、浏览事故历史记录，并订阅服务中断和维护窗口的电子邮件通知。本文提供 Mintlify 服务状态、事件更新和历史可用性信息，帮助你判断当前是否存在平台故障。这些说明适合开发者和文档维护者查阅。你可以结合页面示例完成相关操作。" --- Mintlify 维护了一个公开的状态页面，您可以在此查看其服务的实时运行状态，并查看历史可用性数据。 diff --git a/zh/what-is-mintlify.mdx b/zh/what-is-mintlify.mdx index 5a9aad1171..a01f608a36 100644 --- a/zh/what-is-mintlify.mdx +++ b/zh/what-is-mintlify.mdx @@ -1,6 +1,6 @@ --- title: "什么是 Mintlify？" -description: "Mintlify 是一个为开发者和 AI 设计的文档平台，具备智能搜索、交互式 API Playground 和内置分析功能。" +description: "Mintlify 是一个为开发者和 AI 设计的文档平台，具备智能搜索、交互式 API Playground 和内置分析功能。本文介绍 Mintlify 的核心功能、适用场景和 AI 原生文档工作流，帮助你判断平台是否适合团队。这些说明适合开发者和文档维护者查阅。" keywords: ["overview", "how it works", "architecture"] ---