mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
d5f4b8ea73
* Update settings/custom-404-page.mdx * Update docs.json * add icon * move to guides * copy edit * remove duplicate example * consolidate best practices in the intro * change heading level --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
548 lines
16 KiB
JSON
548 lines
16 KiB
JSON
{
|
|
"$schema": "https://mintlify.com/docs.json",
|
|
"theme": "maple",
|
|
"name": "Mintlify",
|
|
"colors": {
|
|
"primary": "#0D9373",
|
|
"light": "#55D799",
|
|
"dark": "#0D9373"
|
|
},
|
|
"favicon": "/favicon.ico",
|
|
"icons": {
|
|
"library": "lucide"
|
|
},
|
|
"navigation": {
|
|
"dropdowns": [
|
|
{
|
|
"dropdown": "Documentation",
|
|
"icon": "book",
|
|
"description": "Set up your documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Getting started",
|
|
"pages": [
|
|
"index",
|
|
"quickstart",
|
|
"installation",
|
|
{
|
|
"group": "Web editor",
|
|
"icon": "mouse-pointer-2",
|
|
"pages": [
|
|
"editor/getting-started",
|
|
"editor/git-concepts",
|
|
"editor/branches",
|
|
"editor/content-management",
|
|
"editor/publishing",
|
|
"editor/keyboard-shortcuts",
|
|
"editor/troubleshooting"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Core configuration",
|
|
"pages": [
|
|
"settings",
|
|
"pages",
|
|
"navigation",
|
|
"themes",
|
|
"settings/custom-domain"
|
|
]
|
|
},
|
|
{
|
|
"group": "AI optimization",
|
|
"pages": [
|
|
"guides/assistant",
|
|
"ai/llmstxt",
|
|
"ai/contextual-menu",
|
|
"ai/model-context-protocol",
|
|
"ai/markdown-export",
|
|
"guides/geo",
|
|
"guides/claude-code",
|
|
"guides/cursor",
|
|
"guides/windsurf",
|
|
"ai/slack-app"
|
|
]
|
|
},
|
|
{
|
|
"group": "Components",
|
|
"pages": [
|
|
"text",
|
|
"image-embeds",
|
|
"list-table",
|
|
"code",
|
|
"reusable-snippets",
|
|
"components/accordions",
|
|
"components/callouts",
|
|
"components/cards",
|
|
"components/columns",
|
|
"components/code-groups",
|
|
"components/examples",
|
|
"components/expandables",
|
|
"components/fields",
|
|
"components/frames",
|
|
"components/icons",
|
|
"components/mermaid-diagrams",
|
|
"components/panel",
|
|
"components/steps",
|
|
"components/tabs",
|
|
"components/tooltips",
|
|
"components/update",
|
|
"components/banner"
|
|
]
|
|
},
|
|
{
|
|
"group": "API pages",
|
|
"pages": [
|
|
"api-playground/overview",
|
|
"api-playground/openapi-setup",
|
|
"api-playground/migrating-from-mdx",
|
|
{
|
|
"group": "Customization",
|
|
"icon": "wrench",
|
|
"pages": [
|
|
"api-playground/customization/complex-data-types",
|
|
"api-playground/customization/adding-sdk-examples",
|
|
"api-playground/customization/managing-page-visibility",
|
|
"api-playground/customization/multiple-responses"
|
|
]
|
|
},
|
|
{
|
|
"group": "AsyncAPI",
|
|
"icon": "webhook",
|
|
"pages": [
|
|
"api-playground/asyncapi/setup",
|
|
"api-playground/asyncapi/playground"
|
|
]
|
|
},
|
|
{
|
|
"group": "MDX",
|
|
"icon": "markdown",
|
|
"pages": [
|
|
"api-playground/mdx/configuration",
|
|
"api-playground/mdx/authentication"
|
|
]
|
|
},
|
|
"api-playground/troubleshooting"
|
|
]
|
|
},
|
|
{
|
|
"group": "Authentication and personalization",
|
|
"pages": [
|
|
"authentication-personalization/authentication-setup",
|
|
"authentication-personalization/personalization-setup"
|
|
]
|
|
},
|
|
{
|
|
"group": "Guides",
|
|
"pages": [
|
|
"guides/migration",
|
|
"guides/analytics",
|
|
"react-components",
|
|
"settings/custom-scripts",
|
|
"settings/seo",
|
|
"guides/changelogs",
|
|
"guides/hidden-pages",
|
|
"settings/broken-links",
|
|
"settings/custom-404-page",
|
|
"guides/monorepo",
|
|
{
|
|
"group": "Custom Subdirectory",
|
|
"icon": "folder",
|
|
"pages": [
|
|
"advanced/subpath/cloudflare",
|
|
"advanced/subpath/route53-cloudfront",
|
|
"advanced/subpath/vercel",
|
|
"guides/csp-configuration"
|
|
]
|
|
},
|
|
{
|
|
"group": "Dashboard Access",
|
|
"icon": "gauge",
|
|
"pages": [
|
|
"advanced/dashboard/sso",
|
|
"advanced/dashboard/permissions",
|
|
"advanced/dashboard/roles"
|
|
]
|
|
},
|
|
"guides/deployments",
|
|
"contact-support"
|
|
]
|
|
},
|
|
{
|
|
"group": "Integrations",
|
|
"pages": [
|
|
{
|
|
"group": "Analytics",
|
|
"icon": "chart-no-axes-combined",
|
|
"pages": [
|
|
"integrations/analytics/overview",
|
|
"integrations/analytics/amplitude",
|
|
"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/koala",
|
|
"integrations/analytics/logrocket",
|
|
"integrations/analytics/mixpanel",
|
|
"integrations/analytics/pirsch",
|
|
"integrations/analytics/plausible",
|
|
"integrations/analytics/posthog",
|
|
"integrations/analytics/segment"
|
|
]
|
|
},
|
|
{
|
|
"group": "SDKs",
|
|
"icon": "folder-code",
|
|
"pages": [
|
|
"integrations/sdks/speakeasy",
|
|
"integrations/sdks/stainless"
|
|
]
|
|
},
|
|
{
|
|
"group": "Support",
|
|
"icon": "messages-square",
|
|
"pages": [
|
|
"integrations/support/overview",
|
|
"integrations/support/intercom",
|
|
"integrations/support/front"
|
|
]
|
|
},
|
|
{
|
|
"group": "Privacy",
|
|
"icon": "folder-lock",
|
|
"pages": [
|
|
"integrations/privacy/overview",
|
|
"integrations/privacy/osano"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"group": "Version control and CI/CD",
|
|
"pages": [
|
|
"settings/github",
|
|
"settings/gitlab",
|
|
"settings/ci",
|
|
"settings/preview-deployments"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"dropdown": "API Reference",
|
|
"description": "Reference for the API",
|
|
"icon": "terminal",
|
|
"groups": [
|
|
{
|
|
"group": "API Reference",
|
|
"pages": [
|
|
"api-reference/introduction"
|
|
]
|
|
},
|
|
{
|
|
"group": "Admin",
|
|
"pages": [
|
|
"api-reference/update/trigger",
|
|
"api-reference/update/status"
|
|
]
|
|
},
|
|
{
|
|
"group": "Assistant",
|
|
"pages": [
|
|
"api-reference/assistant/create-assistant-message",
|
|
"api-reference/assistant/search"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"dropdown": "Changelog",
|
|
"icon": "history",
|
|
"description": "Updates and changes",
|
|
"groups": [
|
|
{
|
|
"group": "Changelog",
|
|
"pages": [
|
|
"changelog"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"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"
|
|
}
|
|
},
|
|
"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": "Customers",
|
|
"href": "https://mintlify.com/customers"
|
|
},
|
|
{
|
|
"label": "Blog",
|
|
"href": "https://mintlify.com/blog"
|
|
},
|
|
{
|
|
"label": "Pricing",
|
|
"href": "https://www.mintlify.com/pricing"
|
|
},
|
|
{
|
|
"label": "Guides",
|
|
"href": "https://www.mintlify.com/guides"
|
|
},
|
|
{
|
|
"label": "Feature Requests",
|
|
"href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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",
|
|
"chatgpt",
|
|
"claude",
|
|
"cursor",
|
|
"vscode"
|
|
]
|
|
},
|
|
"redirects": [
|
|
{
|
|
"source": "/content/components/accordions",
|
|
"destination": "/components/accordions"
|
|
},
|
|
{
|
|
"source": "/content/components/callouts",
|
|
"destination": "/components/callouts"
|
|
},
|
|
{
|
|
"source": "/content/components/cards",
|
|
"destination": "/components/cards"
|
|
},
|
|
{
|
|
"source": "/content/components/card-groups",
|
|
"destination": "/components/columns"
|
|
},
|
|
{
|
|
"source": "/content/components/code-groups",
|
|
"destination": "/components/code-groups"
|
|
},
|
|
{
|
|
"source": "/content/components/examples",
|
|
"destination": "/components/examples"
|
|
},
|
|
{
|
|
"source": "/content/components/expandables",
|
|
"destination": "/components/expandables"
|
|
},
|
|
{
|
|
"source": "/content/components/fields",
|
|
"destination": "/components/fields"
|
|
},
|
|
{
|
|
"source": "/content/components/frames",
|
|
"destination": "/components/frames"
|
|
},
|
|
{
|
|
"source": "/content/components/icons",
|
|
"destination": "/components/icons"
|
|
},
|
|
{
|
|
"source": "/content/components/mermaid-diagrams",
|
|
"destination": "/components/mermaid-diagrams"
|
|
},
|
|
{
|
|
"source": "/content/components/steps",
|
|
"destination": "/components/steps"
|
|
},
|
|
{
|
|
"source": "/content/components/tabs",
|
|
"destination": "/components/tabs"
|
|
},
|
|
{
|
|
"source": "/content/components/tooltips",
|
|
"destination": "/components/tooltips"
|
|
},
|
|
{
|
|
"source": "/content/components/update",
|
|
"destination": "/components/update"
|
|
},
|
|
{
|
|
"source": "/api-playground/openapi/advanced-features",
|
|
"destination": "/api-playground/customization"
|
|
},
|
|
{
|
|
"source": "/api-playground/openapi/setup",
|
|
"destination": "/api-playground/openapi-setup"
|
|
},
|
|
{
|
|
"source": "/api-playground/openapi/writing-openapi",
|
|
"destination": "/api-playground/openapi-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication-vs-personalization",
|
|
"destination": "authentication-personalization/overview"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication-setup/choosing-a-handshake",
|
|
"destination": "authentication-personalization/overview"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/personalization-setup/choosing-a-handshake",
|
|
"destination": "authentication-personalization/overview"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/personalization",
|
|
"destination": "authentication-personalization/personalization-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/partial-authentication",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/sending-data",
|
|
"destination": "authentication-personalization/personalization-setup"
|
|
},
|
|
{
|
|
"source": "authentication-personalization/partial-authentication-setup",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "authentication-personalization/sending-data",
|
|
"destination": "authentication-personalization/personalization-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication-setup/jwt",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication-setup/oauth",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication-setup/mintlify",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/authentication-setup/password",
|
|
"destination": "authentication-personalization/authentication-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/personalization-setup/jwt",
|
|
"destination": "authentication-personalization/personalization-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/personalization-setup/oauth",
|
|
"destination": "authentication-personalization/personalization-setup"
|
|
},
|
|
{
|
|
"source": "settings/authentication-personalization/personalization-setup/shared-session",
|
|
"destination": "authentication-personalization/personalization-setup"
|
|
},
|
|
{
|
|
"source": "ai-ingestion",
|
|
"destination": "ai/llmstxt"
|
|
},
|
|
{
|
|
"source": "api-reference/chat/*",
|
|
"destination": "api-reference/assistant/*"
|
|
},
|
|
{
|
|
"source": "editor",
|
|
"destination": "editor/getting-started"
|
|
}
|
|
],
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-RCYWHL7EQ7"
|
|
},
|
|
"koala": {
|
|
"publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
|
|
}
|
|
}
|
|
}
|