From 529da0bf8df0a46873b4ecfcdc6401915b54ecbb Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 31 Aug 2026 21:05:11 +0000 Subject: [PATCH] docs: fix SEO title and description metadata across all locales --- assistant/widget-preview.mdx | 2 +- editor/collaborate.mdx | 2 +- editor/publish.mdx | 2 +- editor/review.mdx | 2 +- es/ai/bring-your-own-model.mdx | 2 +- es/assistant/widget-preview.mdx | 2 +- es/cli/mdx-extension.mdx | 2 +- es/components/mdx.mdx | 2 +- es/editor/agent.mdx | 2 +- es/editor/collaborate.mdx | 2 +- es/editor/pages.mdx | 2 +- es/editor/review.mdx | 2 +- es/editor/settings.mdx | 2 +- es/help-center/can-i-rename-my-deployment-or-organization.mdx | 2 +- es/help-center/configure-oauth-with-auth0.mdx | 2 +- .../preview-deployment-not-created-for-fork-branch.mdx | 4 ++-- .../private-repo-missing-when-creating-second-deployment.mdx | 4 ++-- es/help-center/static-file-not-served.mdx | 4 ++-- es/migration-services/go-live-checklist.mdx | 2 +- es/migration/document360.mdx | 2 +- fr/ai/bring-your-own-model.mdx | 2 +- fr/assistant/widget-preview.mdx | 2 +- fr/cli/mdx-extension.mdx | 2 +- fr/components/mdx.mdx | 2 +- fr/deploy/rollbacks.mdx | 2 +- fr/editor/agent.mdx | 2 +- fr/editor/index.mdx | 2 +- fr/editor/pages.mdx | 2 +- fr/editor/settings.mdx | 2 +- fr/help-center/configure-oauth-with-auth0.mdx | 2 +- .../preview-deployment-not-created-for-fork-branch.mdx | 4 ++-- .../private-repo-missing-when-creating-second-deployment.mdx | 2 +- fr/help-center/static-file-not-served.mdx | 2 +- fr/migration-services/go-live-checklist.mdx | 2 +- fr/migration/docusaurus.mdx | 2 +- fr/migration/index.mdx | 2 +- fr/migration/manual.mdx | 2 +- help-center/branch-missing-from-editor-branch-list.mdx | 2 +- migration/manual.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/ai-native.mdx | 2 +- zh/ai/bring-your-own-model.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/analytics/assistant.mdx | 2 +- zh/analytics/export.mdx | 2 +- zh/analytics/index.mdx | 2 +- zh/analytics/search.mdx | 2 +- zh/analytics/streaming.mdx | 2 +- zh/analytics/traffic.mdx | 2 +- zh/analytics/user-engagements.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/overview.mdx | 2 +- zh/api-playground/troubleshooting.mdx | 2 +- zh/api-playground/websocket-playground.mdx | 2 +- 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 | 2 +- zh/api/search-index/introduction.mdx | 2 +- 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-preview.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/changelog.mdx | 2 +- zh/cli/mdx-extension.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/github.mdx | 2 +- zh/components/icons.mdx | 2 +- zh/components/index.mdx | 2 +- zh/components/mdx.mdx | 2 +- 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 | 2 +- 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 | 2 +- zh/customize/react-components.mdx | 2 +- zh/customize/themes.mdx | 2 +- zh/dashboard/audit-logs.mdx | 2 +- zh/dashboard/network-access.mdx | 2 +- zh/dashboard/roles.mdx | 2 +- zh/dashboard/scim.mdx | 2 +- zh/dashboard/security-contact.mdx | 2 +- zh/dashboard/session-security.mdx | 2 +- zh/dashboard/sso.mdx | 2 +- zh/deploy/bitbucket.mdx | 2 +- zh/deploy/ci.mdx | 2 +- zh/deploy/cloudflare.mdx | 2 +- zh/deploy/csp-configuration.mdx | 2 +- zh/deploy/custom-portal.mdx | 2 +- zh/deploy/deployments.mdx | 2 +- 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/rollbacks.mdx | 2 +- zh/deploy/route53-cloudfront.mdx | 2 +- zh/deploy/self-host.mdx | 2 +- zh/deploy/vercel.mdx | 2 +- zh/editor/agent.mdx | 2 +- zh/editor/collaborate.mdx | 2 +- zh/editor/index.mdx | 2 +- zh/editor/keyboard-shortcuts.mdx | 2 +- zh/editor/pages.mdx | 2 +- zh/editor/publish.mdx | 2 +- zh/editor/review.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 | 2 +- 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/help-center/can-i-rename-my-deployment-or-organization.mdx | 2 +- zh/help-center/configure-oauth-with-auth0.mdx | 2 +- .../domain-already-claimed-by-another-organization.mdx | 2 +- zh/help-center/openapi-url-fetch-fails-during-build.mdx | 2 +- .../preview-deployment-not-created-for-fork-branch.mdx | 2 +- .../private-repo-missing-when-creating-second-deployment.mdx | 2 +- zh/help-center/static-file-not-served.mdx | 2 +- zh/help-center/style-card-icons-with-custom-css.mdx | 2 +- zh/index.mdx | 2 +- 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-services/go-live-checklist.mdx | 2 +- zh/migration/document360.mdx | 2 +- zh/migration/docusaurus.mdx | 2 +- zh/migration/fern.mdx | 2 +- zh/migration/gitbook.mdx | 2 +- zh/migration/index.mdx | 2 +- zh/migration/manual.mdx | 2 +- zh/migration/readme.mdx | 2 +- zh/optimize/feedback.mdx | 2 +- zh/optimize/pdf-exports.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 | 2 +- zh/organize/related-pages.mdx | 2 +- zh/organize/settings-api.mdx | 2 +- zh/organize/settings-appearance.mdx | 2 +- zh/organize/settings-integrations.mdx | 2 +- zh/organize/settings-reference.mdx | 2 +- zh/organize/settings-seo.mdx | 2 +- zh/organize/settings-structure.mdx | 2 +- zh/organize/settings.mdx | 2 +- zh/poc-onboarding.mdx | 2 +- zh/reference/concepts.mdx | 2 +- zh/reference/glossary.mdx | 2 +- zh/search-index/connect.mdx | 2 +- zh/search-index/index.mdx | 2 +- zh/search-index/mcp.mdx | 2 +- zh/status.mdx | 2 +- 268 files changed, 272 insertions(+), 272 deletions(-) diff --git a/assistant/widget-preview.mdx b/assistant/widget-preview.mdx index a4f8a2de12..1a4190b361 100644 --- a/assistant/widget-preview.mdx +++ b/assistant/widget-preview.mdx @@ -1,6 +1,6 @@ --- title: "Widget preview" -description: "Host page for the live preview in the assistant widget playground." +description: "Host page that renders the live preview iframe for the assistant widget playground, letting you test widget appearance and settings in Mintlify docs." keywords: ["assistant", "widget", "preview"] mode: "custom" noindex: true diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index a5fa675881..077a264573 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -1,7 +1,7 @@ --- title: "Collaborate in the editor" sidebarTitle: "Collaborate" -description: "Leave comments, propose changes as suggestions, and edit alongside teammates in real time in the editor." +description: "Leave comments, propose changes as suggestions, and edit pages alongside teammates in real time with the collaboration features in the Mintlify editor." keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] --- diff --git a/editor/publish.mdx b/editor/publish.mdx index b287755ebd..c1a5ce960f 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -1,7 +1,7 @@ --- title: "Publish changes" sidebarTitle: "Publish" -description: "Publish changes from the editor to your live site. Branches and protection rules determine what happens when you publish." +description: "Publish changes from the Mintlify editor to your live docs site, and learn how branches, pull requests, and auto publish affect what you publish." keywords: ["publish", "branch", "git", "commit", "conflicts", "deploy", "pull request"] --- diff --git a/editor/review.mdx b/editor/review.mdx index c3417542d7..5aee80963b 100644 --- a/editor/review.mdx +++ b/editor/review.mdx @@ -1,7 +1,7 @@ --- title: "Review changes" sidebarTitle: "Review" -description: "Preview changes before they go live, share them with your team, and approve and merge pull requests from the editor." +description: "Preview changes before they go live on your docs site, share preview links with your team, and approve and merge pull requests in the Mintlify editor." keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"] --- diff --git a/es/ai/bring-your-own-model.mdx b/es/ai/bring-your-own-model.mdx index f933e7fc8a..7ab8a61f09 100644 --- a/es/ai/bring-your-own-model.mdx +++ b/es/ai/bring-your-own-model.mdx @@ -1,6 +1,6 @@ --- title: "Usa tu propio modelo" -description: "Usa tu propia clave de API de un proveedor de LLM y elige el modelo que impulsa el assistant, el agente y las automatizaciones de Mintlify en los planes Enterprise." +description: "Usa tu propia clave de API de un proveedor de LLM y elige el modelo que impulsa el assistant, el agente y las automatizaciones de Mintlify en Enterprise." keywords: ["BYOK", "clave", "OpenRouter", "Anthropic", "OpenAI", "LLM", "clave de API", "créditos"] --- diff --git a/es/assistant/widget-preview.mdx b/es/assistant/widget-preview.mdx index a4f8a2de12..440047d59f 100644 --- a/es/assistant/widget-preview.mdx +++ b/es/assistant/widget-preview.mdx @@ -1,6 +1,6 @@ --- title: "Widget preview" -description: "Host page for the live preview in the assistant widget playground." +description: "Página host que muestra la vista previa en vivo del playground del widget del assistant para probar su apariencia y configuración en Mintlify." keywords: ["assistant", "widget", "preview"] mode: "custom" noindex: true diff --git a/es/cli/mdx-extension.mdx b/es/cli/mdx-extension.mdx index 730766f741..4ce0b7c360 100644 --- a/es/cli/mdx-extension.mdx +++ b/es/cli/mdx-extension.mdx @@ -1,6 +1,6 @@ --- title: "Extensión Mintlify MDX" -description: "Instala la extensión Mintlify MDX para obtener autocompletado, diagnósticos en línea, documentación al pasar el cursor y una previsualización en el editor mientras escribes MDX localmente." +description: "Instala la extensión Mintlify MDX y obtén autocompletado, diagnósticos en línea y previsualización en el editor mientras escribes MDX localmente." keywords: ["Cursor", "MDX", "autocompletado", "diagnósticos", "IntelliSense", "previsualización", "editor"] --- diff --git a/es/components/mdx.mdx b/es/components/mdx.mdx index c8c1e79e22..3427b71c14 100644 --- a/es/components/mdx.mdx +++ b/es/components/mdx.mdx @@ -1,6 +1,6 @@ --- title: "MDX" -description: "Usa el componente MDX para renderizar Markdown dentro de expresiones y condicionales JSX, de modo que encabezados, bloques de código y tablas se compilen como el resto de tu página." +description: "Usa el componente MDX de Mintlify para renderizar Markdown dentro de expresiones y condicionales JSX: encabezados, código y tablas se compilan normalmente." keywords: ["MDX component", "conditional content", "markdown in JSX", "expressions", "ternary"] --- diff --git a/es/editor/agent.mdx b/es/editor/agent.mdx index 499a55ee14..e1d207cb45 100644 --- a/es/editor/agent.mdx +++ b/es/editor/agent.mdx @@ -1,6 +1,6 @@ --- title: "Preguntar al agente" -description: "Use el agente de IA integrado del editor para escribir contenido, editar páginas, dejar comentarios y sugerencias, buscar en su sitio, subir archivos y ajustar la configuración." +description: "Use el agente de IA integrado del editor de Mintlify para escribir contenido, editar páginas, dejar comentarios, buscar y ajustar la configuración." keywords: ["editor", "AI", "assistant", "agent", "chat", "comments", "suggestions", "code mode", "file upload"] --- diff --git a/es/editor/collaborate.mdx b/es/editor/collaborate.mdx index d2bea2e0b9..6236a2d465 100644 --- a/es/editor/collaborate.mdx +++ b/es/editor/collaborate.mdx @@ -1,7 +1,7 @@ --- title: "Colaborar en el editor" sidebarTitle: "Colaborar" -description: "Deje comentarios, proponga cambios como sugerencias y edite junto a sus compañeros en tiempo real en el editor." +description: "Deje comentarios, proponga cambios como sugerencias y edite páginas junto a sus compañeros en tiempo real con la colaboración del editor de Mintlify." keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] --- diff --git a/es/editor/pages.mdx b/es/editor/pages.mdx index 7a6312e172..99d7e9dc45 100644 --- a/es/editor/pages.mdx +++ b/es/editor/pages.mdx @@ -1,7 +1,7 @@ --- title: "Crear y editar páginas" sidebarTitle: "Editar contenido" -description: "Cree páginas, edite contenido, añada archivos multimedia, organice su navegación, restaure versiones anteriores de una página y gestione páginas privadas en el editor." +description: "Cree páginas, edite contenido, añada multimedia, organice la navegación, restaure versiones y gestione páginas privadas en el editor de Mintlify." keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- diff --git a/es/editor/review.mdx b/es/editor/review.mdx index db739ae397..aac8906dfb 100644 --- a/es/editor/review.mdx +++ b/es/editor/review.mdx @@ -1,7 +1,7 @@ --- title: "Revisar cambios" sidebarTitle: "Revisar" -description: "Previsualice los cambios antes de publicarlos, compártalos con su equipo y apruebe y haga merge de pull requests desde el editor." +description: "Previsualice los cambios antes de publicarlos, compártalos con su equipo y apruebe y haga merge de pull requests desde el editor de Mintlify." keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"] --- diff --git a/es/editor/settings.mdx b/es/editor/settings.mdx index 4f47fcceae..c26173d0db 100644 --- a/es/editor/settings.mdx +++ b/es/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "Configuración del editor para IA y publicación" sidebarTitle: "Configuración" -description: "Configure la apariencia del editor, las instrucciones de IA y los valores predeterminados de publicación para controlar cómo se ve el editor y cómo confirma y hace merge de los cambios." +description: "Configure la apariencia del editor de Mintlify, las instrucciones de IA y los valores de publicación que controlan cómo se confirman los cambios." keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- diff --git a/es/help-center/can-i-rename-my-deployment-or-organization.mdx b/es/help-center/can-i-rename-my-deployment-or-organization.mdx index 3882cf3ec5..616d460c29 100644 --- a/es/help-center/can-i-rename-my-deployment-or-organization.mdx +++ b/es/help-center/can-i-rename-my-deployment-or-organization.mdx @@ -1,5 +1,5 @@ --- -title: "¿Puedo cambiar el nombre de mi implementación u organización?" +title: "¿Puedo renombrar mi implementación u organización?" description: "Cambia el nombre de proyecto de tu implementación desde el panel y por qué los subdominios y nombres de organización requieren recrearse." keywords: ["renombrar implementación", "cambiar nombre de implementación", "renombrar organización", "cambiar nombre de organización", "cambiar subdominio", "nombre de proyecto", "eliminar y volver a crear"] --- diff --git a/es/help-center/configure-oauth-with-auth0.mdx b/es/help-center/configure-oauth-with-auth0.mdx index d2178b5c50..855e6ad4fd 100644 --- a/es/help-center/configure-oauth-with-auth0.mdx +++ b/es/help-center/configure-oauth-with-auth0.mdx @@ -1,6 +1,6 @@ --- title: "Configurar la autenticación OAuth 2.0 con Auth0" -description: "Configura Auth0 como proveedor de identidad OAuth 2.0 para un sitio privado de documentación de Mintlify, incluyendo las URLs de los endpoints, el registro del callback y el control de acceso basado en grupos." +description: "Configura Auth0 como proveedor de identidad OAuth 2.0 para docs privadas de Mintlify: URLs de endpoints, registro del callback y acceso por grupos." keywords: ["Auth0", "OAuth", "OAuth 2.0", "OIDC", "identity provider", "SSO", "private docs", "authentication"] --- diff --git a/es/help-center/preview-deployment-not-created-for-fork-branch.mdx b/es/help-center/preview-deployment-not-created-for-fork-branch.mdx index 166e86618a..84e3bd52ed 100644 --- a/es/help-center/preview-deployment-not-created-for-fork-branch.mdx +++ b/es/help-center/preview-deployment-not-created-for-fork-branch.mdx @@ -1,6 +1,6 @@ --- -title: "No se crea una implementación de vista previa para una rama de un fork" -description: "Por qué las solicitudes de extracción de forks y las ramas de forks pasadas a la API de vista previa no producen implementaciones de vista previa, y cómo los mantenedores pueden previsualizar los cambios de un fork." +title: "No se crea la vista previa para una rama de fork" +description: "Por qué las pull requests y ramas de forks no generan implementaciones de vista previa en Mintlify y cómo los mantenedores pueden previsualizar cambios." keywords: ["fork pull request", "no preview link", "preview deployment missing", "fork branch preview", "trigger preview API fork", "external contributor preview"] --- diff --git a/es/help-center/private-repo-missing-when-creating-second-deployment.mdx b/es/help-center/private-repo-missing-when-creating-second-deployment.mdx index 894c116c86..607fb0f938 100644 --- a/es/help-center/private-repo-missing-when-creating-second-deployment.mdx +++ b/es/help-center/private-repo-missing-when-creating-second-deployment.mdx @@ -1,6 +1,6 @@ --- -title: "Repositorio privado no aparece al crear una segunda implementación" -description: "Vuelve a autorizar Mintlify con acceso a repositorios privados para que un repositorio privado de GitHub aparezca en el selector de repositorios durante la incorporación." +title: "Repositorio privado ausente al crear otra implementación" +description: "Vuelve a autorizar Mintlify con acceso a repositorios privados para que tu repositorio privado de GitHub aparezca en el selector durante el onboarding." keywords: ["segunda implementación", "múltiples implementaciones mismo repo", "repositorio privado no aparece", "selector de repositorios de onboarding", "autorizar GitHub", "private=true", "re-autorizar GitHub"] --- diff --git a/es/help-center/static-file-not-served.mdx b/es/help-center/static-file-not-served.mdx index 452729fb75..31689f8899 100644 --- a/es/help-center/static-file-not-served.mdx +++ b/es/help-center/static-file-not-served.mdx @@ -1,6 +1,6 @@ --- -title: "Corregir un archivo estático que devuelve 404 en tu sitio de documentación" -description: "Diagnostica por qué un archivo que agregaste a tu repositorio de documentación (como un JSON, PDF o imagen) no se carga en su URL esperada en tu sitio de Mintlify." +title: "Corregir un archivo estático que devuelve 404" +description: "Diagnostica por qué un archivo de tu repositorio de documentación (JSON, PDF o imagen) no se carga en su URL esperada en tu sitio de Mintlify." keywords: ["static file not served", "404 asset", "JSON not found", "mintignore", "static assets", "file serving"] --- diff --git a/es/migration-services/go-live-checklist.mdx b/es/migration-services/go-live-checklist.mdx index ac3719bbad..25ef469157 100644 --- a/es/migration-services/go-live-checklist.mdx +++ b/es/migration-services/go-live-checklist.mdx @@ -1,6 +1,6 @@ --- title: "Lista de verificación previa al lanzamiento" -description: "Una lista de verificación previa al lanzamiento para comprobar las redirecciones, el dominio personalizado, la autenticación, las analíticas y los ajustes de SEO antes de publicar tu sitio de documentación de Mintlify." +description: "Lista de verificación previa al lanzamiento: comprueba redirecciones, dominio personalizado, autenticación, analíticas y SEO en tu sitio de Mintlify." noindex: true --- diff --git a/es/migration/document360.mdx b/es/migration/document360.mdx index 76cfc9b27e..12648416ad 100644 --- a/es/migration/document360.mdx +++ b/es/migration/document360.mdx @@ -1,6 +1,6 @@ --- title: "Migrar desde Document360" -description: "Migra workspaces, idiomas, artículos, categorías, medios, contenido reutilizable y referencias de API de Document360 a Mintlify." +description: "Migra workspaces, idiomas, artículos, categorías, medios, contenido reutilizable y referencias de API desde Document360 a tu proyecto de Mintlify." keywords: ["migración de Document360", "Document360 a Mintlify", "exportar knowledge base", "ZIP de proyecto"] --- diff --git a/fr/ai/bring-your-own-model.mdx b/fr/ai/bring-your-own-model.mdx index a6f40eb966..a443697dd9 100644 --- a/fr/ai/bring-your-own-model.mdx +++ b/fr/ai/bring-your-own-model.mdx @@ -1,6 +1,6 @@ --- title: "Utiliser votre propre modèle" -description: "Utilisez votre propre clé d'API de fournisseur LLM et choisissez le modèle qui alimente l'assistant, l'agent et les automatisations Mintlify sur les forfaits Enterprise." +description: "Utilisez votre propre clé d'API de fournisseur LLM et choisissez le modèle qui alimente l'assistant, l'agent et les automatisations Mintlify en Enterprise." keywords: ["BYOK", "clé", "OpenRouter", "Anthropic", "OpenAI", "LLM", "clé d'API", "crédits"] --- diff --git a/fr/assistant/widget-preview.mdx b/fr/assistant/widget-preview.mdx index a4f8a2de12..71b71c9d00 100644 --- a/fr/assistant/widget-preview.mdx +++ b/fr/assistant/widget-preview.mdx @@ -1,6 +1,6 @@ --- title: "Widget preview" -description: "Host page for the live preview in the assistant widget playground." +description: "Page hôte qui affiche l'aperçu en direct du playground du widget assistant pour tester son apparence et sa configuration dans Mintlify." keywords: ["assistant", "widget", "preview"] mode: "custom" noindex: true diff --git a/fr/cli/mdx-extension.mdx b/fr/cli/mdx-extension.mdx index bda9be6227..972c82c119 100644 --- a/fr/cli/mdx-extension.mdx +++ b/fr/cli/mdx-extension.mdx @@ -1,6 +1,6 @@ --- title: "Extension Mintlify MDX" -description: "Installez l'extension Mintlify MDX pour bénéficier de l'autocomplétion, des diagnostics en ligne, de la documentation au survol et d'une prévisualisation dans l'éditeur pendant que vous rédigez du MDX en local." +description: "Installez l'extension Mintlify MDX pour profiter de l'autocomplétion, des diagnostics en ligne et d'une prévisualisation pendant la rédaction de MDX." keywords: ["Cursor", "MDX", "autocomplétion", "diagnostics", "IntelliSense", "prévisualisation", "éditeur"] --- diff --git a/fr/components/mdx.mdx b/fr/components/mdx.mdx index f3447d35bf..a18e7a1d74 100644 --- a/fr/components/mdx.mdx +++ b/fr/components/mdx.mdx @@ -1,6 +1,6 @@ --- title: "MDX" -description: "Utilisez le composant MDX pour afficher du Markdown dans des expressions et conditions JSX, afin que titres, blocs de code et tableaux se compilent comme le reste de votre page." +description: "Utilisez le composant MDX de Mintlify pour afficher du Markdown dans des expressions JSX : titres, blocs de code et tableaux se compilent normalement." keywords: ["MDX component", "conditional content", "markdown in JSX", "expressions", "ternary"] --- diff --git a/fr/deploy/rollbacks.mdx b/fr/deploy/rollbacks.mdx index 2786a6846d..a35fa2ea77 100644 --- a/fr/deploy/rollbacks.mdx +++ b/fr/deploy/rollbacks.mdx @@ -1,6 +1,6 @@ --- title: "Retours en arrière" -description: "Restaurez votre site Mintlify en production à une compilation réussie précédente depuis votre tableau de bord, sans revenir sur des commits ni attendre une nouvelle compilation." +description: "Restaurez votre site Mintlify en production vers une compilation réussie précédente depuis le tableau de bord, sans revenir sur des commits." keywords: ["instantané", "annuler le déploiement", "restaurer la compilation", "promouvoir la compilation", "déploiement défaillant"] --- diff --git a/fr/editor/agent.mdx b/fr/editor/agent.mdx index 6a501867f1..fbdd6268a5 100644 --- a/fr/editor/agent.mdx +++ b/fr/editor/agent.mdx @@ -1,6 +1,6 @@ --- title: "Interroger l'agent" -description: "Utilisez l'agent d'IA intégré à l'éditeur pour rédiger du contenu, modifier des pages, laisser des commentaires et des suggestions, faire des recherches sur votre site, téléverser des fichiers et configurer des paramètres." +description: "Utilisez l'agent d'IA intégré à l'éditeur Mintlify pour rédiger du contenu, modifier des pages, laisser des commentaires et rechercher sur votre site." keywords: ["editor", "AI", "assistant", "agent", "chat", "comments", "suggestions", "code mode", "file upload"] --- diff --git a/fr/editor/index.mdx b/fr/editor/index.mdx index a5ebd06873..ec6a8ec573 100644 --- a/fr/editor/index.mdx +++ b/fr/editor/index.mdx @@ -1,7 +1,7 @@ --- title: "Présentation de l'éditeur" sidebarTitle: "Présentation" -description: "Créez, modifiez et publiez du contenu dans votre navigateur avec l'éditeur Mintlify. Prend en charge la collaboration en temps réel et la synchronisation continue avec Git." +description: "Créez, modifiez et publiez du contenu dans votre navigateur avec l'éditeur Mintlify, avec collaboration en temps réel et synchronisation Git." keywords: ["web editor", "git", "branches", "commits", "pull requests"] --- diff --git a/fr/editor/pages.mdx b/fr/editor/pages.mdx index 50afe299ea..a4d0651ff6 100644 --- a/fr/editor/pages.mdx +++ b/fr/editor/pages.mdx @@ -1,7 +1,7 @@ --- title: "Créer et modifier des pages" sidebarTitle: "Modifier le contenu" -description: "Créez des pages, modifiez du contenu, ajoutez des médias, organisez votre navigation, restaurez des versions antérieures d'une page et gérez les pages privées dans l'éditeur." +description: "Créez des pages, ajoutez des médias, organisez la navigation, restaurez des versions antérieures et gérez les pages privées dans l'éditeur Mintlify." keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- diff --git a/fr/editor/settings.mdx b/fr/editor/settings.mdx index 7712ae1443..c258edd698 100644 --- a/fr/editor/settings.mdx +++ b/fr/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "Paramètres de l'éditeur pour l'IA et la publication" sidebarTitle: "Paramètres" -description: "Configurez l'apparence de l'éditeur, les instructions d'IA et les valeurs par défaut de publication pour contrôler l'aspect de l'éditeur et la façon dont il commit et fusionne les modifications." +description: "Configurez l'apparence de l'éditeur Mintlify, les instructions d'IA et les valeurs par défaut de publication pour le commit et la fusion des modifications." keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- diff --git a/fr/help-center/configure-oauth-with-auth0.mdx b/fr/help-center/configure-oauth-with-auth0.mdx index 19608754c8..776b78e91f 100644 --- a/fr/help-center/configure-oauth-with-auth0.mdx +++ b/fr/help-center/configure-oauth-with-auth0.mdx @@ -1,6 +1,6 @@ --- title: "Configurer l'authentification OAuth 2.0 avec Auth0" -description: "Configurez Auth0 comme fournisseur d'identité OAuth 2.0 pour un site de documentation Mintlify privé, y compris les URL d'endpoints, l'enregistrement du callback et le contrôle d'accès basé sur les groupes." +description: "Configurez Auth0 comme fournisseur d'identité OAuth 2.0 pour un site de documentation Mintlify privé : URL d'endpoints, callback et accès par groupes." keywords: ["Auth0", "OAuth", "OAuth 2.0", "OIDC", "identity provider", "SSO", "private docs", "authentication"] --- diff --git a/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx b/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx index ab050e3914..ae5bd7fc78 100644 --- a/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx +++ b/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx @@ -1,6 +1,6 @@ --- -title: "Déploiement de prévisualisation non créé pour une branche de fork" -description: "Pourquoi les pull requests de forks et les branches de forks transmises à l'API de prévisualisation ne produisent pas de déploiements de prévisualisation, et comment les mainteneurs peuvent prévisualiser les modifications d'un fork." +title: "Pas de prévisualisation pour une branche de fork" +description: "Pourquoi les pull requests et branches de forks ne produisent pas de déploiements de prévisualisation dans Mintlify, et comment prévisualiser un fork." keywords: ["fork pull request", "no preview link", "preview deployment missing", "fork branch preview", "trigger preview API fork", "external contributor preview"] --- diff --git a/fr/help-center/private-repo-missing-when-creating-second-deployment.mdx b/fr/help-center/private-repo-missing-when-creating-second-deployment.mdx index 69ea414b41..ec8019c71e 100644 --- a/fr/help-center/private-repo-missing-when-creating-second-deployment.mdx +++ b/fr/help-center/private-repo-missing-when-creating-second-deployment.mdx @@ -1,5 +1,5 @@ --- -title: "Dépôt privé absent lors de la création d'un second déploiement" +title: "Dépôt privé absent lors d'un second déploiement" description: "Réautorisez Mintlify avec l'accès aux dépôts privés afin qu'un dépôt GitHub privé existant apparaisse dans le sélecteur de dépôts d'onboarding." keywords: ["second déploiement", "plusieurs déploiements même dépôt", "dépôt privé absent", "sélecteur de dépôts d'onboarding", "autoriser GitHub", "private=true", "réautoriser GitHub"] --- diff --git a/fr/help-center/static-file-not-served.mdx b/fr/help-center/static-file-not-served.mdx index 6207e1773e..0a928d71e2 100644 --- a/fr/help-center/static-file-not-served.mdx +++ b/fr/help-center/static-file-not-served.mdx @@ -1,5 +1,5 @@ --- -title: "Corriger un fichier statique qui renvoie 404 sur votre site de documentation" +title: "Corriger un fichier statique qui renvoie 404" description: "Diagnostiquez pourquoi un fichier ajouté à votre dépôt de documentation (JSON, PDF ou image) ne se charge pas à l'URL attendue sur votre site Mintlify." keywords: ["static file not served", "404 asset", "JSON not found", "mintignore", "static assets", "file serving"] --- diff --git a/fr/migration-services/go-live-checklist.mdx b/fr/migration-services/go-live-checklist.mdx index bfcdb6a46c..b93d342426 100644 --- a/fr/migration-services/go-live-checklist.mdx +++ b/fr/migration-services/go-live-checklist.mdx @@ -1,6 +1,6 @@ --- title: "Liste de contrôle de mise en ligne" -description: "Une liste de contrôle avant lancement pour vérifier les redirections, le domaine personnalisé, l'authentification, les analyses et les paramètres SEO avant la mise en ligne de votre site de documentation Mintlify." +description: "Liste de contrôle avant lancement : vérifiez les redirections, le domaine personnalisé, l'authentification, les analyses et le SEO du site Mintlify." noindex: true --- diff --git a/fr/migration/docusaurus.mdx b/fr/migration/docusaurus.mdx index 1e61938512..7108c4bae6 100644 --- a/fr/migration/docusaurus.mdx +++ b/fr/migration/docusaurus.mdx @@ -1,6 +1,6 @@ --- title: "Migrer depuis Docusaurus" -description: "Migrez une documentation Docusaurus vers Mintlify, y compris les pages MDX, les barres latérales, les versions, le contenu localisé, les ressources et les composants personnalisés." +description: "Migrez une documentation Docusaurus vers Mintlify : pages MDX, barres latérales, versions, contenu localisé, ressources et composants personnalisés." keywords: ["migration Docusaurus", "Docusaurus vers Mintlify", "sidebars.js", "versioned_docs"] --- diff --git a/fr/migration/index.mdx b/fr/migration/index.mdx index 8e153618f7..8c23ba624c 100644 --- a/fr/migration/index.mdx +++ b/fr/migration/index.mdx @@ -1,7 +1,7 @@ --- title: "Vue d'ensemble de la migration" sidebarTitle: "Vue d'ensemble" -description: "Choisissez un parcours de migration pour transférer une documentation existante depuis Docusaurus, ReadMe, GitBook, Fern, Document360 ou une autre plateforme vers Mintlify." +description: "Choisissez un parcours de migration pour transférer votre documentation depuis Docusaurus, ReadMe, GitBook, Fern ou Document360 vers Mintlify." keywords: ["migration", "Docusaurus", "ReadMe", "GitBook", "Fern", "Document360", "import"] --- diff --git a/fr/migration/manual.mdx b/fr/migration/manual.mdx index e940523735..05c72d6e5c 100644 --- a/fr/migration/manual.mdx +++ b/fr/migration/manual.mdx @@ -1,6 +1,6 @@ --- title: "Migrer depuis une autre plateforme" -description: "Convertissez la documentation de toute plateforme vers les pages, la navigation, les composants, les références API, les ressources et les redirections de Mintlify." +description: "Convertissez la documentation de toute plateforme vers les pages, la navigation, les composants, les références API et les redirections Mintlify." keywords: ["migration manuelle de documentation", "migration Markdown", "migration MDX", "docs.json"] --- diff --git a/help-center/branch-missing-from-editor-branch-list.mdx b/help-center/branch-missing-from-editor-branch-list.mdx index 5455c28c2f..073f077e62 100644 --- a/help-center/branch-missing-from-editor-branch-list.mdx +++ b/help-center/branch-missing-from-editor-branch-list.mdx @@ -1,6 +1,6 @@ --- title: "Branch missing from the web editor branch list" -description: "Why a branch that exists in your repository does not appear in the web editor branch dropdown, and how to open it anyway." +description: "Why a branch that exists in your repository does not appear in the Mintlify web editor branch dropdown, and how to open a branch that is not listed." keywords: ["branch disappeared", "branch missing", "branch dropdown incomplete", "editor branch list", "branch deleted", "web editor branches", "switch branches"] --- diff --git a/migration/manual.mdx b/migration/manual.mdx index 72396584b9..29866c6672 100644 --- a/migration/manual.mdx +++ b/migration/manual.mdx @@ -1,6 +1,6 @@ --- title: "Migrate from another platform" -description: "Convert documentation from any source platform to Mintlify pages, navigation, components, API references, assets, and redirects." +description: "Convert documentation from any source platform to Mintlify pages, navigation, components, API references, assets, and redirects with a manual migration." keywords: ["manual documentation migration", "Markdown migration", "MDX migration", "docs.json"] --- diff --git a/zh/advanced-support.mdx b/zh/advanced-support.mdx index a609e44fc4..248215e05f 100644 --- a/zh/advanced-support.mdx +++ b/zh/advanced-support.mdx @@ -1,6 +1,6 @@ --- title: "高级支持" -description: "获取 Mintlify 高级支持服务：按优先级设定的响应时间目标、专属 Slack 频道、专属客户成功经理，以及针对文档站点问题的优先协助与工程升级。" +description: "介绍 Mintlify 高级支持选项：所有 Pro 和 Enterprise 客户均可使用的标准支持、提供专属 Slack 频道和 24 小时响应 SLA 的高级 Slack 支持，以及包含每月沟通、季度业务回顾和优先升级的专属客户成功经理（CSM）附加服务，并解答常见问题。" keywords: ["support", "CSM", "enterprise"] --- diff --git a/zh/agent/customize.mdx b/zh/agent/customize.mdx index 547c52faf5..d3dd57cedb 100644 --- a/zh/agent/customize.mdx +++ b/zh/agent/customize.mdx @@ -1,6 +1,6 @@ --- title: "自定义 Agent 行为" -description: "使用 `AGENTS.md` 配置文件自定义 agent 行为，控制其处理文档任务和遵循约定的方式。" +description: "介绍如何在 .mintlify 目录中创建 AGENTS.md 配置文件来自定义 Mintlify agent 的行为：设置风格偏好、代码规范、内容要求和项目背景等自定义指令，指令会追加到系统提示词并应用于控制台、Slack 和 API 中的所有任务，附完整示例文件。" keywords: ["AGENTS.md", "Agent 配置", "自定义说明", "Agent 自定义"] --- diff --git a/zh/agent/effective-prompts.mdx b/zh/agent/effective-prompts.mdx index d52a905dd5..d53c9d7c80 100644 --- a/zh/agent/effective-prompts.mdx +++ b/zh/agent/effective-prompts.mdx @@ -1,6 +1,6 @@ --- title: "编写高效提示词" -description: "编写清晰、具体的提示词以从 Mintlify agent 获得更好的结果，包含有效指令示例和常见模式的实用技巧。" +description: "讲解如何为 Mintlify agent 编写清晰高效的提示词以获得更好结果：让提示更具体并聚焦于用户要达成的结果、针对修复拼写错误等常规维护任务使用更通用的提示，以及在多站点组织中通过 subdomain 参数指定 agent 应更新的文档站点，并附多个实用示例。" keywords: ["prompts", "agent prompts", "effective prompting", "agent usage"] --- diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index 5b72f4e9ec..91ca16b4d4 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：一款根据提示自动为文档创建拉取请求的 AI 工具，可通过 Slack、控制台或 API 触发，支持调研、规划、撰写和验证内容，并讲解如何连接 GitHub 账户、选择发布方式、将仓库连接为上下文以及与其他 AI 编码工具配合使用。" keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- diff --git a/zh/agent/slack.mdx b/zh/agent/slack.mdx index 0be3317c4f..59200bb8ae 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: "指导如何将 Mintlify agent 安装到 Slack 工作区并与团队协作：连接、断开与重新安装应用，通过私信或在频道中提及来更新文档、就文档提问和管理自动化，使用已连接的第三方集成、文件附件和其他代码仓库作为上下文，实时跟踪任务进度，并了解角色权限与最佳实践。" keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", "知识沉淀"] --- diff --git a/zh/ai-native.mdx b/zh/ai-native.mdx index a868542cce..c37d9eb57b 100644 --- a/zh/ai-native.mdx +++ b/zh/ai-native.mdx @@ -1,7 +1,7 @@ --- title: "AI 原生文档" sidebarTitle: "AI 原生" -description: "了解 AI 原生功能如何通过助手、agent 和 MCP 服务器提升文档的阅读、创作和发现体验。" +description: "了解 Mintlify 的 AI 原生文档功能如何提升阅读、写作与发现体验：内置 AI 助手回答用户问题，agent 与自动化协助撰写和维护内容，llms.txt、skill.md、MCP 服务器和 Markdown 导出让 AI 工具与搜索引擎更容易发现并使用你的文档。" keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"] --- diff --git a/zh/ai/bring-your-own-model.mdx b/zh/ai/bring-your-own-model.mdx index 7664bb0de9..45c1af059d 100644 --- a/zh/ai/bring-your-own-model.mdx +++ b/zh/ai/bring-your-own-model.mdx @@ -1,6 +1,6 @@ --- title: "使用自己的模型" -description: "在 Enterprise 方案中，使用你自己的 LLM 提供商 API 密钥，并选择为 Mintlify assistant、agent 和自动化提供支持的模型。" +description: "介绍 Enterprise 方案的自带模型功能：使用你自己的 OpenRouter、Anthropic 或兼容 OpenAI 提供商的 API 密钥，为 Mintlify assistant、agent 和自动化选择模型，并了解积分半价计费、密钥轮换与删除方式。" keywords: ["BYOK", "密钥", "OpenRouter", "Anthropic", "OpenAI", "LLM", "API 密钥", "积分"] --- diff --git a/zh/ai/contextual-menu.mdx b/zh/ai/contextual-menu.mdx index 1922ddab32..1589ddf858 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: "介绍如何在 docs.json 中启用 Mintlify 上下文菜单，让用户一键复制页面为 Markdown、下载 PDF，或在 ChatGPT、Claude、Perplexity 等 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 846f19b670..da43492d98 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: "介绍 Mintlify 自动生成并托管的 llms.txt 和 llms-full.txt 文件：帮助 ChatGPT、Claude 等 AI 工具和大语言模型索引你的文档，讲解文件结构、HTTP 发现标头、/_llms 拆分索引、身份验证行为，以及如何在项目根目录用自定义文件覆盖自动生成版本。" keywords: ["llms.txt", "LLM 索引编入", "AEO", "GEO", "内容发现"] boost: 3 --- diff --git a/zh/ai/markdown-export.mdx b/zh/ai/markdown-export.mdx index 9a50c793f3..1db28ff93d 100644 --- a/zh/ai/markdown-export.mdx +++ b/zh/ai/markdown-export.mdx @@ -1,6 +1,6 @@ --- title: "Markdown 导出" -description: "将文档页面导出为整洁的 Markdown 格式，用于 AI 工具、LLM 集成和自动化内容处理工作流程。" +description: "介绍 Mintlify 的 Markdown 导出功能：通过 .md URL 后缀或 Accept 标头获取页面的 Markdown 版本，供 AI 工具和 LLM 集成使用，并讲解面向特定受众的内容、自定义代理指令、API 参考页面导出、身份验证规则与复制页面的键盘快捷键。" keywords: ["markdown", "token 效率", "AI 处理"] --- diff --git a/zh/ai/mintlify-mcp.mdx b/zh/ai/mintlify-mcp.mdx index cbc282999a..d5891e92ee 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: "介绍 Mintlify 管理员 MCP 服务器：让 Claude、ChatGPT、Cursor 等 AI 工具获得对文档内容和控制台的写入权限，可编辑页面、调整导航并提交拉取请求，讲解连接方式、会话与 branch 工作流、可用工具、发布设置、示例提示词以及撤销访问的方法。" 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 5788226216..5670be06ff 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: "介绍 Mintlify 为你的文档自动生成并托管的搜索 MCP 服务器：让 Claude、Cursor、ChatGPT 等 AI 工具直接搜索并检索你的文档内容和 API 端点，讲解 MCP 工具与资源、发现端点、认证配置、客户端凭据、速率限制以及帮助用户连接常用工具的方法。" keywords: ["MCP", "AI 工具", "Claude", "Cursor"] --- diff --git a/zh/ai/skillmd.mdx b/zh/ai/skillmd.mdx index 0a5d58591b..8c906070b0 100644 --- a/zh/ai/skillmd.mdx +++ b/zh/ai/skillmd.mdx @@ -1,6 +1,6 @@ --- title: "skill.md" -description: "通过自动生成的 skill.md 能力文件，让你的文档随时可供 AI 智能体使用，并向其描述产品可用的能力。" +description: "介绍 Mintlify 自动生成并托管的 skill.md 能力文件：向 AI 智能体描述你的产品可执行的操作、所需输入和约束条件，讲解文件结构、frontmatter 字段、自定义与多个 skill 文件、按用户组限制技能、skills 发现端点以及 A2A agent 卡片。" keywords: ["AI 智能体", "技能", "智能体技能", "智能体"] boost: 3 --- diff --git a/zh/ai/slack-bot.mdx b/zh/ai/slack-bot.mdx index 55a16528e1..e8542115ee 100644 --- a/zh/ai/slack-bot.mdx +++ b/zh/ai/slack-bot.mdx @@ -1,6 +1,6 @@ --- title: "Slack 机器人" -description: "设置一个 Slack 机器人，以你的文档作为知识库回答团队问题，并提供来源引用和后续跟进。" +description: "介绍已弃用的 Mintlify Slack 机器人：它以你的文档为知识库，通过 AI 助手在 Slack 工作区中回答团队与社区问题并提供带来源引用的回复，讲解其对提及和频道消息的响应机制、消息用量计费方式，以及如何创建 ask-ai 频道让用户快速获得解答。" keywords: ["bot", "workspace", "Q&A", "Slack", "app"] --- diff --git a/zh/analytics/assistant.mdx b/zh/analytics/assistant.mdx index 6d0765b39a..86d6d9f76a 100644 --- a/zh/analytics/assistant.mdx +++ b/zh/analytics/assistant.mdx @@ -1,7 +1,7 @@ --- title: "分析助手对话" sidebarTitle: "助手" -description: "使用助手分析了解对话主题、满意度、使用趋势和文档缺口。" +description: "介绍 Mintlify 分析页面的 Assistant 视图：查看助手对话按类别与主题的分组、满意度指标、使用趋势和完整聊天记录，帮助你监控助手使用情况、识别用户最常询问的常见主题、按负面反馈筛选发现用户困惑之处，并利用高意图的对话数据定位文档缺口以优先更新内容。" keywords: ["analytics", "assistant", "conversations", "topics", "satisfaction", "chat history"] --- diff --git a/zh/analytics/export.mdx b/zh/analytics/export.mdx index e4e6671f14..de543a2e13 100644 --- a/zh/analytics/export.mdx +++ b/zh/analytics/export.mdx @@ -1,7 +1,7 @@ --- title: "将分析导出为 CSV" sidebarTitle: "导出分析" -description: "将分析类别导出为 CSV,并解读流量和助手导出字段。" +description: "讲解如何在 Mintlify 分析页面将流量、引荐、助手对话、搜索或反馈等类别按所选时间范围导出为 CSV 文件，并解读流量导出中按人类、AI agent、搜索爬虫与训练爬虫分类的浏览量字段，以及助手导出中用于发现文档缺口的 resolutionStatus 列。" keywords: ["analytics", "export", "CSV", "traffic export", "assistant export"] --- diff --git a/zh/analytics/index.mdx b/zh/analytics/index.mdx index e3c20e2886..ed4c339145 100644 --- a/zh/analytics/index.mdx +++ b/zh/analytics/index.mdx @@ -1,6 +1,6 @@ --- title: "分析概览" -description: "使用 Mintlify 分析 dashboard 了解文档的流量、助手使用情况、搜索、参与度和反馈。" +description: "Mintlify 分析 dashboard 概览：了解访客如何发现和使用你的文档，识别高价值页面并跟踪随时间的变化，涵盖流量、助手对话、搜索、用户参与和反馈等视图，支持按时间段筛选、导出 CSV 以及将分析事件流式传输到 Amazon S3 进行下游处理，数据通常在交互后几分钟内出现。" keywords: ["analytics", "metrics", "page views", "traffic", "trends", "insights", "impressions", "CTA", "call-to-action"] boost: 3 --- diff --git a/zh/analytics/search.mdx b/zh/analytics/search.mdx index f2c935dd4f..dc16fedf92 100644 --- a/zh/analytics/search.mdx +++ b/zh/analytics/search.mdx @@ -1,7 +1,7 @@ --- title: "分析文档搜索" sidebarTitle: "搜索" -description: "使用搜索分析了解查询趋势、无结果的搜索以及结果点击率。" +description: "介绍 Mintlify 分析页面的 Search 视图：查看文档搜索量、常见查询、无结果的搜索以及结果点击率（CTR），帮助你监控搜索趋势变化、了解用户最关心和覆盖不足的主题并优先更新内容，还可通过添加关键词或更新内容来提升点击率较低的高频搜索词的搜索结果相关性。" keywords: ["analytics", "search", "queries", "no results", "click-through rate", "CTR"] --- diff --git a/zh/analytics/streaming.mdx b/zh/analytics/streaming.mdx index 3a830972b2..be9dcfaf24 100644 --- a/zh/analytics/streaming.mdx +++ b/zh/analytics/streaming.mdx @@ -1,7 +1,7 @@ --- title: "将分析事件流式传输到 Amazon S3" sidebarTitle: "流式传输事件" -description: "配置 Enterprise 分析流式传输,将选定的事件类别和部署发送到 Amazon S3。" +description: "讲解如何配置 Mintlify Enterprise 分析流式传输，将页面浏览、导航、搜索、反馈和 AI 助手等事件类别近实时发送到 Amazon S3：添加目标地址、准备 IAM 凭据、选择要流式传输的类别与部署，并理解以 JSONL 格式写入的事件信封与字段。" keywords: ["analytics", "streaming", "Amazon S3", "data warehouse", "events", "Enterprise"] --- diff --git a/zh/analytics/traffic.mdx b/zh/analytics/traffic.mdx index 49b7178086..05a51f4d75 100644 --- a/zh/analytics/traffic.mdx +++ b/zh/analytics/traffic.mdx @@ -1,7 +1,7 @@ --- title: "分析文档流量" sidebarTitle: "流量" -description: "使用流量分析跟踪访客、页面浏览量、引荐来源,以及来自人类和 AI agent 的流量。" +description: "介绍 Mintlify 分析页面的 Traffic 视图：跟踪文档的总访客数、页面浏览量、助手对话数、引荐来源以及来自人类和 AI agent 的流量，帮助你监控内容更新后的流量趋势、识别热门页面、优化受众定位，并了解 agent 浏览量的识别方式以及度量方式扩展带来的变化。" keywords: ["analytics", "traffic", "page views", "visitors", "referrals", "agent views"] --- diff --git a/zh/analytics/user-engagements.mdx b/zh/analytics/user-engagements.mdx index 52e71b50dc..f2ccf82ca2 100644 --- a/zh/analytics/user-engagements.mdx +++ b/zh/analytics/user-engagements.mdx @@ -1,7 +1,7 @@ --- title: "分析用户参与" sidebarTitle: "用户参与" -description: "使用参与度分析解读内容操作、CTA 表现、用户流,以及搜索和助手漏斗。" +description: "介绍 Mintlify 分析页面的用户参与视图：解读内容操作、CTA 点击率、按页面统计的互动趋势、展示访客浏览路径与流失率的用户流，以及搜索到答案与助手对话两类用户漏斗，帮助你识别高意图页面、发现访客在各个阶段流失的环节，并判断哪些内容最值得保持更新与补充。" keywords: ["analytics", "engagement", "CTA", "user flow", "funnel", "actions"] --- diff --git a/zh/api-playground/adding-sdk-examples.mdx b/zh/api-playground/adding-sdk-examples.mdx index 0033e99365..1e4374a2b5 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: "讲解如何使用 x-codeSamples 扩展在 OpenAPI 文档中为 API 端点添加 SDK 代码示例，说明 lang、label 和 source 属性的模式，并通过多语言示例展示如何在 Mintlify API 参考页面中呈现 CLI 与 SDK 用法。" keywords: ["x-codeSamples", "SDK examples"] --- diff --git a/zh/api-playground/asyncapi-setup.mdx b/zh/api-playground/asyncapi-setup.mdx index 86699889f2..9b8d8ee6dc 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: "讲解如何在 Mintlify 中使用 AsyncAPI 规范文件为 WebSocket API 生成交互式参考文档：添加并验证 AsyncAPI 架构文档、通过导航属性自动生成频道页面、配置选项卡、分组与嵌套分组示例，以及创建单个频道页面和数组与组合模式的渲染方式。" keywords: ["asyncapi", "websocket"] --- diff --git a/zh/api-playground/complex-data-types.mdx b/zh/api-playground/complex-data-types.mdx index 446561260e..01a9a4f736 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: "讲解如何在 OpenAPI 中使用 oneOf、anyOf 和 allOf 关键字为具有灵活 schema 的 API 编写文档：用 allOf 组合与合并模式、用 oneOf 和 anyOf 提供带标签页的选项，并了解 Mintlify 对 any 和 undefined 类型的渲染方式。" 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..5003c9031d 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: "讲解如何在 Mintlify 中从 SDL schema 定义文件为 GraphQL API 生成参考页面：配置 graphql 导航属性、自动生成 query、mutation 和 type 页面并附示例操作、变量与 JSON 响应，以及弃用字段标记的显示和文档的更新方式。" keywords: ["graphql", "schema", "sdl"] --- diff --git a/zh/api-playground/managing-page-visibility.mdx b/zh/api-playground/managing-page-visibility.mdx index 8643e7ca8f..cf952c56f0 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: "讲解如何用 x-hidden 和 x-excluded 扩展控制自动生成的 OpenAPI 页面可见性：将端点从导航中隐藏但保留直接 URL 访问，或将内部与已弃用端点从 Mintlify 文档中彻底排除，涵盖常见用例并附端点和 webhook 路径的实现示例。" keywords: ["x-hidden", "x-excluded", "隐藏端点", "页面可见性", "内部端点"] --- diff --git a/zh/api-playground/mdx-setup.mdx b/zh/api-playground/mdx-setup.mdx index 7a64886776..4fca494568 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: "了解如何在 Mintlify 中使用 MDX 文件手动创建 API 参考文档页面：在 docs.json 中配置基础 URL 与认证方式，通过 frontmatter 的 api 字段定义端点、路径参数与请求方法，适用于小型 API、原型开发或需要完全控制布局的自定义文档场景。" keywords: ["API 文档", "端点文档"] --- diff --git a/zh/api-playground/multiple-responses.mdx b/zh/api-playground/multiple-responses.mdx index f5bc1125fa..01a4735256 100644 --- a/zh/api-playground/multiple-responses.mdx +++ b/zh/api-playground/multiple-responses.mdx @@ -1,6 +1,6 @@ --- title: "多种响应" -description: "为 API 端点记录多种响应变体，包括成功和错误情况，并附带状态码和示例 payload。" +description: "介绍如何使用 OpenAPI 的 examples 属性为同一 API 端点记录多种响应示例，涵盖不同状态码、成功与错误场景以及按地区变化的返回值，并说明 Mintlify 操作台如何以音频播放器等形式展示非 JSON 响应内容，帮助读者理解接口在不同请求条件下的实际行为。" keywords: ["response examples", "conditional responses", "response variations", "examples property"] --- diff --git a/zh/api-playground/overview.mdx b/zh/api-playground/overview.mdx index e1c4e95511..4000df70b9 100644 --- a/zh/api-playground/overview.mdx +++ b/zh/api-playground/overview.mdx @@ -1,6 +1,6 @@ --- title: "操作台" -description: "让开发者在文档中直接测试 API 端点，交互式演练场可发送真实请求并显示响应结果。" +description: "Mintlify API 操作台概览：一个交互式环境，基于 OpenAPI 规范或 AsyncAPI 模式自动为端点生成测试页面，开发者无需离开文档即可构造 API 请求、发送真实调用并查看响应结果。本文介绍入门配置步骤、规范文件验证方法与自动生成端点页面的导航设置。" keywords: ["交互式", "API", "端点测试", "实时 API 请求", "请求构造器"] boost: 3 --- diff --git a/zh/api-playground/troubleshooting.mdx b/zh/api-playground/troubleshooting.mdx index a043c20736..bb0b7dc8d1 100644 --- a/zh/api-playground/troubleshooting.mdx +++ b/zh/api-playground/troubleshooting.mdx @@ -1,6 +1,6 @@ --- title: "故障排查" -description: "排查 API 演练场配置中的常见问题，包括 OpenAPI 验证错误、缺失的端点和身份验证问题。" +description: "API 操作台常见问题的故障排查指南：逐一解决 OpenAPI 页面全部空白、规范校验失败、openapi 字段拼写错误、端点页面缺失与身份验证异常等配置问题，并提供使用 Swagger 校验器验证文档、运行 mint dev 在本地调试定位错误的实用排查方法。" keywords: ["API 故障排查", "OpenAPI 无效", "配置问题"] boost: 3 --- diff --git a/zh/api-playground/websocket-playground.mdx b/zh/api-playground/websocket-playground.mdx index df810ac52c..e84a10c5f3 100644 --- a/zh/api-playground/websocket-playground.mdx +++ b/zh/api-playground/websocket-playground.mdx @@ -1,5 +1,5 @@ --- title: "演练场" -description: "在文档中添加交互式 WebSocket 演练场，让用户可以测试实时连接、发送消息并查看事件流。" +description: "介绍如何基于 AsyncAPI 模式在 Mintlify 文档中添加交互式 WebSocket 演练场，让用户直接在文档页面上测试实时连接、发送消息并查看事件流，无需切换到外部工具即可探索和调试你的实时 API 通道，帮助开发者快速理解 WebSocket 接口的消息格式与行为。" 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..c840904488 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 分析 API 的按页面获取反馈端点：导出按文档页面路径汇总的用户反馈数据，每条记录包含赞、踩、代码片段复制次数与反馈总数的类型细分，支持按日期范围、来源类型和处理状态筛选结果，并说明组织内所有分析端点共享的每小时 100 次请求速率限制。" 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..4b4852ecfa 100644 --- a/zh/api/analytics/searches.mdx +++ b/zh/api/analytics/searches.mdx @@ -1,6 +1,6 @@ --- title: "获取搜索查询" -description: "导出 Mintlify 文档的搜索查询记录，包含每个搜索词的命中数、点击率以及最近一次被搜索的时间，便于分析用户搜索行为。" +description: "介绍 Mintlify 分析 API 的获取搜索查询端点：导出文档的搜索查询记录，包含每个搜索词的命中数、点击率和最近一次被搜索的时间，结果按命中次数从高到低排序，支持通过 nextCursor 游标分页和按日期范围筛选，并说明每小时 100 次请求的共享速率限制。" 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..bc8c42ea96 100644 --- a/zh/api/analytics/views.mdx +++ b/zh/api/analytics/views.mdx @@ -1,6 +1,6 @@ --- title: "获取页面浏览量" -description: "获取 Mintlify 文档的页面浏览量统计，按路径细分，并区分来自真实用户与 AI 爬虫或代理的流量来源。" +description: "介绍 Mintlify 分析 API 的获取页面浏览量端点：导出全站总量与各页面明细的浏览量统计数据，区分来自真实用户的人工流量与 AI 爬虫或代理产生的流量，支持基于偏移量的分页和按日期范围筛选，并说明组织内所有分析端点共享的每小时 100 次请求速率限制。" 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..b09725097f 100644 --- a/zh/api/analytics/visitors.mdx +++ b/zh/api/analytics/visitors.mdx @@ -1,6 +1,6 @@ --- title: "获取唯一访客" -description: "获取 Mintlify 文档的唯一访客数量，按路径与站点整体统计，并区分真实用户流量与 AI 爬虫或代理产生的访问。" +description: "介绍 Mintlify 分析 API 的获取唯一访客端点：按路径与站点整体导出经过去重处理的唯一访客数据，区分真实用户流量与 AI 爬虫或代理产生的访问量，支持基于偏移量的分页和按日期范围筛选结果，并说明组织内所有分析端点共享的每小时 100 次请求速率限制。" 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 93a0fa01f6..142faf9f51 100644 --- a/zh/api/introduction.mdx +++ b/zh/api/introduction.mdx @@ -1,6 +1,6 @@ --- title: "简介" -description: "使用 Mintlify REST API 触发部署、嵌入 AI 助手、导出 Analytics 数据，并以编程方式管理文档。" +description: "Mintlify REST API 简介：以编程方式触发部署与预览、运行自动化、创建 agent 任务、嵌入 AI 助手并导出分析数据，涵盖端点列表、常见用例、基础 URL，以及管理员、Assistant 和 Index 三种 API key 的认证、scope 与过期设置。" keywords: ["REST API", "endpoints", "API keys"] boost: 3 --- diff --git a/zh/api/search-index/introduction.mdx b/zh/api/search-index/introduction.mdx index 2c4852da62..9a042d5b0f 100644 --- a/zh/api/search-index/introduction.mdx +++ b/zh/api/search-index/introduction.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify Index REST API" sidebarTitle: "概览" -description: "使用 Mintlify Index REST API 搜索文档和 Web，组装带有来源引用的上下文，并为应用和代理获取页面内容。" +description: "Mintlify Index REST API 概览：通过 context、search 和 contents 三种检索模式搜索文档与 Web、组装带来源引用的上下文并获取页面内容，涵盖基础 URL、Index API key 认证步骤、速率限制和错误代码说明。" keywords: ["Mintlify Index API", "REST API", "认证", "API key"] --- diff --git a/zh/api/static-export/overview.mdx b/zh/api/static-export/overview.mdx index d0be46ff88..2e4de61539 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 静态导出 API：以异步作业方式将文档站点预渲染为自包含的 HTML、CSS 和 JavaScript 静态文件包并下载用于自托管，涵盖作业启动与轮询、按部署方式的功能支持、Helm chart 部署和 GitHub Actions 自动化。" keywords: ["static export", "static site", "bundle", "self-host", "enterprise"] --- diff --git a/zh/assistant/configure.mdx b/zh/assistant/configure.mdx index 854402a434..da707d5510 100644 --- a/zh/assistant/configure.mdx +++ b/zh/assistant/configure.mdx @@ -1,6 +1,6 @@ --- title: "配置 AI 助手" -description: "在 Mintlify 仪表盘中配置 AI 助手：启用或停用助手、自定义响应内容、添加起始问题、设置机器人防护、管理速率限制以及查看助手用量与计费。" +description: "在 Mintlify 仪表盘中配置 AI 助手的完整指南：介绍如何启用或禁用助手、设置支持与销售转接邮箱和联系表单、添加起始问题建议、开启机器人防护、管理请求速率限制，并在用量页面查看助手的积分消耗与计费详情，帮助你全面控制文档站点智能问答功能的响应行为与使用成本。" keywords: ["assistant", "设置", "转接", "机器人防护", "计费"] --- diff --git a/zh/assistant/customize.mdx b/zh/assistant/customize.mdx index 47cd005eb8..aca9c0edf1 100644 --- a/zh/assistant/customize.mdx +++ b/zh/assistant/customize.mdx @@ -1,6 +1,6 @@ --- title: "自定义 AI 助手行为" -description: "通过在文档中添加包含系统指令的 Assistant.md 文件来自定义 AI 助手，塑造其语气、角色定位、关注领域、回答格式与整体响应行为。" +description: "介绍如何通过在 .mintlify 目录添加 Assistant.md 文件来自定义 Mintlify AI 助手的系统指令：调整助手的语气与角色定位、提供产品特定上下文、定义支持升级路径、指定术语偏好并限定关注领域，附完整的示例文件、存放位置注意事项与编写最佳实践。" keywords: ["assistant", "自定义指令", "Assistant.md", "系统提示", "角色"] --- diff --git a/zh/assistant/index.mdx b/zh/assistant/index.mdx index 6e8717a9f7..e12644e9ad 100644 --- a/zh/assistant/index.mdx +++ b/zh/assistant/index.mdx @@ -1,6 +1,6 @@ --- title: "AI 助手" -description: "为你的文档站点添加由 AI 驱动的聊天助手，实时回答用户问题、引用文档来源、按需生成代码示例，并支持自定义指令与多模态输入。" +description: "Mintlify AI 助手概览：为文档站点添加智能聊天功能，通过自然语言回答用户问题、搜索并引用文档来源、返回 OpenAPI 规范中的 API 详细信息、生成可复制的代码示例，并支持文本与图片等多模态输入。本文还介绍索引工作原理、隐藏页面处理方式与方案积分要求。" keywords: ["聊天", "用户支持", "多模态"] boost: 3 --- diff --git a/zh/assistant/skills.mdx b/zh/assistant/skills.mdx index ac56fbfbd4..4d8098f1ea 100644 --- a/zh/assistant/skills.mdx +++ b/zh/assistant/skills.mdx @@ -1,6 +1,6 @@ --- title: "添加 assistant skills" -description: "编写专家级 Markdown 指南（skills），AI 助手在需要时按需加载，使用你的团队手写、有明确观点的内容来回答用户问题并遵循内部规范。" +description: "介绍如何为 Mintlify AI 助手添加 skills：在 .mintlify/assistant/skills 目录编写专家级 Markdown 指南，助手仅在用户问题明显匹配时才按需加载完整内容，适用于迁移指南、内部操作手册、故障排查流程等需要具体而精准答案的主题，附文件结构与示例。" keywords: ["assistant", "skills", "loadSkill", "指南", "系统提示"] --- diff --git a/zh/assistant/use.mdx b/zh/assistant/use.mdx index 4821c3394d..ada7771cfd 100644 --- a/zh/assistant/use.mdx +++ b/zh/assistant/use.mdx @@ -1,6 +1,6 @@ --- title: "使用 AI 助手" -description: "通过键盘快捷键、选中文本、代码块、文件附件或 URL 参数打开并调用 AI 助手，在本地预览环境中测试助手响应、指令与自定义配置的行为。" +description: "介绍使用 Mintlify AI 助手的各种方式：通过搜索栏按钮、页面底部横栏、键盘快捷键、选中文本、代码块、文件附件或 URL 查询参数打开聊天面板提问，并说明如何在登录 CLI 后于 mint dev 本地预览中测试助手的响应行为、Assistant.md 自定义指令与配置效果。" keywords: ["assistant", "键盘快捷键", "文件附件", "本地预览", "URL 参数"] --- diff --git a/zh/assistant/widget-preview.mdx b/zh/assistant/widget-preview.mdx index a4f8a2de12..305d1705a3 100644 --- a/zh/assistant/widget-preview.mdx +++ b/zh/assistant/widget-preview.mdx @@ -1,6 +1,6 @@ --- title: "Widget preview" -description: "Host page for the live preview in the assistant widget playground." +description: "AI 助手小组件演练场的实时预览宿主页面：该页面使用自定义模式加载预览组件，用于在 Mintlify 文档中即时渲染小组件的外观与交互效果，方便你在小组件演练场中调整安装代码、展示方式与视觉配置选项时同步查看实际嵌入效果，仅作为内部实时预览用途，不参与搜索索引。" keywords: ["assistant", "widget", "preview"] mode: "custom" noindex: true diff --git a/zh/assistant/widget.mdx b/zh/assistant/widget.mdx index cd2af0a744..35d53bc95d 100644 --- a/zh/assistant/widget.mdx +++ b/zh/assistant/widget.mdx @@ -1,7 +1,7 @@ --- title: "嵌入 AI 助手小组件" sidebarTitle: "小组件" -description: "安装并配置 Mintlify 小组件,在任意网站或 Web 应用中嵌入基于你的内容训练的 AI 助手。" +description: "介绍如何安装并配置 Mintlify AI 助手小组件：通过一段托管脚本将基于你文档内容训练的 AI 聊天嵌入任意网站、Web 应用、仪表盘或支持门户，涵盖启用小组件、设置允许来源、复制小组件 ID、使用交互式面板生成安装代码以及配置起始问题与支持邮箱的完整步骤。" keywords: ["assistant", "chat", "embed"] tag: "New" --- diff --git a/zh/automations/create.mdx b/zh/automations/create.mdx index 24e268e528..14b785612d 100644 --- a/zh/automations/create.mdx +++ b/zh/automations/create.mdx @@ -1,6 +1,6 @@ --- title: "创建自定义自动化" -description: "创建 Mintlify 自动化，按计划、仓库推送或集成事件运行。添加上下文仓库和自定义 agent 提示词。" +description: "介绍如何创建自定义 Mintlify 自动化：编写 agent 提示词并设置按计划、仓库推送或已连接集成事件触发的运行条件，添加上下文仓库与集成，配置更新模式，并提供撰写有效指令的实用技巧，适用于预定义自动化无法覆盖、需要组合自有提示词与特定仓库的文档维护场景。" keywords: ["automation", "automate", "cron", "agent", "custom automation"] --- diff --git a/zh/automations/index.mdx b/zh/automations/index.mdx index c3c635d515..955854acfa 100644 --- a/zh/automations/index.mdx +++ b/zh/automations/index.mdx @@ -1,7 +1,7 @@ --- title: "自动化概览" sidebarTitle: "概览" -description: "使用 Mintlify 自动化，自动维护内容：按计划、在仓库推送时或在已连接集成的事件上运行 agent。" +description: "Mintlify 自动化概览：按计划、仓库推送或已连接集成的事件自动运行 agent 来维护文档内容，同时支持 GitHub 与 GitLab 仓库。本文介绍内容更新、代码变更、自定义计划与集成四种触发器类型，以及 pull request 分组、更新模式等所有自动化共享的核心概念。" keywords: ["automation", "automate", "cron", "agent", "automations"] boost: 5 --- diff --git a/zh/automations/manage.mdx b/zh/automations/manage.mdx index 140d276f92..dbcc6ba680 100644 --- a/zh/automations/manage.mdx +++ b/zh/automations/manage.mdx @@ -1,6 +1,6 @@ --- title: "管理自动化" -description: "从控制台启用、禁用、触发和删除自动化。配置仓库、计划和集成触发器、上下文仓库及 automerge。" +description: "介绍如何在 Mintlify 控制台管理自动化：启用、禁用、手动触发和删除自动化，配置仓库、计划与集成触发器、上下文仓库、更新模式和 automerge 选项，涵盖 GitHub 与 GitLab 的前置条件设置，也可通过 mint automations 命令在终端中创建、列出和删除自动化。" 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 3f1f0ec885..b86cd30113 100644 --- a/zh/automations/reference.mdx +++ b/zh/automations/reference.mdx @@ -1,6 +1,6 @@ --- title: "预定义自动化" -description: "所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。" +description: "Mintlify 预定义自动化的完整参考：汇总从代码变更更新文档、起草更新日志、翻译内容、修复失效链接、修正 SEO 问题、修复语法拼写与执行风格指南等自动化的默认触发器、更新模式、上下文仓库支持和必需配置，并提供一览表帮助你快速选择和自定义合适的文档维护自动化。" keywords: ["predefined", "automation", "default"] --- diff --git a/zh/changelog.mdx b/zh/changelog.mdx index 7a8965aac0..bb8459f76d 100644 --- a/zh/changelog.mdx +++ b/zh/changelog.mdx @@ -1,6 +1,6 @@ --- title: "产品更新" -description: "及时了解最新的 Mintlify 产品更新、新功能、平台改进、错误修复和文档工具变更。" +description: "Mintlify 产品更新日志：按时间线记录最新的新功能、平台改进、错误修复与文档工具变更，涵盖编辑器与协作、automations 与集成、AI 助手、API playground 等各方面的发布内容，并支持 RSS 订阅，帮助你及时了解 Mintlify 平台的最新产品动态。" rss: true noindex: true --- diff --git a/zh/cli/mdx-extension.mdx b/zh/cli/mdx-extension.mdx index ec14a21f82..46e0d39bc1 100644 --- a/zh/cli/mdx-extension.mdx +++ b/zh/cli/mdx-extension.mdx @@ -1,6 +1,6 @@ --- title: "Mintlify MDX 扩展" -description: "安装 Mintlify MDX 扩展，在本地编写 MDX 时获得自动补全、内联诊断、悬停文档和编辑器内预览。" +description: "介绍如何安装和使用 Mintlify MDX 扩展：为 VS Code、Cursor、Devin Desktop 等编辑器提供组件自动补全、内联诊断、悬停文档与编辑器内实时预览，自动检测未知组件、无效属性、缺失必需属性和未闭合标签，让你在本地编写 MDX 文档时更高效、更少出错。" keywords: ["Cursor", "MDX", "自动补全", "诊断", "IntelliSense", "预览", "编辑器"] --- diff --git a/zh/cli/preview.mdx b/zh/cli/preview.mdx index bd671033ab..d3f3a384f9 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 文档站点预览：更改会实时重载显示，支持自定义端口与 --no-open 选项，并可通过 mint login 登录以启用全文搜索和 AI 助手功能，让你在提交前于 localhost 检查每处更改的实际渲染效果与站点行为。" keywords: ["mint dev", "本地预览", "localhost", "mint login", "搜索", "助手"] --- diff --git a/zh/components/accordions.mdx b/zh/components/accordions.mdx index 8256a79455..378b87d7a6 100644 --- a/zh/components/accordions.mdx +++ b/zh/components/accordions.mdx @@ -1,6 +1,6 @@ --- title: "折叠面板" -description: "使用折叠面板组件在文档中显示和隐藏内容区块、组织相关信息，并实现渐进式信息披露。" +description: "介绍 Mintlify 折叠面板组件的用法：让用户展开和收起内容区块，实现渐进式信息披露并帮助组织相关内容，支持通过 AccordionGroup 将多个面板分组、添加图标与描述，打开面板时 URL 哈希会更新以便分享指向特定区域的直接链接，附完整属性参考与示例代码。" keywords: ["accordions", "collapsible content", "expandable sections", "progressive disclosure"] boost: 3 --- diff --git a/zh/components/badge.mdx b/zh/components/badge.mdx index 957d28ce4f..5aaca34d19 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..c3ed7427c7 100644 --- a/zh/components/banner.mdx +++ b/zh/components/banner.mdx @@ -1,6 +1,6 @@ --- title: "横幅" -description: "在文档站点顶部添加可关闭的横幅，用于显示重要公告、发行说明或通知。" +description: "介绍如何在 docs.json 中使用 banner 属性为 Mintlify 文档站点每个页面顶部添加横幅：展示重要公告、维护通知或发行说明，支持 Markdown 格式、warning 与 critical 外观类型、自定义浅色与深色背景颜色以及可关闭设置，附产品公告等多种配置示例。" keywords: ["banner", "announcements", "site-wide"] boost: 3 --- diff --git a/zh/components/callouts.mdx b/zh/components/callouts.mdx index a7c9b49cfb..83ce5f30be 100644 --- a/zh/components/callouts.mdx +++ b/zh/components/callouts.mdx @@ -1,6 +1,6 @@ --- title: "标注框" -description: "添加 info、note、tip、check、warning、danger 和自定义标注框组件，在文档中突出显示重要信息。" +description: "介绍 Mintlify 标注框组件的用法：使用 Note、Warning、Info、Tip、Check、Danger 等预设类型在文档中突出显示说明、警告与关键信息，还可通过通用 Callout 组件自定义图标与颜色来创建专属提示样式，附每种标注框的示例代码与完整属性说明。" 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..3337d7a8be 100644 --- a/zh/components/cards.mdx +++ b/zh/components/cards.mdx @@ -1,6 +1,6 @@ --- title: "卡片" -description: "使用卡片组件以可视化容器的形式展示链接、图标、图片和分组内容，从而组织导航。" +description: "介绍 Mintlify 卡片组件的用法：以可视化容器形式展示链接、图标、图片与分组内容，支持水平布局、图片卡片等多种样式变体，可设置跳转链接并常与 Columns 组件搭配构建导航网格，帮助你组织文档首页与引导页面的导航入口，附各种布局变体的示例代码与完整属性参考。" keywords: ["卡片", "可视化容器"] boost: 3 --- diff --git a/zh/components/code-groups.mdx b/zh/components/code-groups.mdx index 3952c31502..e0a20a4f22 100644 --- a/zh/components/code-groups.mdx +++ b/zh/components/code-groups.mdx @@ -1,6 +1,6 @@ --- title: "代码分组" -description: "使用 CodeGroup 组件在标签页界面中展示多个代码示例，让读者可以比较不同编程语言的实现方式。" +description: "介绍 Mintlify 代码分组组件 CodeGroup 的用法：在带标签页的界面中展示多个代码块，方便读者比较不同编程语言的实现或查看完成同一任务的替代方案，相同标签的代码分组与 Tabs 组件会自动同步选中语言，并继承全局代码块样式配置，附创建步骤与多语言完整示例。" keywords: ["code groups", "tabbed code", "multi-language examples", "CodeGroup"] --- diff --git a/zh/components/color.mdx b/zh/components/color.mdx index bb8f137f72..0303384f42 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..867c63e2bf 100644 --- a/zh/components/columns.mdx +++ b/zh/components/columns.mdx @@ -1,6 +1,6 @@ --- title: "列" -description: "使用 columns 组件将卡片和其他组件排列在响应式多列网格布局中，支持自定义列数。" +description: "介绍 Mintlify 列组件 Columns 的用法：将卡片和其他组件排列在响应式多列网格布局中，支持通过 cols 属性自定义列数，并可使用 Column 子组件并排展示任意文本或代码内容，布局会在小屏幕上自动调整以保持可读性，附网格与子组件的示例代码和属性说明。" keywords: ['卡片分组', '网格布局', '多列布局'] boost: 3 --- diff --git a/zh/components/examples.mdx b/zh/components/examples.mdx index 8077e160b3..3762aeb6d1 100644 --- a/zh/components/examples.mdx +++ b/zh/components/examples.mdx @@ -1,6 +1,6 @@ --- title: "示例" -description: "在桌面设备右侧边栏面板中展示代码示例，与 API 文档并排显示请求和响应样本。" +description: "介绍 Mintlify 的 RequestExample 与 ResponseExample 组件：在桌面端右侧边栏面板中固定展示请求和响应代码示例，形成双栏布局，让用户滚动阅读 API 文档时始终可以看到示例，并说明移动端降级为常规代码块的展示方式、常见用例与固定宽度的注意事项。" keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"] boost: 3 --- diff --git a/zh/components/expandables.mdx b/zh/components/expandables.mdx index 920d06b471..06c39194b9 100644 --- a/zh/components/expandables.mdx +++ b/zh/components/expandables.mdx @@ -1,6 +1,6 @@ --- title: "可展开项" -description: "使用可展开组件在 API 文档中切换嵌套对象属性的显示，展示请求和响应对象的子字段。" +description: "介绍 Mintlify 可展开组件 Expandable 的用法：在 API 文档中切换嵌套对象属性的显示与隐藏，配合 ResponseField 展示请求和响应对象的子字段，尤其适合记录复杂对象结构，支持 defaultOpen 属性控制页面加载时的默认展开状态，附示例代码与完整属性说明。" keywords: ["expandables", "nested properties", "expandable fields", "toggle content"] boost: 3 --- diff --git a/zh/components/fields.mdx b/zh/components/fields.mdx index 0a5540ef4b..07f6007916 100644 --- a/zh/components/fields.mdx +++ b/zh/components/fields.mdx @@ -1,6 +1,6 @@ --- title: "字段" -description: "使用 ParamField 和 ResponseField 组件，通过类型、默认值和验证规则为 API 请求和响应参数编写文档。" +description: "介绍 Mintlify 字段组件的用法：使用 ParamField 为 API 或 SDK 的 query、path、body 与 header 参数编写文档，使用 ResponseField 描述响应字段，支持类型、必填、默认值与废弃标记等属性，添加后可自动生成 API 操作台，附完整示例与属性参考。" keywords: ["ParamField", "ResponseField", "request parameters", "response documentation"] boost: 3 --- diff --git a/zh/components/frames.mdx b/zh/components/frames.mdx index 21ab0ab10a..7d51d272ce 100644 --- a/zh/components/frames.mdx +++ b/zh/components/frames.mdx @@ -1,6 +1,6 @@ --- title: "Frames" -description: "使用 frame 组件为图片、视频和其他内容添加样式化边框、说明文字和视觉强调效果。" +description: "介绍 Mintlify 的 Frame 组件：为图片、视频和其他视觉内容添加样式化边框、居中布局与视觉强调效果，通过 caption 属性添加支持链接与粗体等 Markdown 格式的说明文字，使图像与周围文本形成清晰的视觉分隔，附图注用法在内的多个使用示例与属性说明。" keywords: ["image frames", "visual emphasis", "captions", "border"] boost: 3 --- diff --git a/zh/components/github.mdx b/zh/components/github.mdx index 9f43368642..59648b3769 100644 --- a/zh/components/github.mdx +++ b/zh/components/github.mdx @@ -1,6 +1,6 @@ --- title: "GitHub" -description: "使用 GitHub 组件在文档中嵌入仓库卡片，实时显示仓库的描述、star 数量和 fork 数量。" +description: "介绍 Mintlify 的 GitHub 组件：使用 GitHub.Repo 在文档中嵌入公开仓库卡片，页面加载时通过 GitHub 公共 API 实时显示仓库描述、star 数与 fork 数，支持 inset 和 flat 两种布局变体，附示例代码与属性参考。" keywords: ["github", "repo", "仓库", "star", "fork"] boost: 3 tag: "New" diff --git a/zh/components/icons.mdx b/zh/components/icons.mdx index b36f3482fa..670208c10a 100644 --- a/zh/components/icons.mdx +++ b/zh/components/icons.mdx @@ -1,6 +1,6 @@ --- title: "图标" -description: "使用图标组件将 Font Awesome、Lucide、Tabler 或自定义来源的图标添加到文档页面，支持尺寸和颜色选项。" +description: "介绍 Mintlify 图标组件的用法：在文档页面中使用来自 Font Awesome、Lucide、Tabler 的图标，或通过 src 属性加载 SVG 与外部 URL 自定义图像，支持尺寸、颜色设置和行内显示，帮助你丰富文档的视觉表达，附示例与属性参考。" keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"] boost: 3 --- diff --git a/zh/components/index.mdx b/zh/components/index.mdx index 26ae2df174..73862a7e36 100644 --- a/zh/components/index.mdx +++ b/zh/components/index.mdx @@ -1,6 +1,6 @@ --- title: "概览" -description: "浏览 Mintlify 完整组件库，包含适用于 MDX 页面的布局、强调、API 文档和导航元素组件。" +description: "浏览 Mintlify 内置 MDX 组件库的完整概览，按结构化内容、吸引注意力、展示 AI 提示、显示与隐藏内容、API 文档编写和导航等类别分组，涵盖选项卡、步骤、标注、折叠面板、工具提示、响应字段等组件，帮助你组织文档内容、突出重要信息并引导读者高效导航。" keywords: ["MDX 组件", "文档组件", "UI 组件", "组件"] boost: 3 diff --git a/zh/components/mdx.mdx b/zh/components/mdx.mdx index 317a3baea5..e57e3f30bd 100644 --- a/zh/components/mdx.mdx +++ b/zh/components/mdx.mdx @@ -1,6 +1,6 @@ --- title: "MDX" -description: "使用 MDX 组件在 JSX 表达式和条件语句中渲染 Markdown，让标题、代码块和表格像页面其余部分一样正常编译，实现条件化内容展示。" +description: "详细介绍 Mintlify 的 MDX 组件用法：在 JSX 表达式和条件语句中渲染 Markdown，使标题、代码块和表格像页面其余部分一样正常编译，实现按平台或变量条件显示内容。页面涵盖条件渲染示例、块级用法、目录合并行为，以及嵌套层数和片段展开数量的构建限制。" keywords: ["MDX component", "conditional content", "markdown in JSX", "expressions", "ternary"] --- diff --git a/zh/components/mermaid-diagrams.mdx b/zh/components/mermaid-diagrams.mdx index db9d6145b1..07e4ce5683 100644 --- a/zh/components/mermaid-diagrams.mdx +++ b/zh/components/mermaid-diagrams.mdx @@ -1,6 +1,6 @@ --- title: "Mermaid" -description: "使用 Mermaid 语法在文档中创建流程图、序列图和其他可视化图表，并自动渲染。" +description: "了解如何在 Mintlify 文档中使用 Mermaid 语法创建流程图、时序图和甘特图等各类可视化图表并自动渲染。页面介绍 ELK 布局引擎优化大型复杂图表的排布，以及缩放、平移和重置视图等交互式控件，并列出 actions 与 placement 等可配置属性。" keywords: ["Mermaid", "flowcharts", "diagrams"] boost: 3 --- diff --git a/zh/components/panel.mdx b/zh/components/panel.mdx index d134aa363c..98febd5f1a 100644 --- a/zh/components/panel.mdx +++ b/zh/components/panel.mdx @@ -1,6 +1,6 @@ --- title: "Panel" -description: "自定义文档页面右侧面板的内容，用于显示补充信息、示例或导航元素。" +description: "介绍 Mintlify 的 Panel 组件：在文档页面右侧面板中放置任意组件以展示补充信息、示例或导航元素。页面说明 Panel 会替换页面目录、RequestExample 和 ResponseExample 必须置于其中，以及 wide 等页面模式对面板的隐藏行为。" keywords: ["sidebar"] boost: 3 --- diff --git a/zh/components/prompt.mdx b/zh/components/prompt.mdx index a612352108..8c8495d1fe 100644 --- a/zh/components/prompt.mdx +++ b/zh/components/prompt.mdx @@ -1,6 +1,6 @@ --- title: "提示" -description: "展示预置的 AI 提示，提供一键复制和 Cursor 集成按钮，方便用户在 AI 工具中快速使用。" +description: "使用 Mintlify 的 Prompt 组件展示预构建的 AI 提示卡片，支持一键复制到剪贴板或直接在 Cursor 中打开。页面提供基础和多属性示例，并详细说明 description、actions、icon 等属性配置，方便用户在 AI 工具中快速复用提示内容。" keywords: ["提示", "AI", "cursor", "复制", "提示卡片"] boost: 3 --- diff --git a/zh/components/responses.mdx b/zh/components/responses.mdx index 63e29ba1bf..3ad1055fa7 100644 --- a/zh/components/responses.mdx +++ b/zh/components/responses.mdx @@ -1,6 +1,6 @@ --- title: "响应字段" -description: "使用 ResponseField 组件通过类型注解、描述和必填或可选标记编写 API 响应字段文档。" +description: "介绍 Mintlify 的 ResponseField 组件，用于编写 API 响应字段和返回值文档，支持类型注解、默认值、必填与已废弃标记。页面列出 name、type、required、deprecated、pre 和 post 等全部属性，并提供可直接复用的 MDX 示例代码。" keywords: ["API 输出", "返回值", "响应结构"] --- diff --git a/zh/components/steps.mdx b/zh/components/steps.mdx index fc37cc5979..9c13e2b6b4 100644 --- a/zh/components/steps.mdx +++ b/zh/components/steps.mdx @@ -1,6 +1,6 @@ --- title: "步骤" -description: "使用 steps 组件创建带编号的分步流程，引导用户完成顺序任务、教程和设置工作流。" +description: "使用 Mintlify 的 Steps 组件创建带编号的分步操作流程，引导用户完成教程、安装配置和顺序任务。页面提供步骤组件的完整示例，并说明 title、titleSize、icon、stepNumber、id 和 noAnchor 等属性，帮助你自定义步骤标题与锚点链接。" keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"] boost: 3 --- diff --git a/zh/components/tabs.mdx b/zh/components/tabs.mdx index 728d9d4160..f108fd7906 100644 --- a/zh/components/tabs.mdx +++ b/zh/components/tabs.mdx @@ -1,6 +1,6 @@ --- title: "选项卡" -description: "使用 tab 组件将内容组织成可切换的面板，用于展示不同选项、平台版本或语言示例。" +description: "了解如何使用 Mintlify 的选项卡组件将内容组织成可切换的面板，展示不同平台、编程语言或框架的示例内容。页面演示在标签页中嵌入代码块、图标等任意组件，说明具有相同标题的标签页会在整个页面上同步选择并与代码组保持联动，以及如何通过 sync 属性禁用同步行为。" keywords: ["标签式内容", "内容面板", "可切换内容"] boost: 3 --- diff --git a/zh/components/tiles.mdx b/zh/components/tiles.mdx index e73faaa214..e479d00d9f 100644 --- a/zh/components/tiles.mdx +++ b/zh/components/tiles.mdx @@ -1,6 +1,6 @@ --- title: "磁贴" -description: "使用 tiles 组件在响应式网格布局中展示带有图片缩略图、标题和描述的视觉预览。" +description: "使用 Mintlify 的磁贴组件在响应式网格布局中创建带图片预览、标题和描述的视觉展示元素，适合展示组件预览、功能亮点或导航项。页面涵盖浅色与深色模式资源配置、图片宽高比、尺寸、格式和文件大小等图片指南，以及与 Columns 组件组合构建响应式预览网格的方法。" keywords: ["磁贴", "视觉预览", "网格", "展示"] boost: 3 --- diff --git a/zh/components/tooltips.mdx b/zh/components/tooltips.mdx index 5e1881a9a8..68970e31e7 100644 --- a/zh/components/tooltips.mdx +++ b/zh/components/tooltips.mdx @@ -1,6 +1,6 @@ --- title: "工具提示" -description: "添加工具提示，在用户悬停在文档中的术语、缩写或技术概念上时显示上下文定义和解释。" +description: "介绍 Mintlify 的工具提示组件：当用户将鼠标悬停在术语、缩写或技术概念上时显示上下文定义与解释，并可附带行动呼吁链接。页面提供 API 术语提示示例，并说明 tip、headline、cta 和 href 等属性的用法与必填要求，有效提升文档的可读性。" keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"] boost: 3 --- diff --git a/zh/components/tree.mdx b/zh/components/tree.mdx index fb04d75b61..dda4281c4e 100644 --- a/zh/components/tree.mdx +++ b/zh/components/tree.mdx @@ -1,6 +1,6 @@ --- title: "树" -description: "使用树组件显示带有可折叠节点和路径名语法高亮的层级文件与文件夹结构。" +description: "使用 Mintlify 的树组件展示文件系统、项目目录等层级结构，支持可折叠节点、键盘导航和无障碍访问。页面对比 Markdown 列表语法与 Tree.Folder、Tree.File 组件语法，介绍 defaultOpen 控制展开状态以及嵌套文件夹的写法。" keywords: ["树", "文件树", "文件夹结构", "层级导航", "文件系统"] boost: 3 --- diff --git a/zh/components/update.mdx b/zh/components/update.mdx index 52aa9215e4..9afd5efb77 100644 --- a/zh/components/update.mdx +++ b/zh/components/update.mdx @@ -1,6 +1,6 @@ --- title: "Update" -description: "使用 update 组件以带日期的结构化时间轴格式展示产品更新、发行说明和更新日志条目。" +description: "介绍 Mintlify 的 Update 组件：以带日期的时间轴格式展示更新日志、版本说明和产品发布信息，可包含截图、代码与变更列表。页面说明 label、tags、description 等属性，以及自动生成 RSS 订阅源条目和自定义 rss 内容的方法。" keywords: ["更新日志", "产品更新", "版本说明"] boost: 3 --- diff --git a/zh/components/view.mdx b/zh/components/view.mdx index 616acbc44c..f45439fda4 100644 --- a/zh/components/view.mdx +++ b/zh/components/view.mdx @@ -1,6 +1,6 @@ --- title: "视图" -description: "使用 view 组件为不同编程语言、框架或配置方案创建可切换的内容面板。" +description: "使用 Mintlify 的 View 组件创建随多视图下拉菜单切换的内容面板，为不同编程语言或框架展示专属文档与代码示例。页面说明目录会自动只显示当前选中视图的标题，并介绍 title、icon 和 iconType 属性，以及与选项卡、代码组的使用场景区分。" keywords: ["选择器", "特定语言内容", "内容切换"] boost: 3 --- diff --git a/zh/components/visibility.mdx b/zh/components/visibility.mdx index cc08aacdae..c62b6c5c2c 100644 --- a/zh/components/visibility.mdx +++ b/zh/components/visibility.mdx @@ -1,6 +1,6 @@ --- title: "Visibility" -description: "使用 visibility 组件向网页界面上的人类用户和 Markdown 输出中的 AI 代理展示不同内容，实现条件渲染。" +description: "介绍 Mintlify 的 Visibility 组件：为浏览网页的人类读者和处理 Markdown 输出的 AI 代理分别显示不同内容，无需维护多个页面。页面通过示例演示 for=humans 与 for=agents 的条件渲染行为，以及在 .md 页面视图中的相反展示逻辑。" keywords: ["visibility", "agents", "humans", "markdown", "AI", "conditional content"] boost: 3 --- diff --git a/zh/contact-support.mdx b/zh/contact-support.mdx index aafe49d98f..2d3895e745 100644 --- a/zh/contact-support.mdx +++ b/zh/contact-support.mdx @@ -1,6 +1,6 @@ --- title: "联系支持团队" -description: "联系 Mintlify 支持团队，获取文档站点的技术支持与账户帮助，包括初始配置、部署故障、订阅计费、企业销售咨询以及功能与集成相关问题。" +description: "了解联系 Mintlify 支持团队的各种途径：使用键盘快捷键向基于文档训练的 AI 助手提问、观看 YouTube 视频教程、通过控制台的支持按钮发送消息，或发送邮件至支持邮箱。页面还说明 24 小时内回复的目标时限，以及来信时附上控制台 URL 以便更快获得帮助。" ---
diff --git a/zh/create/changelogs.mdx b/zh/create/changelogs.mdx index 09685758e2..5589805285 100644 --- a/zh/create/changelogs.mdx +++ b/zh/create/changelogs.mdx @@ -1,6 +1,6 @@ --- title: "更新日志" -description: "创建包含基于日期条目、RSS 订阅支持和订阅者通知功能的产品更新日志，让用户及时了解最新动态。" +description: "了解如何使用 Update 组件在 Mintlify 文档中创建产品更新日志页面，包含创建页面与添加导航配置的分步设置说明。页面涵盖右侧目录导航、标签筛选与可分享的筛选链接、RSS 订阅支持等自定义选项，帮助订阅用户及时了解功能发布、错误修复与公告等产品动态。" keywords: ["product updates", "release notes", "RSS"] boost: 3 --- diff --git a/zh/create/code.mdx b/zh/create/code.mdx index f463d3b215..01d6eccb09 100644 --- a/zh/create/code.mdx +++ b/zh/create/code.mdx @@ -1,6 +1,6 @@ --- title: "格式化代码" -description: "在文档中格式化代码，支持语法高亮、行号、差异对比、复制按钮和 MDX 中的交互式代码组功能。" +description: "了解在 Mintlify 文档中格式化代码的方法，包括行内代码片段与围栏代码块的写法。页面详细介绍了基于 Shiki 的语法高亮、标题、图标、行号、行高亮与差异对比等代码块元选项及其语法，以及将多个代码块组合为选项卡式代码组、让 AI 助手解释代码等实用功能。" keywords: ["代码块", "语法高亮", "代码样式"] --- diff --git a/zh/create/files.mdx b/zh/create/files.mdx index fba8c360f9..e6063c8e87 100644 --- a/zh/create/files.mdx +++ b/zh/create/files.mdx @@ -1,6 +1,6 @@ --- title: "文件" -description: "从你的文档仓库提供图片、视频、PDF 和数据文件等静态资产，支持自动优化和 CDN 分发。" +description: "了解 Mintlify 如何从文档仓库自动提供图片、视频、PDF 和数据文件等静态资产，仓库中的路径结构会直接映射到站点 URL。页面列出所有方案与 Enterprise 方案支持的文件类型、20 MB 的文件大小限制、启用认证站点的注意事项，以及组织资产文件夹结构的建议。" keywords: ["静态资产","支持的文件类型"] boost: 3 --- diff --git a/zh/create/image-embeds.mdx b/zh/create/image-embeds.mdx index 152840fb77..ee28652dc2 100644 --- a/zh/create/image-embeds.mdx +++ b/zh/create/image-embeds.mdx @@ -1,6 +1,6 @@ --- title: "图片与嵌入" -description: "在 MDX 页面中添加图片、嵌入 YouTube 视频和 iframe，以视觉和互动内容丰富文档。" +description: "了解在 Mintlify 文档中添加图片与嵌入内容的方法：使用 Markdown 或 HTML img 标签插入图片、控制尺寸、禁用缩放、添加可点击链接，并嵌入 YouTube 视频和 iframe。页面还涵盖 alt 替代文本的无障碍与 SEO 建议及文件大小限制。" keywords: ["images", "videos", "iframes", "media", "svg"] --- diff --git a/zh/create/list-table.mdx b/zh/create/list-table.mdx index fd4b0653b7..4caf262972 100644 --- a/zh/create/list-table.mdx +++ b/zh/create/list-table.mdx @@ -1,6 +1,6 @@ --- title: "列表与表格" -description: "使用 Markdown 表格、有序列表、无序列表、嵌套结构和任务列表复选框在文档中呈现结构化数据。" +description: "了解在 Mintlify 文档中使用 Markdown 语法创建列表与表格：包括有序列表、无序列表、通过缩进实现的嵌套列表和带复选框的任务列表，以及使用竖线和连字符构建带表头的表格。页面还说明如何用反斜杠转义表格单元格中的竖线字符，帮助你在文档中清晰呈现结构化数据。" keywords: ["有序列表", "无序列表", "Markdown 表格", "表格格式"] --- diff --git a/zh/create/personalization.mdx b/zh/create/personalization.mdx index 11b6c2e019..3ada30a70e 100644 --- a/zh/create/personalization.mdx +++ b/zh/create/personalization.mdx @@ -1,6 +1,6 @@ --- title: "个性化内容" -description: "根据已识别访客的数据、用户组成员资格和自定义变量显示个性化内容，为不同受众量身定制文档。" +description: "了解 Mintlify 的个性化功能：通过共享会话、JWT 或 OAuth 识别访客，为其预填充 API 密钥并展示与订阅计划、角色或用户组相关的内容。页面对比三种识别方式的适用场景，并提供在控制台 Add-ons 页面启用个性化和配置 Info API 的分步说明。" keywords: ["内容个性化", "个性化", "用户数据", "分组", "动态", "预填充"] --- diff --git a/zh/create/redirects.mdx b/zh/create/redirects.mdx index 951189aeb8..9df3ec2440 100644 --- a/zh/create/redirects.mdx +++ b/zh/create/redirects.mdx @@ -1,6 +1,6 @@ --- title: "重定向" -description: "在 docs.json 中配置 URL 重定向规则，为已移动、重命名或删除的文档页面保留 SEO 排名，并防止读者遇到失效链接。" +description: "了解如何在 docs.json 中配置重定向规则，在文档页面移动、重命名或删除后保留 SEO 排名并防止读者遇到失效链接。页面对比永久 308 与临时 307 重定向的使用场景，介绍用通配符重定向合并大量规则的方法，以及来源路径不能包含 URL 锚点与查询参数的限制。" keywords: ["redirects"] boost: 3 --- diff --git a/zh/create/reusable-snippets.mdx b/zh/create/reusable-snippets.mdx index eae1a5837a..3441cf0905 100644 --- a/zh/create/reusable-snippets.mdx +++ b/zh/create/reusable-snippets.mdx @@ -1,6 +1,6 @@ --- title: "可复用片段" -description: "创建带有变量的可复用内容片段，在文档页面间保持一致性并减少 MDX 文件中的重复内容。" +description: "了解如何在 Mintlify 文档中创建可复用片段，将常用内容写入单独文件并导入到多个页面，减少重复内容并保持一致性。页面涵盖片段的工作方式、snippets 文件夹的特殊规则、绝对与相对导入路径的区别，以及 JSX 标签命名需使用 PascalCase 的惯例。" keywords: ["content snippets", "reusable content", "variables"] --- diff --git a/zh/create/text.mdx b/zh/create/text.mdx index 85f957636a..b4bb58c828 100644 --- a/zh/create/text.mdx +++ b/zh/create/text.mdx @@ -1,6 +1,6 @@ --- title: "文本格式" -description: "在 MDX 页面中使用 Markdown 标题、粗体、斜体、链接、引用块和其他内联样式选项格式化文档文本。" +description: "了解在 Mintlify 的 MDX 页面中格式化文本的方法：使用 Markdown 标题组织内容层级与导航，应用粗体、斜体、链接和引用块等行内样式。页面详细说明自动锚点 ID 的生成规则、重复标题的编号处理方式，以及使用自定义 ID 覆盖默认自动锚点的语法。" keywords: ["Markdown 格式", "文本样式", "标题", "锚点链接", "custom heading IDs"] --- diff --git a/zh/credits.mdx b/zh/credits.mdx index 52712b5b43..d0818b0022 100644 --- a/zh/credits.mdx +++ b/zh/credits.mdx @@ -1,6 +1,6 @@ --- title: "积分定价" -description: "了解组织的积分余额如何运作、哪些功能会消耗积分，以及我们如何对积分套餐、超额使用和结转进行计费。" +description: "了解 Mintlify 积分定价的运作方式：组织拥有由所有部署和团队成员共享的月度积分余额，来源包括方案配额、积分套餐与结转。页面列出 assistant 回复、agent 运行以及翻译、SEO 审计等各类自动化的平均积分消耗，并说明按部署配置的超额使用设置。" keywords: ["积分", "计费", "定价", "组织", "assistant", "agent", "自动化", "套餐", "超额使用", "结转", "用量", "导出", "CSV", "活动日志"] --- diff --git a/zh/customize/custom-404-page.mdx b/zh/customize/custom-404-page.mdx index 0985d5ebac..f961bac9d9 100644 --- a/zh/customize/custom-404-page.mdx +++ b/zh/customize/custom-404-page.mdx @@ -1,6 +1,6 @@ --- title: "自定义 404 页面" -description: "自定义文档站点 404 错误页面的标题、描述和外观，以匹配你的品牌风格并引导访客。" +description: "了解如何在 Mintlify 中自定义文档站点的 404 错误页面：通过 docs.json 的 errors 配置设置自定义标题与支持 MDX 格式的描述文本，或选择自动重定向到首页。页面还介绍 404 页面如何根据请求的 URL 智能推荐语义相关的文档页面。" keywords: ["404 error page", "custom error pages"] --- diff --git a/zh/customize/custom-domain.mdx b/zh/customize/custom-domain.mdx index ae7901b404..0d2e867ebc 100644 --- a/zh/customize/custom-domain.mdx +++ b/zh/customize/custom-domain.mdx @@ -1,6 +1,6 @@ --- title: "自定义域名" -description: "使用 DNS 记录、自动 TLS 证书以及 Mintlify 托管或代理流量路由，将你的站点托管在自己的域名、子域名或子路径下。" +description: "了解如何将 Mintlify 文档托管在自定义域名、子域名或子路径下：在控制台添加域名、在域名提供商处配置 DNS 记录并等待自动签发 TLS 证书。页面涵盖顶级域名的 CNAME flattening 要求、子路径的代理与直连两种流量方式，以及认证站点的限制。" keywords: ["自定义域名配置", "DNS 配置", "CNAME 记录", "TLS 证书", "子路径", "托管", "基础路径", "顶级域名", "CNAME flattening", "ALIAS 记录"] --- diff --git a/zh/customize/custom-scripts.mdx b/zh/customize/custom-scripts.mdx index 6da610cdea..6fe4d8b797 100644 --- a/zh/customize/custom-scripts.mdx +++ b/zh/customize/custom-scripts.mdx @@ -1,6 +1,6 @@ --- title: "自定义脚本" -description: "为你的文档站点添加自定义 JavaScript 和 CSS，用于分析、小组件、样式覆盖、第三方集成和 API Playground 服务器变量。支持身份验证、租户切换和注销后的运行时更新，值仅保存在当前会话内存中，不会写入浏览器存储。" +description: "了解如何通过自定义 CSS 和 JavaScript 全面定制 Mintlify 文档站点的外观与行为：使用 Tailwind CSS 类设置元素样式，添加自动加载的 .css 与 .js 文件，实现样式覆盖、分析统计和第三方集成，并配置 API Playground 服务器变量。" keywords: ["CSS", "JavaScript", "Tailwind CSS", "样式定制", "API Playground", "服务器变量"] --- diff --git a/zh/customize/fonts.mdx b/zh/customize/fonts.mdx index fe21c49503..712defed97 100644 --- a/zh/customize/fonts.mdx +++ b/zh/customize/fonts.mdx @@ -1,6 +1,6 @@ --- title: "字体" -description: "使用 Google Fonts 或自托管字体文件，为标题、正文和代码块自定义文档站点的排版样式。" +description: "了解如何自定义 Mintlify 文档站点的字体排版：在 docs.json 中通过 fonts 属性配置自动加载的 Google Fonts、本地字体文件或外部托管字体，并可分别为标题与正文设置不同的字体族、字重和格式，页面提供完整的 JSON 配置示例与设置步骤。" keywords: ["Google Fonts", "本地字体", "自定义排版"] boost: 3 --- diff --git a/zh/customize/react-components.mdx b/zh/customize/react-components.mdx index 7e36f558ca..72ba9a45b4 100644 --- a/zh/customize/react-components.mdx +++ b/zh/customize/react-components.mdx @@ -1,6 +1,6 @@ --- title: "React" -description: "使用 JSX、状态和客户端逻辑，在你的 Mintlify 文档中通过自定义 React 组件构建交互且可复用的元素。" +description: "了解如何在 Mintlify 文档中使用自定义 React 组件构建交互式元素：直接在 MDX 文件中声明内联组件、使用 useState 等 hooks 管理状态，或从 snippets 文件夹导入可复用组件。页面提供计数器与颜色生成器示例以及导入限制的说明。" keywords: ["React 组件", "交互式组件", "JSX", "自定义组件"] boost: 3 --- diff --git a/zh/customize/themes.mdx b/zh/customize/themes.mdx index a0184dae65..83f74c853c 100644 --- a/zh/customize/themes.mdx +++ b/zh/customize/themes.mdx @@ -1,6 +1,6 @@ --- title: "主题" -description: "选择一个主题，自定义文档的外观样式。" +description: "浏览 Mintlify 提供的全部文档主题，包括 Mint、Maple、Palm、Willow、Linden、Almond、Aspen 和 Sequoia，每个主题都附带预览图、风格说明及在线预览链接。在 docs.json 中配置 theme 属性即可切换主题，自定义文档站点的整体外观。" 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 82ab69f272..25682e50f4 100644 --- a/zh/dashboard/audit-logs.mdx +++ b/zh/dashboard/audit-logs.mdx @@ -1,6 +1,6 @@ --- title: "审计日志" -description: "查看审计日志，追踪组织成员执行的操作，包括部署、配置更改和权限更新。" +description: "了解如何使用 Mintlify 审计日志追踪组织成员执行的操作，满足安全监控、合规记录与故障排查需求。页面介绍在 dashboard 查看与导出 CSV 的方法、两年的日志保留期、时间戳与操作者等条目字段，以及按日期范围和组织、成员、部署等类别筛选日志的方式。" keywords: ["监控", "活动追踪", "安全", "合规", "SIEM"] --- diff --git a/zh/dashboard/network-access.mdx b/zh/dashboard/network-access.mdx index e70049ffb7..d1ccbdb895 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 与编辑器的访问限制为受信任的 IP 地址和 CIDR 范围，并通过空闲超时与最大会话有效期控制会话保持有效的时长。页面提供配置步骤和避免将自己锁定在外的注意事项。" keywords: ["IP 允许列表", "网络访问", "CIDR", "IP 限制", "安全", "dashboard 访问", "受信任的 IP", "会话有效期", "空闲超时", "会话时长"] --- diff --git a/zh/dashboard/roles.mdx b/zh/dashboard/roles.mdx index b70446cfc2..e3279c10aa 100644 --- a/zh/dashboard/roles.mdx +++ b/zh/dashboard/roles.mdx @@ -1,6 +1,6 @@ --- title: "角色" -description: "为团队成员分配管理员、编辑者或查看者角色，控制 Mintlify 中的访问级别、编辑权限和部署能力。" +description: "了解 Mintlify 基于角色的访问控制（RBAC）：为团队成员分配管理员、编辑者或查看者角色，通过详细的权限对照表了解各角色在编辑内容、发布更改、管理账单、更新用户角色和配置 SSO 等操作上的访问级别，帮助企业按照最小权限原则安全地管理文档团队的访问与协作权限。" keywords: ["RBAC", "基于角色的访问控制", "管理员", "编辑者", "查看者", "权限", "撤销凭证", "会话撤销"] boost: 3 --- diff --git a/zh/dashboard/scim.mdx b/zh/dashboard/scim.mdx index 5e140d6279..0d99c3e6d9 100644 --- a/zh/dashboard/scim.mdx +++ b/zh/dashboard/scim.mdx @@ -1,6 +1,6 @@ --- title: "SCIM 预配" -description: "使用 SCIM 从你的身份提供商为控制台成员进行预配和取消预配。" +description: "介绍如何在 Mintlify 控制台启用 SCIM 预配，从 Okta 等符合 SCIM 2.0 标准的身份提供商自动为组织成员进行预配和取消预配。内容涵盖生成 SCIM base URL 与 bearer token、配置身份提供商的分步操作，以及与 SSO 配合的用户访问管理方式。" keywords: ["SCIM", "Okta", "身份提供商", "用户管理", "RBAC"] --- diff --git a/zh/dashboard/security-contact.mdx b/zh/dashboard/security-contact.mdx index b06ff9d230..42f317c793 100644 --- a/zh/dashboard/security-contact.mdx +++ b/zh/dashboard/security-contact.mdx @@ -1,6 +1,6 @@ --- title: "安全联系人" -description: "为你的组织配置安全联系人邮箱地址，用于接收漏洞报告、安全警报和合规更新。" +description: "介绍如何在 Mintlify 控制台为组织配置安全联系人邮箱，用于接收漏洞报告、安全警报与合规更新等安全相关的通知和通信。内容包括该企业版功能的适用套餐，以及在控制台中添加、更新和移除安全联系人的具体操作入口，帮助你的团队第一时间获知与组织安全相关的重要信息。" keywords: ["security", "notifications", "compliance"] --- diff --git a/zh/dashboard/session-security.mdx b/zh/dashboard/session-security.mdx index b385591650..4ed44f89d6 100644 --- a/zh/dashboard/session-security.mdx +++ b/zh/dashboard/session-security.mdx @@ -1,6 +1,6 @@ --- title: "会话安全" -description: "配置仪表盘会话超时、最长会话生命周期以及 IP 允许列表，以实施更严格的身份验证和网络访问策略。" +description: "介绍 Mintlify 企业版的会话安全设置：配置空闲会话超时与最长会话生命周期，强制仪表盘用户按组织安全策略定期重新进行身份验证。内容涵盖两项设置的取值范围、启用与配置步骤、两者的相互作用，以及如何借助它们满足合规性要求并降低共享或未锁定设备上会话被滥用的安全风险。" keywords: ["session", "timeout", "authentication", "security", "SSO", "IP allowlist"] --- diff --git a/zh/dashboard/sso.mdx b/zh/dashboard/sso.mdx index 91a9ca5c3e..403052807d 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: "逐步讲解如何在 Mintlify 仪表板中配置单点登录（SSO），支持 Okta 和 Microsoft Entra 的 SAML 身份验证，并可联系支持配置 OIDC 等其他身份提供商。内容涵盖创建 SAML 应用、属性声明和 metadata URL 的完整设置步骤。" keywords: ["SSO", "SAML 认证", "Okta 集成", "Microsoft Entra", "身份提供商", "JIT", "预配", "OIDC"] --- diff --git a/zh/deploy/bitbucket.mdx b/zh/deploy/bitbucket.mdx index cb7e1279f8..5ebfcff715 100644 --- a/zh/deploy/bitbucket.mdx +++ b/zh/deploy/bitbucket.mdx @@ -1,6 +1,6 @@ --- title: "Bitbucket Cloud" -description: "将 Bitbucket Cloud 仓库连接到 Mintlify，实现自动化部署、拉取请求预览和持续同步。" +description: "介绍如何通过 OAuth 将 Bitbucket Cloud 仓库连接到 Mintlify，实现推送到部署分支时自动部署文档，并为拉取请求创建预览部署。内容涵盖账户与权限方面的连接要求、设置向导的完整分步授权操作，以及工作区、仓库、部署分支和内容目录的配置方法。" keywords: ["Bitbucket Cloud", "仓库连接", "OAuth", "自动化部署"] --- diff --git a/zh/deploy/ci.mdx b/zh/deploy/ci.mdx index dd579839bf..69543e137f 100644 --- a/zh/deploy/ci.mdx +++ b/zh/deploy/ci.mdx @@ -1,6 +1,6 @@ --- title: "CI 检查" -description: "在 CI/CD 流水线中自动化文档质量检查，包括失效链接检测、代码检查、语法校验和构建预览。" +description: "介绍如何为 GitHub 仓库启用 Mintlify 的 CI 检查，在拉取请求合并到部署分支前自动对文档进行 lint 和质量把关。内容涵盖失效链接检测、Vale 写作风格检查等可用检查项，以及 Warning 与 Blocking 两种运行级别的区别、安装步骤和配置方法。" keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- diff --git a/zh/deploy/cloudflare.mdx b/zh/deploy/cloudflare.mdx index 2f021a0fb5..478cfa429e 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 文档托管在自有域名的 /docs 等子路径下。内容涵盖设置基础路径、创建和配置 Worker 脚本、DNS 记录设置，以及 Vercel 代理、WAF 防火墙规则和 403 错误的排查方法。" keywords: ["Cloudflare Workers", "子路径路由", "反向代理设置", "Worker 配置", "Cloudflare WAF", "防火墙规则", "Bot Fight Mode", "403 错误"] boost: 3 --- diff --git a/zh/deploy/csp-configuration.mdx b/zh/deploy/csp-configuration.mdx index 3b5a006646..3e5288d44e 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 文档时如何配置内容安全策略（CSP）标头以防止功能异常。内容涵盖 script-src、connect-src、img-src 等常用 CSP 指令的作用，以及保证文档正常运行所需允许的完整域名列表，帮助你兼顾安全与可用性。" keywords: ["内容安全策略", "CSP", "指令", "安全标头", "防火墙", "XSS 防护"] --- diff --git a/zh/deploy/custom-portal.mdx b/zh/deploy/custom-portal.mdx index 03c534dab7..3190a45fc4 100644 --- a/zh/deploy/custom-portal.mdx +++ b/zh/deploy/custom-portal.mdx @@ -1,6 +1,6 @@ --- title: "定制开发者门户" -description: "在自托管 Mintlify 之上部署完全定制的开发者门户，由 Mintlify 设计和构建，并通过版本化发布交付。" +description: "介绍 Mintlify 面向企业的定制开发者门户：在自托管部署之上由 Mintlify 设计、构建并持续维护完全定制的呈现层，支持 API 市场、登录认证、凭据管理、订阅和个性化内容等功能，同时你的团队继续通过编辑器或基于 Git 的工作流照常创作和维护文档内容。" 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 ca4f649074..3b0bc938a8 100644 --- a/zh/deploy/deployments.mdx +++ b/zh/deploy/deployments.mdx @@ -1,6 +1,6 @@ --- title: "部署" -description: "在 Mintlify 控制台中管理文档部署，包括查看部署历史、监控构建状态和故障排查。" +description: "介绍如何在 Mintlify 控制台管理文档部署：当推送后自动部署未生效时手动触发一次新的部署、在活动页面查看部署历史、提交信息与构建状态、将站点即时回滚到之前的成功构建，以及删除整个部署。同时提供 GitHub 应用连接和更改未上线等常见问题的基本故障排查思路。" 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..171968dc46 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: "概述将 Mintlify 文档托管在主域名 /docs 等子路径下的各种方案：可由 Mintlify 直接管理你的域名，或使用 Cloudflare Workers、AWS Route 53 与 CloudFront、Vercel 重写规则及自定义反向代理进行代理配置。" keywords: ["子路径路由", "/docs 设置", "基础路径"] boost: 3 --- diff --git a/zh/deploy/export.mdx b/zh/deploy/export.mdx index 0ab7b06edf..c425cf53d1 100644 --- a/zh/deploy/export.mdx +++ b/zh/deploy/export.mdx @@ -1,6 +1,6 @@ --- title: "离线导出" -description: "将文档站点导出为自包含的 zip 压缩包，用于离线查看、内部分发或隔离环境托管。" +description: "介绍如何使用 mint export 命令将 Mintlify 文档站点导出为自包含的 zip 压缩包，供离线查看、内部分发或在隔离网络环境中托管，收件人无需联网即可浏览。内容涵盖 CLI 前提条件、输出路径与用户组模拟等导出选项，以及静态归档的安全注意事项。" keywords: ["导出", "离线", "zip", "静态站点", "分发", "mint export"] --- diff --git a/zh/deploy/ghes.mdx b/zh/deploy/ghes.mdx index 4de2df91b2..142909fef1 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（GHES）实例上注册并配置本地版 Mintlify GitHub 应用，实现文档自动部署与同步。内容涵盖出站连接与防火墙等网络要求、注册应用的分步操作，以及权限、密钥和 webhook 的完整配置方法。" keywords: ["GitHub Enterprise Server", "GHES", "GitHub Enterprise"] --- diff --git a/zh/deploy/github.mdx b/zh/deploy/github.mdx index e64c2a1b1e..3554a57ff4 100644 --- a/zh/deploy/github.mdx +++ b/zh/deploy/github.mdx @@ -1,6 +1,6 @@ --- title: "GitHub" -description: "将你的 GitHub 仓库连接到 Mintlify，实现自动部署、拉取请求预览构建和持续文档同步。" +description: "介绍如何安装 Mintlify GitHub 应用并将你自己的 GitHub 存储库连接到文档站点，在你推送更改时实现自动部署、预览构建与持续同步。内容涵盖一键克隆与手动设置两种迁移方式、Git 设置页面的完整配置流程，以及更改未部署等常见连接问题的故障排查方法。" 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 011e0f492f..9dab977eac 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，使自动化能够以 GitLab 用户身份克隆存储库、推送提交和发起合并请求。内容涵盖管理员权限等前置条件、在实例上注册 OAuth 应用并共享凭据的步骤，以及与部署令牌连接的依赖关系。" keywords: ["GitLab", "自托管", "OAuth", "自动化", "企业"] --- diff --git a/zh/deploy/gitlab.mdx b/zh/deploy/gitlab.mdx index e25d249f95..a9839d7f02 100644 --- a/zh/deploy/gitlab.mdx +++ b/zh/deploy/gitlab.mdx @@ -1,6 +1,6 @@ --- title: "GitLab" -description: "将 GitLab 仓库连接到 Mintlify，实现自动化文档部署、合并请求预览和持续同步。" +description: "讲解如何使用项目访问令牌和 webhook 将 GitLab 仓库连接到 Mintlify，实现文档自动部署与合并请求的预览部署。内容涵盖查找项目 ID、生成访问令牌并设置角色与作用域、配置部署分支，以及在 Mintlify 控制台完成 Git 设置向导的完整分步操作与配置说明。" keywords: ["GitLab 集成", "访问令牌", "合并请求预览", "自托管", "实例"] boost: 3 --- diff --git a/zh/deploy/monorepo.mdx b/zh/deploy/monorepo.mdx index 3741dae804..43025edc32 100644 --- a/zh/deploy/monorepo.mdx +++ b/zh/deploy/monorepo.mdx @@ -1,6 +1,6 @@ --- title: "Monorepo 设置" -description: "在 monorepo 项目中配置文档路径和内容目录，使 Mintlify 仅从你指定的文档文件夹部署。" +description: "介绍如何在 monorepo（单一代码仓库）中配置 Mintlify，从你指定的 docs 子目录部署文档，让文档与多个项目或服务的代码一同维护。内容涵盖典型目录结构示例、管理员权限与 docs.json 等先决条件，以及在 Git 设置中配置文档路径的分步操作。" keywords: ["monorepo", "content 目录", "多项目存储库"] --- diff --git a/zh/deploy/multi-repo.mdx b/zh/deploy/multi-repo.mdx index 7db9f35ece..35ecc4ef27 100644 --- a/zh/deploy/multi-repo.mdx +++ b/zh/deploy/multi-repo.mdx @@ -1,6 +1,6 @@ --- title: "多仓库部署" -description: "将多个 Git 仓库中的文件合并到一个 Mintlify 站点，并为每个源仓库分配独立的 URL 路径。" +description: "介绍 Mintlify 企业版的多仓库部署：将多个 Git 仓库中的文档内容合并到一个站点，并为每个源仓库分配独立的 URL 路径，例如产品文档、API 参考和 SDK 指南。内容涵盖工作原理、基础源与根 docs.json 的作用、配置要求以及跨源变量的处理方式。" keywords: ["multi-repo", "multiple repositories", "git sources", "URL path"] --- diff --git a/zh/deploy/preview-deployments.mdx b/zh/deploy/preview-deployments.mdx index 657af6fef5..fc740d1da3 100644 --- a/zh/deploy/preview-deployments.mdx +++ b/zh/deploy/preview-deployments.mdx @@ -1,6 +1,6 @@ --- title: "预览部署" -description: "为每个拉取请求获取唯一的预览 URL，让审阅者可以在实时环境中查看文档更改，然后再合并到生产环境。" +description: "介绍 Mintlify 的预览部署功能：每个拉取请求都会生成唯一且可共享的预览 URL，让审阅者在合并到生产环境前查看文档更改的实际效果，并随新提交自动更新。内容涵盖自动预览的触发条件、在控制台手动创建分支预览、fork 拉取请求的限制，以及限制访问权限的认证方法。" 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 cb5e7e5ddf..1eda35739a 100644 --- a/zh/deploy/reverse-proxy.mdx +++ b/zh/deploy/reverse-proxy.mdx @@ -1,6 +1,6 @@ --- title: "反向代理" -description: "使用 nginx 或类似工具配置自定义反向代理，在你自己的域名子路径上提供 Mintlify 文档服务。" +description: "讲解如何使用 nginx 等工具配置自定义反向代理，在自有域名的 /docs 等子路径下提供 Mintlify 文档服务。内容涵盖在控制台设置基础路径、需要代理的路由与缓存规则、Host 请求头转发要求，以及 SSL 证书签发和域名验证方面的常见问题与注意事项。" keywords: ["反向代理配置","nginx","代理路由","请求头转发"] --- diff --git a/zh/deploy/rollbacks.mdx b/zh/deploy/rollbacks.mdx index 66263e028d..41ba87aac9 100644 --- a/zh/deploy/rollbacks.mdx +++ b/zh/deploy/rollbacks.mdx @@ -1,6 +1,6 @@ --- title: "回滚" -description: "在控制台中将你的 Mintlify 在线站点恢复到之前的一次成功构建，无需回退提交或等待重新构建。" +description: "介绍 Mintlify 企业版的回滚功能：在控制台将在线站点立即恢复到最近 10 次成功构建中的任意一次，无需回退提交或等待重新构建，几秒内即可生效。内容涵盖回滚与返回最新构建的操作步骤、仅限管理员执行和不支持预览部署等限制，以及审计日志中记录的回滚与提升操作。" keywords: ["即时", "撤销部署", "恢复构建", "提升构建", "损坏的部署"] --- diff --git a/zh/deploy/route53-cloudfront.mdx b/zh/deploy/route53-cloudfront.mdx index a98628c894..33348be5d9 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: "通过组合 Route 53 DNS 路由、CloudFront 分发和缓存行为，将你的 Mintlify 文档部署到 AWS 子路径。" +description: "讲解如何组合使用 AWS Route 53 DNS 与 CloudFront 分发，将 Mintlify 文档托管在自有域名的 /docs 等子路径下。内容涵盖创建 CloudFront 分配、按路径配置缓存行为与源请求策略、允许全部 HTTP 方法，以及 DNS 记录设置的完整步骤。" keywords: ["AWS 部署", "Route 53 DNS（域名系统）", "CloudFront CDN", "缓存策略"] --- diff --git a/zh/deploy/self-host.mdx b/zh/deploy/self-host.mdx index 130a7f4206..60258abcc8 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 CDK 以及 Azure、Google Cloud、Oracle Cloud、OpenShift 等任意 Kubernetes 环境的 Helm 部署，满足数据驻留、合规与气隙需求。" keywords: ["self-host", "self-hosted", "on-prem", "deploy", "AWS", "CDK", "Helm", "Kubernetes", "OpenShift", "air gap", "enterprise"] --- diff --git a/zh/deploy/vercel.mdx b/zh/deploy/vercel.mdx index 2987cb8bed..6c2d3187c9 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.json 的重写规则（rewrites）将 Mintlify 文档托管在主域名的 /docs 等子路径下。内容涵盖重写与重定向的区别、分步配置示例与自定义基础路径，以及域名验证、SSL 证书签发和 CloudFront 等外部代理相关的常见问题处理。" keywords: ["vercel.json", "Vercel 部署", "重写规则配置", "子路径路由", "外部代理", "CloudFront", "域名验证", "SSL 证书"] boost: 3 --- diff --git a/zh/editor/agent.mdx b/zh/editor/agent.mdx index e268466e60..91c6908f40 100644 --- a/zh/editor/agent.mdx +++ b/zh/editor/agent.mdx @@ -1,6 +1,6 @@ --- title: "询问智能体" -description: "使用编辑器内置的 AI 智能体撰写内容、编辑页面、留下评论和建议、搜索站点、上传文件并配置设置。" +description: "介绍 Mintlify 编辑器内置的 AI 智能体：通过对话撰写和编辑页面、重新组织导航、更新 docs.json、跨仓库搜索并管理仪表板设置。内容涵盖打开智能体的快捷键与示例提示、附加图片、PDF 和代码等文件作为上下文，以及请求评论与建议等实用功能的使用方法。" keywords: ["editor", "AI", "assistant", "agent", "chat", "comments", "suggestions", "code mode", "file upload"] --- diff --git a/zh/editor/collaborate.mdx b/zh/editor/collaborate.mdx index ca45f5e47b..115717144d 100644 --- a/zh/editor/collaborate.mdx +++ b/zh/editor/collaborate.mdx @@ -1,7 +1,7 @@ --- title: "在编辑器中协作" sidebarTitle: "协作" -description: "在编辑器中留下评论、以建议的形式提出修改，并与同事实时协同编辑。" +description: "介绍如何在 Mintlify 编辑器中与团队协作：针对选中文本发表评论、以建议模式提出可接受或拒绝的修改，并与同事实时协同编辑同一页面。评论不会提交到 Git 或出现在已发布站点。内容涵盖查看者、编辑者等各角色的协作权限、@提及与邮件通知，以及拉取请求中的评论摘要。" keywords: ["comments", "suggestions", "collaboration", "review", "mentions", "real time"] --- diff --git a/zh/editor/index.mdx b/zh/editor/index.mdx index e084421f25..a3bb4b9995 100644 --- a/zh/editor/index.mdx +++ b/zh/editor/index.mdx @@ -1,7 +1,7 @@ --- title: "编辑器概览" sidebarTitle: "概览" -description: "使用 Mintlify 编辑器在浏览器中创建、编辑和发布内容。支持实时协作和持续的 Git 同步。" +description: "Mintlify 编辑器概览：在浏览器中撰写、编辑和发布文档，采用 docs-as-code 工作流，所有更改由 Git 保存并保持同步。内容涵盖自动保存与发布的区别、分支与 pull request 的工作方式、实时协同编辑，以及编辑器布局和各角色的操作权限。" keywords: ["web editor", "git", "branches", "commits", "pull requests"] --- diff --git a/zh/editor/keyboard-shortcuts.mdx b/zh/editor/keyboard-shortcuts.mdx index ca6037d123..4349466cf5 100644 --- a/zh/editor/keyboard-shortcuts.mdx +++ b/zh/editor/keyboard-shortcuts.mdx @@ -1,6 +1,6 @@ --- title: "键盘快捷键" -description: "查看 Mintlify 网页编辑器的完整键盘快捷键列表，包括文本格式、导航和编辑命令。" +description: "Mintlify 网页编辑器的完整键盘快捷键参考，覆盖 macOS 和 Windows 两个操作系统平台。内容包括搜索文件、切换 AI 助手与源码模式等全局快捷键，以及可视化模式下的文本格式、标题、列表和表格等常用编辑命令，帮助你更快地在编辑器中浏览和编辑文档。" keywords: ["editor", "keys", "keyboard", "shortcuts"] --- diff --git a/zh/editor/pages.mdx b/zh/editor/pages.mdx index 4f5671b5e2..07785f40a8 100644 --- a/zh/editor/pages.mdx +++ b/zh/editor/pages.mdx @@ -1,7 +1,7 @@ --- title: "创建和编辑页面" sidebarTitle: "编辑内容" -description: "在编辑器中创建页面、编辑内容、添加媒体、组织导航、恢复页面的历史版本，以及管理私有页面。" +description: "介绍如何在 Mintlify 编辑器中创建和编辑页面：了解 Home 与 Publishing 两个工作区的区别、通过斜杠命令上传图片和视频等媒体文件、通过拖拽组织导航结构、恢复页面的历史版本以及管理私有页面，帮助你直接在浏览器中高效地维护和整理文档内容与导航。" keywords: ["editor", "content", "pages", "navigation", "version history", "media", "images", "private pages"] --- diff --git a/zh/editor/publish.mdx b/zh/editor/publish.mdx index 98b75d8814..c05b3631b1 100644 --- a/zh/editor/publish.mdx +++ b/zh/editor/publish.mdx @@ -1,7 +1,7 @@ --- title: "发布更改" sidebarTitle: "发布" -description: "把编辑器中的更改发布到已发布的站点。分支和保护规则决定了发布时会发生什么。" +description: "讲解如何把 Mintlify 编辑器中的更改发布到线上站点：了解内容编辑、新增页面等待处理更改的类型，以及分支类型与保护规则如何决定 Publish、Save in branch、Create pull request 等可用操作，并介绍自动发布与部署耗时的注意事项。" keywords: ["publish", "branch", "git", "commit", "conflicts", "deploy", "pull request"] --- diff --git a/zh/editor/review.mdx b/zh/editor/review.mdx index 76ac4bc53e..be56cd4d3f 100644 --- a/zh/editor/review.mdx +++ b/zh/editor/review.mdx @@ -1,7 +1,7 @@ --- title: "审阅更改" sidebarTitle: "审阅" -description: "在更改上线前进行预览，与团队共享，并在编辑器中批准和合并 pull request。" +description: "介绍在 Mintlify 编辑器中审阅文档更改的方式：使用实时预览在编辑时即时查看渲染效果，通过预览部署获得可共享的 URL 供团队在合并前审阅，并且无需离开编辑器即可批准和合并 pull request。附两种预览方式在速度、访问方式与用途上的对比和适用场景。" keywords: ["review", "preview", "live preview", "pull request", "approve", "merge", "diff"] --- diff --git a/zh/editor/settings.mdx b/zh/editor/settings.mdx index 0f3b12ce87..eceeeb7a43 100644 --- a/zh/editor/settings.mdx +++ b/zh/editor/settings.mdx @@ -1,7 +1,7 @@ --- title: "编辑器的 AI 与发布设置" sidebarTitle: "设置" -description: "配置编辑器外观、AI 说明和发布默认值，以控制编辑器的显示方式，以及它提交和合并更改的方式。" +description: "介绍 Mintlify 编辑器的设置页面：Appearance 个人外观偏好、Publishing 全局发布默认值、面向 AI 智能体的持久说明，以及 PR 说明、main 分支自动提交和重置编辑器等功能，帮助你精细控制编辑器的显示方式以及提交和合并更改的行为。" keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"] --- diff --git a/zh/editor/tutorial.mdx b/zh/editor/tutorial.mdx index 3bdb9af5db..8e9e71e81b 100644 --- a/zh/editor/tutorial.mdx +++ b/zh/editor/tutorial.mdx @@ -1,6 +1,6 @@ --- title: "如何使用编辑器" -description: "Mintlify 编辑器的分步演练：创建分支、编辑页面、分享预览部署以供审查，然后发布你的更改。" +description: "Mintlify Web 编辑器完整使用教程：学习如何创建分支进行隔离编辑、编辑现有页面或新建文档页面并插入组件、通过预览部署分享更改供团队审查，最后发起拉取请求并将更改发布到线上文档站点，帮助初次使用编辑器的用户快速掌握从修改、审查到发布上线的完整内容更新流程。" keywords: ["编辑器", "教程", "分支", "发布"] --- diff --git a/zh/guides/accessibility.mdx b/zh/guides/accessibility.mdx index c940277801..61f91d8d01 100644 --- a/zh/guides/accessibility.mdx +++ b/zh/guides/accessibility.mdx @@ -1,7 +1,7 @@ --- title: "如何创建无障碍文档" sidebarTitle: "无障碍访问" -description: "遵循 WCAG 指南创建无障碍文档，包括语义化 HTML、键盘导航、替代文本和包容性内容实践。" +description: "介绍如何在 Mintlify 文档中落实无障碍最佳实践：遵循 WCAG 网页内容无障碍指南，添加图片替代文本、检查标题层级与颜色对比度，支持键盘导航和屏幕阅读器，并使用 mint a11y 命令排查问题，从影响最大的改动入手，将无障碍访问融入日常的文档编写与发布工作流程。" keywords: ["无障碍文档", "WCAG", "a11y", "屏幕阅读器", "无障碍"] --- diff --git a/zh/guides/assistant-embed.mdx b/zh/guides/assistant-embed.mdx index 5446c071a0..36262c751c 100644 --- a/zh/guides/assistant-embed.mdx +++ b/zh/guides/assistant-embed.mdx @@ -1,7 +1,7 @@ --- title: "构建应用内助手" sidebarTitle: "构建应用内助手" -description: "构建并嵌入一个应用内文档助手，使用来自你的 Mintlify 文档站点的引用信息回答用户问题。" +description: "本教程带你使用 React 构建并嵌入应用内 AI 文档助手小部件：通过 Mintlify AI 助手 API 提供实时流式回复、Markdown 消息渲染和浮动聊天面板，让用户无需离开你的应用即可获得基于文档内容的产品帮助，附基于 Next.js 和 Vite 的完整示例仓库与配置步骤。" keywords: ["assistant embed", "in-app chat", "widget", "chatbot"] --- diff --git a/zh/guides/auth0.mdx b/zh/guides/auth0.mdx index fe65a3e0a0..e2d283e667 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 提供方，包括创建 Regular Web Application、获取 Client ID 与 Client Secret、填写授权和令牌 URL，以及配置回调 Redirect URL 完成握手流程。" keywords: ["Auth0", "OAuth flow"] --- diff --git a/zh/guides/branches.mdx b/zh/guides/branches.mdx index 289d8e0644..01b0ed306c 100644 --- a/zh/guides/branches.mdx +++ b/zh/guides/branches.mdx @@ -1,6 +1,6 @@ --- title: "使用 branch" -description: "创建和管理文档 branch，以预览变更、与团队成员协作，并在发布到生产环境之前合并更新。" +description: "了解如何在 Mintlify 中使用 Git 分支管理文档内容：通过 Web 编辑器或本地开发环境创建 branch、遵循清晰的命名规范、在分支上保存提交并预览更改，最后通过拉取请求将更新合并到部署分支发布上线，让线上文档站点保持稳定并支持多人协作与评审流程。" 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..3159bc033b 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 Code 命令行工具撰写和维护 Mintlify 文档：安装并启动 Claude Code，在项目根目录添加 CLAUDE.md 文件定义写作规范、组件用法与工作流程，让 AI 按照你的风格指南生成一致的文档内容，并附可直接复制的模板。" keywords: ["Claude Code", "CLAUDE.md", "AI 文档", "Anthropic", "Claude"] --- diff --git a/zh/guides/codex.mdx b/zh/guides/codex.mdx index dfd94328b8..2980ea4de7 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: "介绍如何使用 OpenAI Codex CLI 在终端中编写和维护 Mintlify 文档：安装 Codex、在仓库根目录创建 AGENTS.md 项目说明文件，为 AI 提供组件模式、写作标准和风格指南等持久上下文，生成符合团队规范的 MDX 内容，附示例文件。" 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..fc5409dbd6 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 应用添加到组织级和仓库级规则集（ruleset）的绕过列表并设为 Always，使自动化能够自动创建并合并 pull request 到 main 部署分支，涵盖前提条件、逐步配置步骤以及验证自动合并设置是否生效的方法。" keywords: ["automerge", "ruleset", "分支保护", "bypass"] --- diff --git a/zh/guides/content-templates.mdx b/zh/guides/content-templates.mdx index 064006f661..b6939cacf4 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..3a3fe96b70 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..4525752269 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 编辑器来编写 Mintlify 文档：在文档仓库的 .cursor/rules 目录创建项目规则文件，为 AI 提供组件格式、MDX 约定和技术写作标准等持久上下文，让整个团队生成风格一致、符合规范的文档内容，并附可直接复用的示例项目规则。" keywords: ["Cursor", "Cursor rules", "project rules", "AI 文档", "Cursor 文档"] --- diff --git a/zh/guides/custom-frontend.mdx b/zh/guides/custom-frontend.mdx index e8f1ec9071..7d65483cc2 100644 --- a/zh/guides/custom-frontend.mdx +++ b/zh/guides/custom-frontend.mdx @@ -1,7 +1,7 @@ --- title: "无头文档与自定义前端" sidebarTitle: "无头 / 自定义前端" -description: "使用 Astro 构建无头文档前端，同时借助 Mintlify 进行内容管理、AI 搜索和助手功能。" +description: "介绍 Mintlify 无头（headless）模式：使用 @mintlify/astro 集成构建自定义文档前端，在完全掌控布局、样式和路由的同时，继续使用 Mintlify 的内容管理、MDX 组件、搜索和 AI 助手功能，并通过入门模板在本地运行无头项目。" keywords: ["Astro", "headless", "自托管", "自定义", "无头文档", "无头 CMS"] --- diff --git a/zh/guides/custom-layouts.mdx b/zh/guides/custom-layouts.mdx index 7ff2b4b570..6513340147 100644 --- a/zh/guides/custom-layouts.mdx +++ b/zh/guides/custom-layouts.mdx @@ -1,7 +1,7 @@ --- title: "构建自定义页面布局" sidebarTitle: "自定义页面布局" -description: "使用页面模式和组件在 Mintlify 文档中构建自定义落地页、营销页面及其他非标准布局。" +description: "介绍如何使用页面模式在 Mintlify 文档中构建自定义布局：比较 default、wide、custom、frame 和 center 五种模式的适用场景，并演示如何使用 Tailwind CSS 和组件搭建包含 hero 区域、功能卡片与行动号召的落地页。" 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 13104655b6..41dd2cafb7 100644 --- a/zh/guides/developer-documentation.mdx +++ b/zh/guides/developer-documentation.mdx @@ -1,7 +1,7 @@ --- title: "创建开发者文档" sidebarTitle: "开发者文档" -description: "构建帮助工程师集成你的 API、SDK 和工具的开发者文档，包括快速入门、参考文档和使用指南。" +description: "介绍如何在 Mintlify 上创建开发者文档：从 OpenAPI 规范生成可交互测试的 API 参考、通过 GitHub 或 GitLab 同步保持文档与代码库一致、维护多版本文档，并涵盖审核与迁移现有内容、规划文档结构等帮助工程师集成 API 与 SDK 的实践。" keywords: ["开发者文档", "API 文档", "SDK 文档", "技术文档", "开发者门户"] --- diff --git a/zh/guides/devin-desktop.mdx b/zh/guides/devin-desktop.mdx index cf57b1e414..bc5d960db5 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（原 Windsurf）的 Cascade AI 助手来编写 Mintlify 文档：在文档仓库的 .devin/rules 目录创建工作区规则文件，提供组件用法和写作标准等持久上下文，让整个团队获得一致的 AI 文档建议与规范。" keywords: ["Devin Desktop", "Windsurf", "Cascade", "workspace rules", "AI 文档", "Devin 文档"] --- diff --git a/zh/guides/geo.mdx b/zh/guides/geo.mdx index 2d41e7ccc9..6eb8bc7b73 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（GEO）：了解 AI 答案引擎如何决定引用哪些内容，掌握 GEO 与传统 SEO 的区别，并通过结构化、直接、具体的写作让 ChatGPT、Perplexity 等 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 d3d96aca54..1fe31485e5 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 版本控制入门指南：解释仓库、分支、提交和拉取请求等核心概念，说明 Web 编辑器如何在后台自动执行 Git 操作，帮助你理解文档即代码（docs-as-code）工作流，与在本地开发环境中工作的团队成员高效协作，并随时查看或恢复版本历史。" 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..a96a288b98 100644 --- a/zh/guides/help-center.mdx +++ b/zh/guides/help-center.mdx @@ -1,7 +1,7 @@ --- title: "创建帮助中心" sidebarTitle: "帮助中心" -description: "在 Mintlify 上构建自助式帮助中心，帮助客户找到答案，减少支持工单量，并随团队规模扩展。" +description: "介绍如何在 Mintlify 上搭建自助式帮助中心：使用 help-center-starter 模板快速起步，借助 AI 驱动的搜索、反馈小组件和分析功能帮助客户自行找到答案、减少支持工单量，并涵盖审核与迁移现有支持内容、规划帮助中心导航结构的完整实施步骤。" keywords: ["support", "customer", "self-service", "FAQ"] --- diff --git a/zh/guides/improving-docs.mdx b/zh/guides/improving-docs.mdx index eb4bed5399..ba0a4f4f37 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..035c0363a4 100644 --- a/zh/guides/index.mdx +++ b/zh/guides/index.mdx @@ -1,6 +1,6 @@ --- title: "指南" -description: "浏览文档最佳实践、内容策略、SEO 优化、可访问性和 docs-as-code 工作流程的实用指南。" +description: "Mintlify 指南栏目总览：汇集文档写作与维护的实用最佳实践指南，涵盖 AI 工具与自动化、API 文档、内容策略与模板、SEO 与 GEO 优化、无障碍访问、国际化以及 docs-as-code 工作流等主题，帮助你从零规划、撰写和持续维护让用户成功的文档。" boost: 3 --- diff --git a/zh/guides/internationalization.mdx b/zh/guides/internationalization.mdx index aa269402f4..3a2ffacf41 100644 --- a/zh/guides/internationalization.mdx +++ b/zh/guides/internationalization.mdx @@ -1,7 +1,7 @@ --- title: "如何设置多语言文档" sidebarTitle: "国际化" -description: "设置多语言文档，支持基于语言区域的路由、语言切换导航和翻译内容，以覆盖全球用户。" +description: "介绍如何在 Mintlify 中设置多语言文档：使用 ISO 639-1 语言代码组织翻译文件的目录结构，在 docs.json 的导航配置中添加语言切换器，实现基于语言区域的路由并高效维护翻译内容，通过国际化（i18n）让用户以首选语言访问文档，覆盖全球用户。" keywords: ["国际化", "i18n", "多语言文档", "翻译", "本地化", "语言切换器"] --- diff --git a/zh/guides/knowledge-base.mdx b/zh/guides/knowledge-base.mdx index 31f70d2083..5fd45cdd39 100644 --- a/zh/guides/knowledge-base.mdx +++ b/zh/guides/knowledge-base.mdx @@ -1,7 +1,7 @@ --- title: "创建知识库" sidebarTitle: "知识库" -description: "在 Mintlify 上托管团队内部知识库，以整合信息、提升搜索效果，并降低维护成本。" +description: "介绍如何在 Mintlify 上搭建团队内部知识库：借助 AI 助手搜索、Slack 集成和 Web 编辑器降低知识贡献门槛，通过 SSO 或 OAuth 认证与用户组控制访问权限，并涵盖审核与迁移现有内容、设计导航结构等实施步骤，为团队打造统一可信的权威信息源。" keywords: ["知识库", "内部文档", "私有文档", "kb", "知识管理", "知识捕获"] --- diff --git a/zh/guides/linking.mdx b/zh/guides/linking.mdx index 05022f620d..bee3a56b09 100644 --- a/zh/guides/linking.mdx +++ b/zh/guides/linking.mdx @@ -1,7 +1,7 @@ --- title: "如何有效地链接文档页面" sidebarTitle: "链接" -description: "在文档中创建内部链接、锚点链接和深层链接，并通过重定向和断链检查维护链接完整性。" +description: "介绍如何在 Mintlify 文档中有效使用链接：创建根相对路径的内部链接、指向页面特定部分的锚点链接和深层链接，了解 Mintlify 生成锚点的规则，并通过重定向和断链检查维护链接完整性，改善文档导航体验、内容可发现性与 SEO 表现，帮助用户沿逻辑路径高效浏览复杂主题。" keywords: ["文档链接", "内部链接", "锚点链接", "断链", "深层链接", "交叉引用"] --- diff --git a/zh/guides/maintenance.mdx b/zh/guides/maintenance.mdx index df38caf869..9b9b0f454e 100644 --- a/zh/guides/maintenance.mdx +++ b/zh/guides/maintenance.mdx @@ -1,7 +1,7 @@ --- title: "如何长期维护文档" sidebarTitle: "维护" -description: "通过审查计划、责任模型、自动化检查和内容生命周期实践，保持文档的准确性和时效性。" +description: "介绍如何长期维护文档的准确性与时效性：建立集中式、分布式或混合式的责任模型，设置基于触发器和定期计划的审查节奏，将文档更新纳入产品变更和发布流程，通过自动化检查和内容生命周期实践避免内容随功能演进而过时，持续保持用户对文档和产品的信任，避免文档悄然成为团队的隐性负担。" keywords: ["文档维护", "保持文档更新", "内容生命周期", "过时文档", "文档责任制"] --- diff --git a/zh/guides/media.mdx b/zh/guides/media.mdx index 1b98d25469..5fb818c0cf 100644 --- a/zh/guides/media.mdx +++ b/zh/guides/media.mdx @@ -1,7 +1,7 @@ --- title: "如何在文档中使用图片、截图和视频" sidebarTitle: "媒体" -description: "了解何时以及如何在文档中使用截图、GIF 和视频，包括格式选择、替代文本和长期维护方面的指导。" +description: "介绍在 Mintlify 文档中使用截图、GIF 和视频等媒体的最佳实践：判断何时值得添加视觉内容、为不同场景选择 PNG 或 WebP 等文件格式、编写替代文本并控制文件大小，以及嵌入 YouTube 等外部视频平台的建议，让媒体带来的清晰度真正超过其维护成本。" keywords: ["文档图片", "截图", "文档视频", "GIF", "媒体最佳实践", "替代文本"] --- diff --git a/zh/guides/migrating-from-mdx.mdx b/zh/guides/migrating-from-mdx.mdx index 9db85da630..23c7e596d3 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: "迁移指南：将 API 文档从单独维护的 MDX 端点页面迁移到由 OpenAPI 规范自动生成的页面，涵盖校验并准备规范、使用 x-mint 与 x-hidden 扩展自定义端点、更新 docs.json 导航结构等步骤，减少需要维护的文件数量并提升文档一致性。" keywords: ["API 迁移", "OpenAPI 迁移", "x-mint 扩展"] --- diff --git a/zh/guides/navigation.mdx b/zh/guides/navigation.mdx index caa12992a9..743efb526a 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..833e6261b1 100644 --- a/zh/guides/seo.mdx +++ b/zh/guides/seo.mdx @@ -1,7 +1,7 @@ --- title: "如何改善文档 SEO" sidebarTitle: "SEO" -description: "通过页面标题、关键词研究、内部链接和技术 SEO 技巧，提升文档在搜索引擎中的排名。" +description: "介绍提升文档搜索引擎排名的实用 SEO 技巧：编写 50-60 字符的页面标题和 130-160 字符的元描述、利用 Google Search Console 进行关键词研究、构建可维护的内部链接策略，并借助 Mintlify 自动生成的 meta 标签完成技术优化。" keywords: ["文档 SEO", "搜索引擎优化", "关键词研究", "技术 SEO", "元描述"] --- diff --git a/zh/guides/style-and-tone.mdx b/zh/guides/style-and-tone.mdx index b978f378e0..833cba7980 100644 --- a/zh/guides/style-and-tone.mdx +++ b/zh/guides/style-and-tone.mdx @@ -1,7 +1,7 @@ --- title: "如何撰写技术文档" sidebarTitle: "风格与语气" -description: "撰写清晰、一致的技术文档，包含关于语气、结构、术语和文风的实用指导，适用于开发者文档和产品文档。" +description: "介绍撰写清晰、一致技术文档的核心风格与语气原则：使用第二人称和主动语态、保持句子和段落简短、使用可被快速浏览的格式与编号步骤列表、编写符合用户意图的标题、统一术语并避免不必要的行话，帮助你为开发者文档和产品文档建立一致的写作风格，让用户快速完成任务并建立对产品的信任。" keywords: ["技术写作", "文档风格指南", "写作规范", "语气与文风", "技术文档"] --- diff --git a/zh/guides/understand-your-audience.mdx b/zh/guides/understand-your-audience.mdx index bb13ac0e2f..c5c9b5183c 100644 --- a/zh/guides/understand-your-audience.mdx +++ b/zh/guides/understand-your-audience.mdx @@ -1,7 +1,7 @@ --- title: "如何了解你的文档受众" sidebarTitle: "了解你的受众" -description: "定义你的文档受众，研究他们的目标和知识水平，并将这些洞察应用到编写帮助他们成功的内容中。" +description: "介绍如何了解你的文档受众：定义新用户、集成 API 的开发者、管理员等主要读者画像，通过用户访谈、支持团队洞察和分析数据研究他们的目标、术语与知识水平，并将这些研究结果应用到内容深度、结构和语气的决策中，避免写出面向所有人却对任何人都没有帮助的文档，让内容真正贴合读者需求。" keywords: ["文档受众", "用户研究", "受众画像", "技术写作受众", "用户反馈"] --- diff --git a/zh/guides/use-automations.mdx b/zh/guides/use-automations.mdx index a13e2e4a2b..b88f1a5447 100644 --- a/zh/guides/use-automations.mdx +++ b/zh/guides/use-automations.mdx @@ -1,6 +1,6 @@ --- title: "使用自动化" -description: "使用 Mintlify 自动化来自动执行周期性的文档维护：选择合适的触发器、撰写有效的指令，并获得一致的 agent 结果。" +description: "介绍如何使用 Mintlify 自动化自动执行周期性文档维护任务：根据内容更新、代码变更、自定义计划或集成事件选择合适的触发器，配置预定义或自定义自动化，并学习撰写能让 agent 产生一致结果的有效指令，让内容无需手动维护即可长期保持准确，并了解何时应改用一次性 agent 任务。" keywords: ["automations", "automation", "automate", "automation guide", "automation instructions", "agent automation", "self updating"] --- diff --git a/zh/help-center/can-i-rename-my-deployment-or-organization.mdx b/zh/help-center/can-i-rename-my-deployment-or-organization.mdx index 319adceacf..31d2f66c7c 100644 --- a/zh/help-center/can-i-rename-my-deployment-or-organization.mdx +++ b/zh/help-center/can-i-rename-my-deployment-or-organization.mdx @@ -1,6 +1,6 @@ --- title: "我可以重命名我的部署或组织吗？" -description: "在控制台中修改部署的项目名称，并了解为什么子域名和组织名称无法重命名，只能通过删除并重新创建来更改。" +description: "解答能否重命名 Mintlify 部署或组织：说明部署的项目名称、docs.json 中的站点名称和自定义域名可以随时修改，而子域名与组织名称在创建后固定，只能通过删除并重新创建来更改，并提供具体操作步骤、所需权限、删除前的注意事项，以及读者实际能看到哪些名称。" keywords: ["rename deployment", "change deployment name", "rename organization", "change organization name", "change subdomain", "project name", "delete and recreate"] --- diff --git a/zh/help-center/configure-oauth-with-auth0.mdx b/zh/help-center/configure-oauth-with-auth0.mdx index bb6f65b1cc..a5da3976f6 100644 --- a/zh/help-center/configure-oauth-with-auth0.mdx +++ b/zh/help-center/configure-oauth-with-auth0.mdx @@ -1,6 +1,6 @@ --- title: "使用 Auth0 配置 OAuth 2.0 身份验证" -description: "为私有 Mintlify 文档站点将 Auth0 设置为 OAuth 2.0 身份提供方，包括端点 URL、回调注册和基于用户组的访问控制。" +description: "帮助中心文章：为私有 Mintlify 文档站点将 Auth0 设置为 OAuth 2.0 身份提供方，提供授权、令牌、用户信息和登出端点等字段取值对照表，说明如何在 Auth0 中注册回调 Redirect URL，并介绍基于用户组的访问控制配置，适用于 Enterprise 方案。" keywords: ["Auth0", "OAuth", "OAuth 2.0", "OIDC", "identity provider", "SSO", "private docs", "authentication"] --- diff --git a/zh/help-center/domain-already-claimed-by-another-organization.mdx b/zh/help-center/domain-already-claimed-by-another-organization.mdx index 73e426199b..05cd49613f 100644 --- a/zh/help-center/domain-already-claimed-by-another-organization.mdx +++ b/zh/help-center/domain-already-claimed-by-another-organization.mdx @@ -1,6 +1,6 @@ --- title: "修复 \"Domain already claimed by another organization\" 错误" -description: "从其他 Mintlify 部署释放自定义域名，或在因其他部署或组织占用而无法添加域名时申请支持。" +description: "解决添加自定义域名时出现 Domain already claimed by another organization 错误的方法：在 Mintlify 控制台从占用该域名的其他部署或组织自行释放域名，或联系支持团队并提交域名所有权证明请求释放，然后重新添加到目标部署。" keywords: ["Domain is already in use by another deployment in your organization", "Domain is already claimed by another organization", "custom domain", "release domain", "domain ownership"] --- diff --git a/zh/help-center/openapi-url-fetch-fails-during-build.mdx b/zh/help-center/openapi-url-fetch-fails-during-build.mdx index edf2325a43..f25d00ab7f 100644 --- a/zh/help-center/openapi-url-fetch-fails-during-build.mdx +++ b/zh/help-center/openapi-url-fetch-fails-during-build.mdx @@ -1,6 +1,6 @@ --- title: "修复 \"Failed to fetch OpenAPI file for anchor or tab\" 错误" -description: "解决 Mintlify 构建因私有主机、需要认证的 URL、TLS、DNS 或 CI 竞争条件而无法下载托管的 OpenAPI 文档的问题。" +description: "排查 Mintlify 构建中 Failed to fetch OpenAPI file 错误的方法：用 curl 在公网重现 OpenAPI URL 下载，识别身份认证、TLS 证书、DNS 解析等失败原因，排除 CI 流水线的竞争条件，并在规范无法公开时改用仓库相对路径引用。" keywords: ["Failed to fetch OpenAPI file", "OpenAPI build error", "openapi URL", "spec fetch", "build failure", "CI race condition"] --- diff --git a/zh/help-center/preview-deployment-not-created-for-fork-branch.mdx b/zh/help-center/preview-deployment-not-created-for-fork-branch.mdx index c974b4ffd5..0b5d2d3ffb 100644 --- a/zh/help-center/preview-deployment-not-created-for-fork-branch.mdx +++ b/zh/help-center/preview-deployment-not-created-for-fork-branch.mdx @@ -1,6 +1,6 @@ --- title: "未为 fork 分支创建预览部署" -description: "为什么从 fork 打开的拉取请求以及传递给预览 API 的 fork 分支不会生成预览部署，以及维护者如何预览来自 fork 的更改。" +description: "解释为什么来自 fork 分支的拉取请求和预览 API 调用不会生成 Mintlify 预览部署：GitHub 应用只安装在主仓库上，无法读取贡献者的 fork 仓库。介绍拥有写入权限的维护者如何将 fork 分支推送到主仓库，从而预览外部贡献者提交的文档更改。" keywords: ["fork pull request", "no preview link", "preview deployment missing", "fork branch preview", "trigger preview API fork", "external contributor preview"] --- diff --git a/zh/help-center/private-repo-missing-when-creating-second-deployment.mdx b/zh/help-center/private-repo-missing-when-creating-second-deployment.mdx index 5d05bea45d..873e7fcc06 100644 --- a/zh/help-center/private-repo-missing-when-creating-second-deployment.mdx +++ b/zh/help-center/private-repo-missing-when-creating-second-deployment.mdx @@ -1,6 +1,6 @@ --- title: "创建第二个部署时私有仓库未出现" -description: "重新授权 Mintlify 以获得私有仓库访问权限，使现有的私有 GitHub 仓库出现在新部署的引导仓库选择器中。" +description: "解决创建第二个 Mintlify 部署时私有 GitHub 仓库未出现在引导仓库选择器中的问题：使用 private=true 查询参数重新授权以获取私有仓库访问权限，并在仓库仍未出现时更新组织中 Mintlify GitHub App 安装的仓库访问范围设置。" keywords: ["第二个部署", "同一仓库多个部署", "私有仓库未出现", "onboarding 仓库选择器", "授权 GitHub", "private=true", "重新授权 GitHub"] --- diff --git a/zh/help-center/static-file-not-served.mdx b/zh/help-center/static-file-not-served.mdx index 905ed9a437..b89ac187a0 100644 --- a/zh/help-center/static-file-not-served.mdx +++ b/zh/help-center/static-file-not-served.mdx @@ -1,6 +1,6 @@ --- title: "修复文档站点上返回 404 的静态文件" -description: "诊断你添加到文档仓库中的文件（例如 JSON、PDF 或图片）为什么无法在 Mintlify 站点上通过预期 URL 加载。" +description: "诊断 Mintlify 文档站点上 JSON、PDF、图片等静态文件返回 404 错误的原因：核对 URL 与仓库路径是否匹配、检查支持的文件类型和 20 MB 大小限制、排除认证站点与 mintignore 文件排除规则的影响，并确认添加文件后已重新构建部署。" keywords: ["static file not served", "404 asset", "JSON not found", "mintignore", "static assets", "file serving"] --- diff --git a/zh/help-center/style-card-icons-with-custom-css.mdx b/zh/help-center/style-card-icons-with-custom-css.mdx index b1f6362a46..8a422c80a1 100644 --- a/zh/help-center/style-card-icons-with-custom-css.mdx +++ b/zh/help-center/style-card-icons-with-custom-css.mdx @@ -1,6 +1,6 @@ --- title: "为 Card 组件内的图标设置样式" -description: "使用自定义 CSS 和 card-icon 数据属性选择器，为 Card 组件的图标添加背景色、圆角或内边距。" +description: "介绍如何用自定义 CSS 为 Mintlify Card 组件的图标添加背景色、圆角和内边距：使用 data-component-part 卡片图标数据属性选择器精确定位图标元素，并了解 card-title、card-content 等其他可用同样方式设置样式的卡片部分。" keywords: ["card icon", "card component styling", "data-component-part", "custom CSS", "icon background"] --- diff --git a/zh/index.mdx b/zh/index.mdx index 22d9eafdb6..c2d9f70687 100644 --- a/zh/index.mdx +++ b/zh/index.mdx @@ -1,6 +1,6 @@ --- title: "简介" -description: "邂逅新一代文档体验：AI 原生、开箱即用且美观，为开发者打造。" +description: "Mintlify 文档首页：了解 AI 原生、开箱即用且美观的新一代文档平台，通过快速开始指南、CLI 命令行工具安装、基于浏览器的网页编辑器和丰富的内置交互组件，帮助开发者和团队在几分钟内构建、本地预览并部署美观且专业的文档站点，打造面向开发者的出色文档体验。" mode: "frame" keywords: ["概览", "平台", "快速开始", "功能"] boost: 3 diff --git a/zh/integrations/analytics/adobe.mdx b/zh/integrations/analytics/adobe.mdx index 3828dd3fb4..04413c498b 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: "介绍如何在 Mintlify 文档站点集成 Adobe Analytics：在 docs.json 中配置 launchUrl，并从 Adobe Experience Platform Data Collection 的生产环境复制 Launch 脚本 URL，实现文档使用情况跟踪。" 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..663278279b 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 集成到 Mintlify 文档站点：在 docs.json 的 integrations 中配置 Amplitude API key，即可自动把页面浏览、搜索查询等分析事件发送到 Amplitude 平台，用于文档的产品分析和用户行为跟踪。" keywords: ["Amplitude 集成", "Amplitude API key", "用户行为跟踪", "产品分析"] boost: 3 --- diff --git a/zh/integrations/analytics/clarity.mdx b/zh/integrations/analytics/clarity.mdx index 58f5ec467f..3b7554702a 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 文档站点：在 docs.json 中配置 Clarity 项目 ID，并从 Clarity 控制台的跟踪代码中获取该项目 ID，捕获文档访客的会话录制、点击热图和用户交互行为等分析数据。" 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..42a337267d 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 文档站点：在 docs.json 的 integrations 对象中配置 publicApiKey 公共 API 密钥，将分析数据发送到 Clearbit，用于丰富文档访客数据、识别来访企业并追踪企业级互动情报。" keywords: ["Clearbit 集成", "用户数据丰富", "访客情报", "public API key"] boost: 3 --- diff --git a/zh/integrations/analytics/fathom.mdx b/zh/integrations/analytics/fathom.mdx index 86c58c3d50..7f23cb4543 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 文档站点：在 docs.json 的 integrations 中配置从脚本设置获取的 siteId 站点 ID，即可启用符合 GDPR、无 Cookie 且注重隐私保护的轻量级文档访客统计与跟踪分析。" keywords: ["Fathom Analytics", "注重隐私的分析", "站点 ID", "简洁分析"] boost: 3 --- diff --git a/zh/integrations/analytics/google-analytics.mdx b/zh/integrations/analytics/google-analytics.mdx index ce81a91338..b6d0380785 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 资源和 Web 数据流，获取 Measurement ID 并添加到 docs.json 配置文件，跟踪文档访客行为与页面浏览量，并使用调试扩展验证分析配置是否正常工作。" 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 c35b724fde..69a2591b89 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 文档站点：在 docs.json 中配置 GTM 容器的 tagId，向所有文档页面注入 GTM 脚本，集中管理分析标签、转化跟踪和营销事件，并按需通过 GTM 配置 Cookie 同意横幅。" 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..faec17d1c1 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 文档站点：在 docs.json 的 integrations 中配置从 Heap 账户设置页面获取的 appId 应用 ID，自动捕获文档访客的交互事件和页面浏览数据，无需手动埋点即可开展深入的用户行为分析。" keywords: ["Heap Analytics", "自动事件跟踪", "Heap app ID", "用户交互跟踪"] boost: 3 --- diff --git a/zh/integrations/analytics/hightouch.mdx b/zh/integrations/analytics/hightouch.mdx index 1dbad4ef39..9e021d6131 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 文档站点：在 docs.json 中配置 writeKey 写入密钥与可选的 apiHost 事件主机地址，把文档分析事件同步到 Hightouch，用于受众激活、用户分群和下游营销工具的数据路由分发。" keywords: ["Hightouch 集成", "数据激活", "write key", "受众同步"] boost: 3 --- diff --git a/zh/integrations/analytics/hotjar.mdx b/zh/integrations/analytics/hotjar.mdx index 629993e5e4..6ad975f654 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 文档站点：在 docs.json 的 integrations 对象中配置 hjid 和 hjsv 两个必填参数，将分析数据发送到 Hotjar，捕获文档访客的会话录制、点击热图和用户反馈，获取真实的体验洞察。" 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..6f5c8d1269 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 文档站点：在 docs.json 的 integrations 中配置 LogRocket 的 apiKey，即可回放文档访客的用户会话、监控前端错误，并对文档页面的交互问题进行细致深入的调试与行为分析。" keywords: ["LogRocket 集成", "会话回放", "错误监控", "app ID"] boost: 3 --- diff --git a/zh/integrations/analytics/mixpanel.mdx b/zh/integrations/analytics/mixpanel.mdx index 0b595b53b9..7ddd586353 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 文档站点：在 docs.json 中配置 Mixpanel 项目 token，按需设置欧盟或印度数据驻留 region 区域以匹配接入主机，自动跟踪页面访问、搜索查询、反馈提交和导航点击等文档用户交互事件。" keywords: ["Mixpanel 集成", "产品分析", "事件跟踪", "token"] boost: 3 --- diff --git a/zh/integrations/analytics/overview.mdx b/zh/integrations/analytics/overview.mdx index 91ddc90176..4d66171d11 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 Analytics 集成概览：了解如何在 docs.json 中配置 Google Analytics、Mixpanel、PostHog 等第三方分析平台的公共密钥，验证事件是否正常流入，并查看页面浏览、搜索、API 操作台和 AI 助手等自动跟踪事件的完整列表。" 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..b706a46fc8 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 文档站点：在 docs.json 中配置从 Pirsch 开发者设置页面获取的 Identification Code 站点 ID，启用符合 GDPR、无 Cookie 且不收集个人数据的隐私友好型文档访问统计分析。" keywords: ["Pirsch Analytics", "隐私分析", "identification code", "符合 GDPR"] boost: 3 --- diff --git a/zh/integrations/analytics/plausible.mdx b/zh/integrations/analytics/plausible.mdx index 79c0231d5c..207a46dc0b 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 文档站点：在 docs.json 中配置站点 domain 域名及可选的自托管 server 主机名参数，实现无 Cookie、无需同意横幅、尊重访客隐私的轻量级文档访客访问统计分析。" 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 4b20bc7a12..bcbcdb21b0 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 文档站点：在 docs.json 中配置项目 API key、自托管实例的 apiHost 以及 sessionRecording 选项，跟踪文档产品分析事件，并按需启用或禁用会话录制功能及配置录制授权域名。" keywords: ["PostHog 集成", "产品分析", "功能开关", "自托管 PostHog"] boost: 3 --- diff --git a/zh/integrations/analytics/segment.mdx b/zh/integrations/analytics/segment.mdx index cdfd1b5236..7abdb23a2f 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 文档站点：在 docs.json 的 integrations 中配置 Segment write key 写入密钥，把文档分析事件实时路由到数据仓库、CRM 和营销平台等下游工具，从而构建统一的客户数据管道。" 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 c0365fd922..3b4b27e95a 100644 --- a/zh/integrations/privacy/osano.mdx +++ b/zh/integrations/privacy/osano.mdx @@ -1,6 +1,6 @@ --- title: "Osano" -description: "将 Osano 集成到你的 Mintlify 文档站点，管理 Cookie 同意横幅、隐私偏好设置和监管合规要求。" +description: "介绍如何通过自定义 JavaScript 文件在 Mintlify 文档站点集成 Osano Cookie 同意管理器：创建加载 Osano 脚本 URL 的 osano.js 文件，并排查 Strict 严格合规模式下页面资源无法加载时的 Mintlify 域名允许列表设置。" keywords: ["Osano 集成", "Cookie 同意管理器", "GDPR 合规"] boost: 3 --- diff --git a/zh/integrations/privacy/overview.mdx b/zh/integrations/privacy/overview.mdx index 61d6ceae63..cd7f78bf44 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 同意管理平台，通过 cookies 配置检查本地存储中的用户同意状态以满足 GDPR 合规要求，以及在 docs.json 中为所有用户禁用遥测和使用数据收集。" keywords: ["数据隐私平台", "合规集成", "隐私工具", "Cookie 同意"] --- diff --git a/zh/integrations/privacy/transcend.mdx b/zh/integrations/privacy/transcend.mdx index 98aaed6454..63efb9d13f 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 文档站点：在 docs.json 中配置 bundleId 和可选的 analyticsPurpose 用途名称，展示 Transcend 同意横幅，并仅在访客授予同意后才加载分析与反馈脚本。" keywords: ["Transcend 集成", "同意管理", "Cookie 同意", "GDPR 合规"] --- diff --git a/zh/integrations/sdks/speakeasy.mdx b/zh/integrations/sdks/speakeasy.mdx index eb2d8eb41e..4d5dac2b8a 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: "介绍如何在 Mintlify API 操作台中展示 Speakeasy 自动生成的 SDK 代码示例：从 Speakeasy API Registry 获取合并规范的公开 URL，添加到 docs.json 的 anchors 或 tabs 配置，并验证多语言代码片段是否正常显示。" 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..90fa27388c 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: "介绍如何在 Mintlify API 操作台中展示 Stainless 自动生成的类型安全 SDK 代码示例：在 stainless.yml 中启用 code_samples，发布 OpenAPI 规范 URL 并添加到 docs.json 的 openapi 字段。" keywords: ["Stainless SDK", "SDK 生成", "API 客户端库", "类型安全的 SDK"] boost: 3 --- diff --git a/zh/integrations/support/front.mdx b/zh/integrations/support/front.mdx index 46ba1b8c01..c2849f3a59 100644 --- a/zh/integrations/support/front.mdx +++ b/zh/integrations/support/front.mdx @@ -1,6 +1,6 @@ --- title: "Front" -description: "将 Front 聊天集成到你的 Mintlify 文档站点，让访客可以直接从文档页面发起客户支持会话。" +description: "介绍如何将 Front Chat 聊天小组件集成到 Mintlify 文档站点：在 docs.json 的 integrations 中配置 frontchat 的 chat ID 聊天标识，让文档访客可以直接从页面发起客户支持会话，与支持团队进行实时交流互动。" keywords: ["Front Chat", "聊天小组件集成", "chat ID", "客户会话"] boost: 3 --- diff --git a/zh/integrations/support/intercom.mdx b/zh/integrations/support/intercom.mdx index b93b775b7f..11d0b9e1ee 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 文档站点：在 docs.json 的 integrations 对象中配置 Intercom 的 appId 应用 ID，为文档访客提供实时客户消息、在线支持与应用内引导帮助，提升文档的整体支持体验。" keywords: ["Intercom 集成", "Intercom 小部件", "app ID", "应用内消息"] boost: 3 --- diff --git a/zh/integrations/support/overview.mdx b/zh/integrations/support/overview.mdx index cd5ec7272c..90554c9077 100644 --- a/zh/integrations/support/overview.mdx +++ b/zh/integrations/support/overview.mdx @@ -1,6 +1,6 @@ --- title: "支持平台集成" -description: "将你的 Mintlify 文档连接到 Intercom 和 Front 等支持平台，让访客可以直接从文档页面获得实时帮助。" +description: "Mintlify 支持平台集成概览：了解如何在 docs.json 的 integrations 字段中配置 Intercom 应用 ID 或 Front 聊天 ID，把客服聊天小部件嵌入你的文档站点，让访客无需离开文档页面即可发起会话、获得实时帮助和客户支持。" keywords: ["客户支持平台", "工单系统集成", "支持组件", "客户协助"] --- diff --git a/zh/migration-services/enterprise.mdx b/zh/migration-services/enterprise.mdx index d487a873ef..e0e683574e 100644 --- a/zh/migration-services/enterprise.mdx +++ b/zh/migration-services/enterprise.mdx @@ -1,6 +1,6 @@ --- title: "企业版迁移" -description: "了解全流程企业迁移服务，包括专属项目管理、交付周期和质量审查阶段。" +description: "了解 Mintlify 企业版全流程迁移服务的各个阶段：从提交迁移表单、需求梳理与启动会议，到内容迁移与预览链接实时分享、七个工作日的反馈期、按照上线检查清单配置控制台并绑定自定义域名正式上线，此外还介绍涵盖内容完整性与视觉质量的第三方供应商和内部质量保障审查。" ---
diff --git a/zh/migration-services/go-live-checklist.mdx b/zh/migration-services/go-live-checklist.mdx index 7bdfff7b36..5b3edc9d3e 100644 --- a/zh/migration-services/go-live-checklist.mdx +++ b/zh/migration-services/go-live-checklist.mdx @@ -1,6 +1,6 @@ --- title: "上线检查清单" -description: "上线前检查清单，用于在 Mintlify 文档网站上线前验证重定向、自定义域名、身份验证、分析和 SEO 设置。" +description: "Mintlify 文档站点上线前的完整检查清单：将迁移的内容添加到代码库并连接 GitHub 或 GitLab，邀请团队成员，配置 SSO 与访问策略等安全设置，验证信息架构与内容质量，并设置重定向、自定义域名、身份验证、分析集成和 SEO，确保站点顺利发布。" noindex: true --- diff --git a/zh/migration/document360.mdx b/zh/migration/document360.mdx index 28b2b1c3bd..21dd37f292 100644 --- a/zh/migration/document360.mdx +++ b/zh/migration/document360.mdx @@ -1,6 +1,6 @@ --- title: "从 Document360 迁移" -description: "将 Document360 的工作区、语言、文章、分类、媒体、可复用内容和 API 参考迁移到 Mintlify。" +description: "指导如何从 Document360 迁移到 Mintlify 平台：导出项目 ZIP 快照，将工作区、语言和分类层级映射到 docs.json 导航结构，把文章与可复用内容转换为 MDX 格式，迁移 API 参考和媒体文件，并保留 URL 重定向与访问控制规则。" keywords: ["Document360 迁移", "Document360 到 Mintlify", "知识库导出", "项目 ZIP"] --- diff --git a/zh/migration/docusaurus.mdx b/zh/migration/docusaurus.mdx index 16ceca8940..abd05f21b7 100644 --- a/zh/migration/docusaurus.mdx +++ b/zh/migration/docusaurus.mdx @@ -1,6 +1,6 @@ --- title: "从 Docusaurus 迁移" -description: "将 Docusaurus 文档迁移到 Mintlify，包括 MDX 页面、侧边栏、版本、本地化内容、资源和自定义组件。" +description: "了解如何将 Docusaurus 2 或 3 文档站点迁移到 Mintlify：使用抓取工具转换公开站点并自动生成 docs.json 配置，或从源仓库迁移 MDX 页面、sidebars 导航、版本管理、本地化内容、静态资源与自定义 React 组件，本页还提供上线前的迁移检查清单。" keywords: ["Docusaurus 迁移", "Docusaurus 到 Mintlify", "sidebars.js", "versioned_docs"] --- diff --git a/zh/migration/fern.mdx b/zh/migration/fern.mdx index 3263c5fdee..fcdbbeff4e 100644 --- a/zh/migration/fern.mdx +++ b/zh/migration/fern.mdx @@ -1,6 +1,6 @@ --- title: "从 Fern 迁移" -description: "将 Fern 的 MDX 内容、docs.yml 导航、products、versions、资源、API 参考和组件迁移到 Mintlify。" +description: "本指南介绍如何将 Fern 文档站点从 Git 仓库完整迁移到 Mintlify：收集 MDX 页面与源内容，把 docs.yml 导航重建为 docs.json，迁移 products 与 versions 配置、静态资源、更新日志、OpenAPI 规范和自定义组件，并对照检查清单完成上线。" keywords: ["Fern 迁移", "Fern 到 Mintlify", "docs.yml", "Fern Docs"] --- diff --git a/zh/migration/gitbook.mdx b/zh/migration/gitbook.mdx index 00dfc37294..b623956b9a 100644 --- a/zh/migration/gitbook.mdx +++ b/zh/migration/gitbook.mdx @@ -1,6 +1,6 @@ --- title: "从 GitBook 迁移" -description: "将 GitBook 的 sections、Markdown、导航、可复用内容、variants、资源和 OpenAPI 文档迁移到 Mintlify。" +description: "了解将 GitBook 站点迁移到 Mintlify 的两种方式：使用 Git Sync 将每个 section 导出为 Markdown 源文件以获得最完整的迁移，或用抓取工具转换公开站点。本指南涵盖导航重建、可复用内容、variants 变体、静态资源与 OpenAPI 文档的迁移步骤。" keywords: ["GitBook 迁移", "GitBook 到 Mintlify", "Git Sync", "SUMMARY.md", "GitBook sections"] --- diff --git a/zh/migration/index.mdx b/zh/migration/index.mdx index 8e8144271e..5bab0565c4 100644 --- a/zh/migration/index.mdx +++ b/zh/migration/index.mdx @@ -1,7 +1,7 @@ --- title: "迁移概览" sidebarTitle: "概览" -description: "为将现有文档从 Docusaurus、ReadMe、GitBook、Fern、Document360 或其他平台迁移到 Mintlify 选择合适的迁移路径。" +description: "迁移概览页帮助你为现有文档选择合适的迁移路径：从 Docusaurus、ReadMe、GitBook、Fern 或 Document360 等平台迁移到 Mintlify，介绍自动抓取工具、平台导出与手动迁移三种方式的适用场景，以及用于转换单个页面的 page 抓取命令用法。" keywords: ["迁移", "Docusaurus", "ReadMe", "GitBook", "Fern", "Document360", "导入"] --- diff --git a/zh/migration/manual.mdx b/zh/migration/manual.mdx index 0b8c71a528..19a7c959ce 100644 --- a/zh/migration/manual.mdx +++ b/zh/migration/manual.mdx @@ -1,6 +1,6 @@ --- title: "从其他平台迁移" -description: "将文档从任意平台转换为 Mintlify 的页面、导航、组件、API 参考、资源和重定向。" +description: "当你当前的文档平台不受抓取工具支持或站点为私有时，按照本手动迁移指南将任意平台的文档内容转换到 Mintlify：收集并导出源内容、创建 Mintlify 项目、设计 docs.json 导航结构、转换页面与组件格式，并迁移 API 参考、图片资源和重定向规则。" keywords: ["手动文档迁移", "Markdown 迁移", "MDX 迁移", "docs.json"] --- diff --git a/zh/migration/readme.mdx b/zh/migration/readme.mdx index 009d38a265..78d30eff4b 100644 --- a/zh/migration/readme.mdx +++ b/zh/migration/readme.mdx @@ -1,6 +1,6 @@ --- title: "从 ReadMe 迁移" -description: "将 ReadMe 指南、API 参考、recipes、自定义页面、版本、可复用内容和资源迁移到 Mintlify。" +description: "了解如何将 ReadMe 项目迁移到 Mintlify：使用抓取工具快速转换公开站点，或通过 ZIP 导出、GitHub 导出与 ReadMe API 获取私有内容和托管图片，本指南涵盖 guides、API 参考、recipes、自定义页面、多版本文档与静态资源的完整迁移步骤。" keywords: ["ReadMe 迁移", "ReadMe 到 Mintlify", "ReadMe 导出", "rdme"] --- diff --git a/zh/optimize/feedback.mdx b/zh/optimize/feedback.mdx index c75f3d9ac0..5822e0044c 100644 --- a/zh/optimize/feedback.mdx +++ b/zh/optimize/feedback.mdx @@ -1,6 +1,6 @@ --- title: "收集来自用户和 AI 智能体的页面反馈" -description: "启用反馈小部件、页面评分、上下文备注、代码片段反应以及智能体反馈，帮助你发现并修复文档中的问题。" +description: "了解如何在 Mintlify 文档中收集来自用户与 AI 智能体的页面反馈：从控制台的 Add-ons 页面启用点赞点踩评分、编辑建议、上下文备注、代码块反应等多种反馈类型，并在控制台的分析页面查看定量与定性数据，识别表现优秀的内容、确定改进优先级并采取更新行动。" 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..df8dbd18e3 100644 --- a/zh/optimize/pdf-exports.mdx +++ b/zh/optimize/pdf-exports.mdx @@ -1,6 +1,6 @@ --- title: "导出 PDF" -description: "将整个文档站点导出为带有可导航目录的单个 PDF 文件，便于离线阅读、分享和打印。" +description: "了解如何使用 Mintlify 企业方案的 PDF 导出功能，将整个文档站点或选定页面导出为带可导航目录的单个 PDF 文件：在控制台 Exports 页面自定义页面大小、缩放比例、页脚页码与导出语言等选项，导出完成后通过邮件获取下载链接，便于离线阅读与分享。" keywords: ["PDF", "离线文档"] --- diff --git a/zh/optimize/search.mdx b/zh/optimize/search.mdx index efa6a09bbf..fe9787a2ef 100644 --- a/zh/optimize/search.mdx +++ b/zh/optimize/search.mdx @@ -1,7 +1,7 @@ --- title: "配置站内搜索的排名、结果和筛选器" sidebarTitle: "搜索" -description: "配置你的 Mintlify 文档站点上的站内搜索栏：排名加权、每次查询的最大结果数，以及按产品和版本进行的搜索筛选器。" +description: "配置 Mintlify 文档站点的站内搜索行为：在页面 frontmatter 或 docs.json 导航分组中使用 boost 设置搜索排名加权、用小于 1 的值降低内容优先级、限制每次查询的最大结果数，并按产品和版本添加搜索筛选器，帮助读者更快找到相关内容。" keywords: ["搜索", "搜索排名", "搜索加权", "加权", "搜索优先级", "最大搜索结果数", "最大结果数", "searchable", "从搜索中排除", "筛选器"] --- diff --git a/zh/optimize/seo.mdx b/zh/optimize/seo.mdx index d304201403..2389716335 100644 --- a/zh/optimize/seo.mdx +++ b/zh/optimize/seo.mdx @@ -1,6 +1,6 @@ --- title: "SEO（搜索引擎优化）" -description: "配置元标签、Open Graph 属性、规范 URL 和页面级 SEO 设置，提升文档在搜索引擎中的排名。" +description: "了解 Mintlify 自动处理的 SEO 最佳实践，包括元标签生成、站点地图与 robots.txt 文件、语义化 HTML 和移动端优化，并学习如何通过 docs.json 或页面 frontmatter 自定义 meta 标签、Open Graph 属性和规范 URL，提升文档在搜索引擎中的排名。" 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..11573d846d 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 隐藏页面的实际示例，不出现在 docs.json 导航中、只能通过 URL 直接访问。页面展示隐藏页面的常见用例，包括 Beta 功能文档、供 AI 工具引用的上下文文件、旧版内容存档和内部工具参考，并附有可直接套用的 frontmatter 示例代码。" --- 这是一个隐藏页面。它不会出现在 `docs.json` 的导航中，因此你只能通过其 URL 访问。 diff --git a/zh/organize/hidden-pages.mdx b/zh/organize/hidden-pages.mdx index 88dc0eba03..bfa89eab28 100644 --- a/zh/organize/hidden-pages.mdx +++ b/zh/organize/hidden-pages.mdx @@ -1,6 +1,6 @@ --- title: "隐藏页面" -description: "将文档页面从侧边栏导航中隐藏，同时仍可通过直接 URL、站内搜索或 AI 助手访问，适用于内部参考、AI 上下文等特殊场景。" +description: "了解如何在 Mintlify 中创建隐藏页面：通过 frontmatter 设置 hidden: true 或从 docs.json 导航中移除页面，使其不出现在侧边栏但仍可通过直接 URL 访问，适合内部参考与 AI 上下文等场景，并了解隐藏与私密的区别以及配置认证的访问控制方法。" keywords: ["从导航中隐藏", "未列出", "页面可见性"] --- diff --git a/zh/organize/mintignore.mdx b/zh/organize/mintignore.mdx index 31d6f8afbc..d69b23216a 100644 --- a/zh/organize/mintignore.mdx +++ b/zh/organize/mintignore.mdx @@ -1,7 +1,7 @@ --- title: "从发布中排除文件" sidebarTitle: "排除文件" -description: "使用带有 glob 模式的 .mintignore 文件将特定文件和目录排除在已发布文档之外，语法类似 .gitignore。" +description: "了解如何使用 .mintignore 文件将草稿、内部笔记等特定文件和目录排除在 Mintlify 已发布文档之外。该文件采用与 .gitignore 相同的 glob 模式匹配语法，本页涵盖文件创建方法、被排除文件的行为、默认忽略的目录列表以及常见匹配模式语法示例。" keywords: ["排除", "忽略", "gitignore", "草稿", "私有"] --- diff --git a/zh/organize/navigation.mdx b/zh/organize/navigation.mdx index 1a5deb329e..2f57434d53 100644 --- a/zh/organize/navigation.mdx +++ b/zh/organize/navigation.mdx @@ -1,6 +1,6 @@ --- title: "导航" -description: "在 docs.json 中使用分组、页面、下拉菜单、标签页和锚点配置文档站点导航，构建侧边栏结构。" +description: "了解如何在 docs.json 的 navigation 属性中构建 Mintlify 文档站点的侧边栏结构与信息层级：比较分组、选项卡、锚点、下拉菜单、产品、版本和语言等各主要导航方式的适用场景与示例，并学习如何选择一种主要组织方式并在其中嵌套其他导航元素。" keywords: ["导航结构", "侧边栏配置", "页面组织", "导航分组"] boost: 3 --- diff --git a/zh/organize/related-pages.mdx b/zh/organize/related-pages.mdx index e69ee266fd..db7a2e7def 100644 --- a/zh/organize/related-pages.mdx +++ b/zh/organize/related-pages.mdx @@ -1,6 +1,6 @@ --- title: "相关页面" -description: "使用自动推荐或在页面 frontmatter 中手动整理的链接，在每个页面底部添加“相关主题”版块。" +description: "了解如何在 Mintlify 文档每个页面底部添加相关主题版块：在控制台 Add-ons 中启用相关页面功能，选择基于搜索索引的自动推荐或完全手动整理的模式，设置推荐显示数量上限，并通过 related frontmatter 字段按页覆盖推荐链接或隐藏该版块。" keywords: ["相关", "相关页面", "相关主题", "推荐", "frontmatter"] --- diff --git a/zh/organize/settings-api.mdx b/zh/organize/settings-api.mdx index a5a0325dbd..7b828780f4 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 中 api 字段的配置参考：设置 OpenAPI 与 AsyncAPI 规范文件的路径、URL 或搜索目录来生成 Mintlify API 参考页面，配置用于测试端点的交互式 API 演练场，并控制 SDK 代码示例的生成方式与身份验证设置，附各属性类型与 JSON 示例。" keywords: ["api", "openapi", "asyncapi", "演练场", "docs.json", "api 参考"] --- diff --git a/zh/organize/settings-appearance.mdx b/zh/organize/settings-appearance.mdx index c488a1bd51..74b1757878 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 中外观与品牌设置的参考文档：配置 Mintlify 站点的布局主题、项目名称、主色与深浅色模式强调色、logo、favicon、字体和背景等视觉标识选项，包含各字段的类型、必需性说明与十六进制颜色代码示例，让文档站点与你的产品品牌保持一致。" keywords: ["主题", "颜色", "logo", "favicon", "字体", "背景", "外观", "品牌", "深色模式", "图标", "样式", "docs.json"] --- diff --git a/zh/organize/settings-integrations.mdx b/zh/organize/settings-integrations.mdx index d7ee15971b..89ce054bc0 100644 --- a/zh/organize/settings-integrations.mdx +++ b/zh/organize/settings-integrations.mdx @@ -1,6 +1,6 @@ --- title: "集成" -description: "通过 docs.json 中的集成配置，将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。" +description: "docs.json 中 integrations 字段的配置参考：将 Google Analytics、PostHog、Amplitude、Segment、Clarity 等分析平台以及聊天小部件和其他第三方服务连接到 Mintlify 文档站点，并附每项集成所需的 API key、测量 ID 等参数说明。" 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 4378b6cb9d..4b60d5c460 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 schema 的完整参考页面，以快速参考表列出 Mintlify 全部配置属性的类型、默认值与必需性说明，介绍如何通过 $schema 引用在编辑器中获得校验和自动补全，并链接到外观、站点结构、API、集成与 SEO 搜索等各设置主题的详细页面。" keywords: ["docs.json", "schema", "参考", "配置", "所有设置", "属性", "完整"] --- diff --git a/zh/organize/settings-seo.mdx b/zh/organize/settings-seo.mdx index 55f1af69b3..cae9453f10 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 和搜索设置的参考文档：配置 Mintlify 站点描述、搜索引擎索引范围（seo.indexing 的 navigable 与 all 选项）、添加到每个页面的自定义 meta 标签、搜索栏占位符文本与页面最后修改时间戳，控制文档在搜索结果中的呈现方式。" keywords: ["SEO", "搜索", "索引", "meta 标签", "描述", "时间戳", "最后修改", "docs.json"] --- diff --git a/zh/organize/settings-structure.mdx b/zh/organize/settings-structure.mdx index 9d9f088743..5cae17e074 100644 --- a/zh/organize/settings-structure.mdx +++ b/zh/organize/settings-structure.mdx @@ -1,6 +1,6 @@ --- title: "站点结构" -description: "在 docs.json 中配置导航栏、页脚、横幅、重定向和其他结构设置。" +description: "docs.json 中站点结构设置的参考文档：配置 Mintlify 文档的 navigation 导航结构、navbar 导航栏、页脚、横幅公告、上下文菜单、重定向规则与全局内容变量，控制站点的信息架构、页面层次结构和整体用户体验，附各字段的类型与配置说明。" keywords: ["导航栏", "导航", "页脚", "横幅", "上下文", "重定向", "变量", "元数据", "docs.json"] --- diff --git a/zh/organize/settings.mdx b/zh/organize/settings.mdx index e00878468d..ee88d92cb9 100644 --- a/zh/organize/settings.mdx +++ b/zh/organize/settings.mdx @@ -1,6 +1,6 @@ --- title: "全局设置" -description: "使用 docs.json 配置你的 Mintlify 文档站点，该文件控制导航、外观和集成。" +description: "docs.json 是 Mintlify 文档站点的核心配置文件，控制导航结构、视觉品牌、集成与 API 设置等全局选项。本页介绍该文件在仓库中的位置、name、theme、colors 和 navigation 四个必需字段，以及带 $schema 校验与自动补全的最小配置示例。" keywords: ["docs.json", "配置", "设置", "mint.json"] --- diff --git a/zh/poc-onboarding.mdx b/zh/poc-onboarding.mdx index d5139aae2c..7ba2e14fbf 100644 --- a/zh/poc-onboarding.mdx +++ b/zh/poc-onboarding.mdx @@ -1,6 +1,6 @@ --- title: "POC 入门指南" -description: "设置并评估 Mintlify 概念验证（POC），从连接仓库到审查发布、AI 和安全工作流。" +description: "Mintlify 概念验证（POC）入门指南：按步骤连接文档仓库并部署入门站点、邀请团队成员、添加具有代表性的示例内容、发布一次更改以验证写作与审查工作流、应用品牌样式并测试 AI 助手等功能，最后将结果与成功标准对比，帮助你的团队完整评估 Mintlify。" keywords: ["POC", "概念验证", "试用", "评估", "企业入门", "试点"] noindex: true --- diff --git a/zh/reference/concepts.mdx b/zh/reference/concepts.mdx index 3854647e24..0923d6640f 100644 --- a/zh/reference/concepts.mdx +++ b/zh/reference/concepts.mdx @@ -1,6 +1,6 @@ --- title: "核心概念" -description: "了解 Mintlify 如何连接你的组织、文档存储库、编辑工作流、部署以及 AI 功能。" +description: "了解 Mintlify 的核心概念与工作原理：组织、部署与在线站点之间的关系，文档存储库作为唯一数据源的角色，浏览器编辑器、本地开发环境与 Slack 中的 Mintlify agent 等编辑工作流，以及内容构建、发布流程和面向 AI 的各项功能如何协同运作。" keywords: ["核心概念", "Mintlify 的工作原理", "存储库", "部署", "发布", "AI"] --- diff --git a/zh/reference/glossary.mdx b/zh/reference/glossary.mdx index c0629da33f..864a725227 100644 --- a/zh/reference/glossary.mdx +++ b/zh/reference/glossary.mdx @@ -1,6 +1,6 @@ --- title: "术语表" -description: "查找 Mintlify 产品、内容、导航、部署、Git、API 和 AI 相关术语的定义。" +description: "Mintlify 术语表：按字母顺序查找产品、内容、导航、部署、Git、API 和 AI 相关术语的定义，涵盖 Admin MCP server、agent 代理、anchor 锚点、API playground 试验台等概念并链接到详细文档，是阅读 Mintlify 文档时的快速参考。" keywords: ["术语表", "术语", "定义", "词汇"] --- diff --git a/zh/search-index/connect.mdx b/zh/search-index/connect.mdx index b49fb63fd7..6db2a88c1c 100644 --- a/zh/search-index/connect.mdx +++ b/zh/search-index/connect.mdx @@ -1,7 +1,7 @@ --- title: "将 Mintlify Index 连接到你的编码代理" sidebarTitle: "连接" -description: "通过 CLI 或手动配置，在 Claude Code、Cursor、VS Code、Codex、OpenCode、Windsurf 或 Zed 中设置 Mintlify Index MCP 服务器。" +description: "了解如何将 Mintlify Index MCP 服务器连接到编码代理：运行 npx mint index 命令一步完成设置，或手动配置 Claude Code、Cursor、VS Code、Codex、OpenCode、Windsurf 和 Zed，让代理在编写代码时检索最新技术文档，无需 API key。" keywords: ["Mintlify Index", "CLI", "Claude Code", "Cursor", "MCP", "技术文档"] --- diff --git a/zh/search-index/index.mdx b/zh/search-index/index.mdx index 7ce9cdc7f0..b79f8a505e 100644 --- a/zh/search-index/index.mdx +++ b/zh/search-index/index.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify Index" sidebarTitle: "概览" -description: "通过一个 MCP 服务器或 REST API，为编码代理提供来自发布者维护的文档和 Web 的最新技术上下文。" +description: "Mintlify Index 概览：为编码代理提供统一的技术知识搜索层，将已索引产品的问题路由到发布者维护的文档，并用 Web 搜索处理其余问题。可通过无需 API key 的公开 MCP 服务器或受访问控制的 REST API 使用，本页介绍两种方式与入门资源。" keywords: ["Mintlify Index", "技术搜索", "编码代理", "MCP", "REST API"] --- diff --git a/zh/search-index/mcp.mdx b/zh/search-index/mcp.mdx index 6c4a14f15a..44af30ed98 100644 --- a/zh/search-index/mcp.mdx +++ b/zh/search-index/mcp.mdx @@ -1,7 +1,7 @@ --- title: "Mintlify Index MCP 服务器" sidebarTitle: "MCP 参考" -description: "公开 Mintlify Index MCP 服务器的参考文档：连接 URL、context 工具、参数、响应格式、速率限制和使用示例。" +description: "Mintlify Index MCP 服务器的参考文档：介绍 index.mintlify.com 连接地址与无需认证的公开访问方式，详细说明 context 工具的 query、product、域名筛选与 tokenBudget 等参数、响应格式、速率限制，以及在编码代理中的使用示例。" keywords: ["Mintlify Index", "MCP 服务器", "context 工具", "速率限制"] --- diff --git a/zh/status.mdx b/zh/status.mdx index 3e5857c8b6..f93444173b 100644 --- a/zh/status.mdx +++ b/zh/status.mdx @@ -1,6 +1,6 @@ --- title: "状态页面" -description: "查看 Mintlify 实时服务状态、浏览事故历史记录，并订阅服务中断和维护窗口的电子邮件通知。" +description: "了解如何使用 Mintlify 状态页面：在 status.mintlify.com 查看 Documentation、Updates 和 Dashboard 各项服务的实时运行状态与历史可用性数据，订阅电子邮件、RSS 或 Slack 通知以获取事故与维护窗口更新，并了解如何报告未列出的问题。" --- Mintlify 维护了一个公开的状态页面，您可以在此查看其服务的实时运行状态，并查看历史可用性数据。