mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
04ed35e256
* docs: update static export API to projectId-scoped 2-step flow * docs: language-prefix internal links and wrap translated headings * docs: update static export example bundle URLs to mintlify-static-export-outputs-prod --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
738 lines
23 KiB
JSON
738 lines
23 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "luma",
|
|
"name": "Mintlify",
|
|
"description": "Mintlify is a platform for building and hosting documentation websites. It provides a set of tools and services for maintaining documentation and making it accessible to AI agents.",
|
|
"colors": {
|
|
"primary": "#166E3F",
|
|
"light": "#26BD6C",
|
|
"dark": "#166E3F"
|
|
},
|
|
"favicon": {
|
|
"light": "/favicon.ico",
|
|
"dark": "/favicon.ico"
|
|
},
|
|
"icons": {
|
|
"library": "lucide"
|
|
},
|
|
"interaction": {
|
|
"drilldown": false
|
|
},
|
|
"navigation": {
|
|
"languages": [
|
|
{
|
|
"tabs": [
|
|
{
|
|
"tab": "Documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Get started",
|
|
"boost": 2,
|
|
"pages": [
|
|
"index",
|
|
"quickstart",
|
|
"ai-native",
|
|
{
|
|
"group": "CLI",
|
|
"root": "cli/index",
|
|
"pages": [
|
|
"cli/install",
|
|
"cli/preview",
|
|
"cli/commands"
|
|
]
|
|
},
|
|
{
|
|
"group": "Migrate to Mintlify",
|
|
"root": "migration/index",
|
|
"pages": [
|
|
"migration/docusaurus",
|
|
"migration/readme",
|
|
"migration/gitbook",
|
|
"migration/fern",
|
|
"migration/document360",
|
|
"migration/manual"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Create content",
|
|
"pages": [
|
|
{
|
|
"group": "Pages",
|
|
"pages": [
|
|
"organize/pages",
|
|
"organize/hidden-pages",
|
|
"organize/related-pages"
|
|
]
|
|
},
|
|
{
|
|
"group": "Formatting",
|
|
"pages": [
|
|
"create/text",
|
|
"create/code",
|
|
"create/list-table"
|
|
]
|
|
},
|
|
{
|
|
"group": "Components",
|
|
"root": "components/index",
|
|
"pages": [
|
|
"components/accordions",
|
|
"components/badge",
|
|
"components/banner",
|
|
"components/callouts",
|
|
"components/cards",
|
|
"components/code-groups",
|
|
"components/color",
|
|
"components/columns",
|
|
"components/examples",
|
|
"components/expandables",
|
|
"components/fields",
|
|
"components/frames",
|
|
"components/github",
|
|
"components/icons",
|
|
"components/mermaid-diagrams",
|
|
"components/panel",
|
|
"components/prompt",
|
|
"components/responses",
|
|
"components/steps",
|
|
"components/tabs",
|
|
"components/tiles",
|
|
"components/tooltips",
|
|
"components/tree",
|
|
"components/update",
|
|
"components/view",
|
|
"components/visibility",
|
|
"customize/react-components"
|
|
]
|
|
},
|
|
{
|
|
"group": "Media",
|
|
"pages": [
|
|
"create/image-embeds",
|
|
"create/files"
|
|
]
|
|
},
|
|
"create/reusable-snippets",
|
|
"create/personalization",
|
|
{
|
|
"group": "Editor",
|
|
"root": "editor/index",
|
|
"pages": [
|
|
"editor/tutorial",
|
|
"editor/git-essentials",
|
|
"editor/pages",
|
|
"editor/navigation",
|
|
"editor/live-preview",
|
|
"editor/branching-and-publishing",
|
|
"editor/comments",
|
|
"editor/suggestions",
|
|
"editor/agent",
|
|
"editor/configurations",
|
|
"editor/settings",
|
|
"editor/keyboard-shortcuts"
|
|
]
|
|
},
|
|
"deploy/ci"
|
|
]
|
|
},
|
|
{
|
|
"group": "Manage your site",
|
|
"pages": [
|
|
{
|
|
"group": "Global settings",
|
|
"root": "organize/settings",
|
|
"pages": [
|
|
"organize/settings-appearance",
|
|
"organize/settings-structure",
|
|
"organize/settings-api",
|
|
"organize/settings-integrations",
|
|
"organize/settings-seo",
|
|
"organize/settings-reference"
|
|
]
|
|
},
|
|
"organize/navigation",
|
|
"ai/contextual-menu",
|
|
"create/redirects",
|
|
"organize/mintignore",
|
|
{
|
|
"group": "Repository setup",
|
|
"pages": [
|
|
"deploy/monorepo",
|
|
"deploy/multi-repo"
|
|
]
|
|
},
|
|
{
|
|
"group": "Visual customization",
|
|
"pages": [
|
|
"customize/themes",
|
|
"customize/fonts",
|
|
"customize/custom-scripts",
|
|
"customize/custom-404-page"
|
|
]
|
|
},
|
|
{
|
|
"group": "Analytics",
|
|
"root": "analytics/index",
|
|
"pages": [
|
|
"analytics/traffic",
|
|
"analytics/assistant",
|
|
"analytics/search",
|
|
"analytics/user-engagements",
|
|
"optimize/feedback",
|
|
"analytics/export",
|
|
"analytics/streaming"
|
|
]
|
|
},
|
|
{
|
|
"group": "Deployments",
|
|
"root": "deploy/deployments",
|
|
"pages": [
|
|
"deploy/preview-deployments",
|
|
"deploy/github",
|
|
"deploy/ghes",
|
|
"deploy/gitlab",
|
|
"deploy/bitbucket"
|
|
]
|
|
},
|
|
{
|
|
"group": "Hosting",
|
|
"root": "customize/custom-domain",
|
|
"pages": [
|
|
{
|
|
"group": "Subpath hosting",
|
|
"root": "deploy/docs-subpath",
|
|
"pages": [
|
|
"deploy/cloudflare",
|
|
"deploy/route53-cloudfront",
|
|
"deploy/vercel",
|
|
"deploy/vercel-external-proxies",
|
|
"deploy/reverse-proxy"
|
|
]
|
|
},
|
|
"deploy/csp-configuration",
|
|
"deploy/self-host",
|
|
"deploy/custom-portal"
|
|
]
|
|
},
|
|
{
|
|
"group": "Export your site",
|
|
"pages": [
|
|
"deploy/export",
|
|
"optimize/pdf-exports"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication",
|
|
"root": "deploy/authentication-setup",
|
|
"pages": [
|
|
"dashboard/sso",
|
|
"dashboard/scim",
|
|
"dashboard/session-security"
|
|
]
|
|
},
|
|
{
|
|
"group": "Security",
|
|
"pages": [
|
|
"dashboard/network-access",
|
|
"dashboard/roles",
|
|
"dashboard/audit-logs",
|
|
"dashboard/security-contact"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Agent",
|
|
"pages": [
|
|
"agent/index",
|
|
"agent/slack",
|
|
{
|
|
"group": "Automations",
|
|
"root": "automations/index",
|
|
"pages": [
|
|
"automations/create",
|
|
"automations/manage",
|
|
"automations/integrations",
|
|
"automations/reference",
|
|
"deploy/gitlab-self-hosted"
|
|
]
|
|
},
|
|
"agent/customize",
|
|
"agent/effective-prompts",
|
|
"agent/use-cases"
|
|
]
|
|
},
|
|
{
|
|
"group": "Assistant",
|
|
"pages": [
|
|
"assistant/index",
|
|
"assistant/configure",
|
|
"assistant/customize",
|
|
"assistant/widget",
|
|
"assistant/skills",
|
|
"assistant/use"
|
|
]
|
|
},
|
|
{
|
|
"group": "Agent-ready content",
|
|
"pages": [
|
|
"ai/mintlify-mcp",
|
|
{
|
|
"group": "Mintlify Index",
|
|
"root": "search-index/index",
|
|
"pages": [
|
|
"search-index/connect",
|
|
"search-index/mcp"
|
|
]
|
|
},
|
|
"ai/model-context-protocol",
|
|
"ai/llmstxt",
|
|
"ai/skillmd",
|
|
"ai/markdown-export"
|
|
]
|
|
},
|
|
{
|
|
"group": "Search and SEO",
|
|
"pages": [
|
|
"optimize/search",
|
|
"optimize/seo"
|
|
]
|
|
},
|
|
{
|
|
"group": "Document APIs",
|
|
"pages": [
|
|
"api-playground/overview",
|
|
{
|
|
"group": "API specifications",
|
|
"pages": [
|
|
"api-playground/openapi-setup",
|
|
"api-playground/asyncapi-setup",
|
|
"api-playground/graphql-setup",
|
|
{
|
|
"group": "SDK reference setup",
|
|
"root": "api-playground/sdk-reference-setup",
|
|
"pages": [
|
|
"api-playground/adding-sdk-examples"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Endpoint pages",
|
|
"pages": [
|
|
"api-playground/complex-data-types",
|
|
"api-playground/multiple-responses",
|
|
"api-playground/managing-page-visibility",
|
|
"api-playground/mdx-setup"
|
|
]
|
|
},
|
|
"api-playground/troubleshooting"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
{
|
|
"group": "Analytics",
|
|
"root": "integrations/analytics/overview",
|
|
"pages": [
|
|
"integrations/analytics/adobe",
|
|
"integrations/analytics/amplitude",
|
|
"integrations/analytics/clarity",
|
|
"integrations/analytics/clearbit",
|
|
"integrations/analytics/fathom",
|
|
"integrations/analytics/google-analytics",
|
|
"integrations/analytics/google-tag-manager",
|
|
"integrations/analytics/heap",
|
|
"integrations/analytics/hightouch",
|
|
"integrations/analytics/hotjar",
|
|
"integrations/analytics/logrocket",
|
|
"integrations/analytics/mixpanel",
|
|
"integrations/analytics/pirsch",
|
|
"integrations/analytics/plausible",
|
|
"integrations/analytics/posthog",
|
|
"integrations/analytics/segment"
|
|
]
|
|
},
|
|
{
|
|
"group": "SDKs",
|
|
"pages": [
|
|
"integrations/sdks/speakeasy",
|
|
"integrations/sdks/stainless"
|
|
]
|
|
},
|
|
{
|
|
"group": "Support",
|
|
"root": "integrations/support/overview",
|
|
"pages": [
|
|
"integrations/support/intercom",
|
|
"integrations/support/front"
|
|
]
|
|
},
|
|
{
|
|
"group": "Privacy",
|
|
"root": "integrations/privacy/overview",
|
|
"pages": [
|
|
"integrations/privacy/osano",
|
|
"integrations/privacy/transcend"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Reference",
|
|
"pages": [
|
|
"reference/concepts",
|
|
"reference/glossary",
|
|
"credits"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "API reference",
|
|
"groups": [
|
|
{
|
|
"group": "API reference",
|
|
"pages": [
|
|
"api/introduction"
|
|
]
|
|
},
|
|
{
|
|
"group": "Admin",
|
|
"pages": [
|
|
"api/update/trigger",
|
|
"api/update/status",
|
|
"api/preview/trigger",
|
|
"api/automations/trigger"
|
|
]
|
|
},
|
|
{
|
|
"group": "Agent",
|
|
"pages": [
|
|
"api/agent/v2/create-agent-job",
|
|
"api/agent/v2/get-agent-job",
|
|
"api/agent/v2/send-message"
|
|
]
|
|
},
|
|
{
|
|
"group": "Assistant",
|
|
"pages": [
|
|
"api/assistant/create-assistant-message-v2"
|
|
]
|
|
},
|
|
{
|
|
"group": "Search",
|
|
"pages": [
|
|
"api/assistant/search",
|
|
"api/assistant/get-page-content"
|
|
]
|
|
},
|
|
{
|
|
"group": "Mintlify Index",
|
|
"pages": [
|
|
"api/search-index/introduction",
|
|
"api/search-index/context",
|
|
"api/search-index/search",
|
|
"api/search-index/contents"
|
|
]
|
|
},
|
|
{
|
|
"group": "Analytics",
|
|
"pages": [
|
|
"api/analytics/feedback",
|
|
"api/analytics/feedback-by-page",
|
|
"api/analytics/assistant-conversations",
|
|
"api/analytics/assistant-thread",
|
|
"api/analytics/assistant-caller-stats",
|
|
"api/analytics/searches",
|
|
"api/analytics/views",
|
|
"api/analytics/visitors"
|
|
]
|
|
},
|
|
{
|
|
"group": "Static export",
|
|
"pages": [
|
|
"api/static-export/start-job",
|
|
"api/static-export/get-job-status"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Changelog",
|
|
"groups": [
|
|
{
|
|
"group": "Changelog",
|
|
"boost": 0.5,
|
|
"pages": [
|
|
"changelog"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Help center",
|
|
"hidden": true,
|
|
"searchable": true,
|
|
"groups": [
|
|
{
|
|
"group": "Help center",
|
|
"pages": [
|
|
"help-center/openapi-url-fetch-fails-during-build",
|
|
"help-center/domain-already-claimed-by-another-organization",
|
|
"help-center/configure-oauth-with-auth0",
|
|
"help-center/private-repo-missing-when-creating-second-deployment",
|
|
"help-center/static-file-not-served"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tab": "Learn",
|
|
"menu": [
|
|
{
|
|
"item": "Learn",
|
|
"href": "https://learn.mintlify.com/",
|
|
"description": "Self-paced lessons to get the most from Mintlify."
|
|
},
|
|
{
|
|
"item": "Guides",
|
|
"description": "How to guides for common tasks and best practices.",
|
|
"groups": [
|
|
{
|
|
"group": "Overview",
|
|
"icon": "book-open",
|
|
"pages": [
|
|
"guides/index"
|
|
]
|
|
},
|
|
{
|
|
"group": "AI",
|
|
"icon": "bot",
|
|
"pages": [
|
|
"guides/assistant-embed",
|
|
"guides/configure-automerge",
|
|
"guides/use-automations",
|
|
"guides/claude-code",
|
|
"guides/codex",
|
|
"guides/cursor",
|
|
"guides/devin-desktop",
|
|
"guides/geo"
|
|
]
|
|
},
|
|
{
|
|
"group": "API docs",
|
|
"icon": "file-braces",
|
|
"pages": [
|
|
"guides/migrating-from-mdx"
|
|
]
|
|
},
|
|
{
|
|
"group": "Best practices",
|
|
"icon": "trophy",
|
|
"pages": [
|
|
"guides/accessibility",
|
|
"create/changelogs",
|
|
"guides/content-types",
|
|
"guides/content-templates",
|
|
"guides/custom-layouts",
|
|
"guides/improving-docs",
|
|
"guides/internationalization",
|
|
"guides/linking",
|
|
"guides/maintenance",
|
|
"guides/media",
|
|
"guides/navigation",
|
|
"guides/seo",
|
|
"guides/style-and-tone",
|
|
"guides/understand-your-audience"
|
|
]
|
|
},
|
|
{
|
|
"group": "Git",
|
|
"icon": "git-merge",
|
|
"pages": [
|
|
"guides/git-concepts",
|
|
"guides/branches"
|
|
]
|
|
},
|
|
{
|
|
"group": "Use cases",
|
|
"icon": "blocks",
|
|
"pages": [
|
|
"guides/developer-documentation",
|
|
"guides/knowledge-base",
|
|
"guides/help-center",
|
|
"guides/custom-frontend",
|
|
"api/static-export/overview"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"language": "en"
|
|
},
|
|
{
|
|
"$ref": "./fr.json"
|
|
},
|
|
{
|
|
"$ref": "./es.json"
|
|
},
|
|
{
|
|
"$ref": "./zh.json"
|
|
}
|
|
]
|
|
},
|
|
"logo": {
|
|
"light": "/logo/light.svg",
|
|
"dark": "/logo/dark.svg",
|
|
"href": "https://mintlify.com/docs"
|
|
},
|
|
"api": {
|
|
"mdx": {
|
|
"auth": {
|
|
"method": "bearer"
|
|
}
|
|
}
|
|
},
|
|
"navbar": {
|
|
"primary": {
|
|
"type": "button",
|
|
"label": "Get started",
|
|
"href": "https://mintlify.com/start"
|
|
},
|
|
"links": [
|
|
{
|
|
"label": "Talk to us",
|
|
"href": "https://mintlify.com/contact/sales"
|
|
}
|
|
]
|
|
},
|
|
"footer": {
|
|
"socials": {
|
|
"x": "https://x.com/mintlify",
|
|
"linkedin": "https://www.linkedin.com/company/mintlify",
|
|
"github": "https://github.com/mintlify"
|
|
},
|
|
"links": [
|
|
{
|
|
"header": "Explore",
|
|
"items": [
|
|
{
|
|
"label": "Startups",
|
|
"href": "https://www.mintlify.com/startups"
|
|
},
|
|
{
|
|
"label": "Enterprise",
|
|
"href": "https://www.mintlify.com/enterprise"
|
|
},
|
|
{
|
|
"label": "Switch",
|
|
"href": "https://www.mintlify.com/switch"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"header": "Resources",
|
|
"items": [
|
|
{
|
|
"label": "Learn",
|
|
"href": "https://learn.mintlify.com/"
|
|
},
|
|
{
|
|
"label": "Customers",
|
|
"href": "https://mintlify.com/customers"
|
|
},
|
|
{
|
|
"label": "Blog",
|
|
"href": "https://mintlify.com/blog"
|
|
},
|
|
{
|
|
"label": "Pricing",
|
|
"href": "https://www.mintlify.com/pricing"
|
|
},
|
|
{
|
|
"label": "Contact support",
|
|
"href": "https://www.mintlify.com/docs/contact-support"
|
|
},
|
|
{
|
|
"label": "Feature requests",
|
|
"href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
|
|
},
|
|
{
|
|
"label": "Status",
|
|
"href": "https://www.mintlify.com/docs/status"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"header": "Company",
|
|
"items": [
|
|
{
|
|
"label": "Careers",
|
|
"href": "https://mintlify.com/careers"
|
|
},
|
|
{
|
|
"label": "Wall of love",
|
|
"href": "https://www.mintlify.com/wall-of-love"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"header": "Legal",
|
|
"items": [
|
|
{
|
|
"label": "Privacy policy",
|
|
"href": "https://mintlify.com/legal/privacy"
|
|
},
|
|
{
|
|
"label": "Terms of Service",
|
|
"href": "https://mintlify.com/legal/terms"
|
|
},
|
|
{
|
|
"label": "Security",
|
|
"href": "https://security.mintlify.com/?_gl=1*ascm4x*_gcl_au*NTU1ODkzNjQ0LjE3NTQ5Mjg4NzIuMTgzMDQ5NTExMS4xNzU3NTQwMDk1LjE3NTc1NDAwOTQ."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"thumbnails": {
|
|
"background": "/images/thumbnail/background.svg"
|
|
},
|
|
"contextual": {
|
|
"options": [
|
|
"copy",
|
|
"download-spec",
|
|
"chatgpt",
|
|
"claude",
|
|
"add-mcp",
|
|
"cursor",
|
|
"vscode"
|
|
]
|
|
},
|
|
"redirects": {
|
|
"$ref": "./redirects.json"
|
|
},
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-RCYWHL7EQ7"
|
|
},
|
|
"posthog": {
|
|
"apiKey": "phc_eNuN6Ojnk9O7uWfC17z12AK85fNR0BY6IiGVy0Gfwzw"
|
|
}
|
|
},
|
|
"seo": {
|
|
"metatags": {
|
|
"canonical": "https://www.mintlify.com/docs",
|
|
"google-site-verification": "YRuJgIxsRnMkiRTYTo_tEsJSFyIE3AraEiukTbeV4Ag",
|
|
"og:locale": "en_US",
|
|
"twitter:site": "@mintlify"
|
|
}
|
|
}
|
|
}
|