Mintlify Setup

Mintlify

Available Resources

Docs

• Customize agent behavior: Configure how the agent handles documentation tasks with AGENTS.md.

  • URL: https://www.mintlify.com/docs/agent/customize.md

• Write effective prompts: Get better results from the agent with clear, focused prompts.

  • URL: https://www.mintlify.com/docs/agent/effective-prompts.md

• What is the agent?: Automate documentation updates with the agent. Create updates from Slack messages, PRs, or API calls.

  • URL: https://www.mintlify.com/docs/agent/index.md

• Quickstart: Start using the agent in your dashboard to create documentation updates.

  • URL: https://www.mintlify.com/docs/agent/quickstart.md

• Add the agent to Slack: Use the agent in Slack to make documentation updates from conversations and capture team knowledge.

  • URL: https://www.mintlify.com/docs/agent/slack.md

• Agent suggestions: Monitor Git repositories for changes and receive suggested documentation updates.

  • URL: https://www.mintlify.com/docs/agent/suggestions.md

• Use cases: Examples of using the agent in your documentation process.

  • URL: https://www.mintlify.com/docs/agent/use-cases.md

• AI-native documentation: Learn how AI enhances reading, writing, and discovering your documentation

  • URL: https://www.mintlify.com/docs/ai-native.md

• Assistant: Add AI-powered chat to your docs that answers questions, cites sources, and generates code examples.

  • URL: https://www.mintlify.com/docs/ai/assistant.md

• Contextual menu: Add one-click AI integrations to your docs.

  • URL: https://www.mintlify.com/docs/ai/contextual-menu.md

• Discord bot: Add a bot to your Discord server that answers questions based on your documentation.

  • URL: https://www.mintlify.com/docs/ai/discord.md

• llms.txt: Optimize your docs for LLMs to read and index.

  • URL: https://www.mintlify.com/docs/ai/llmstxt.md

• Markdown export: Quickly get Markdown versions of pages for AI tools and integrations.

  • URL: https://www.mintlify.com/docs/ai/markdown-export.md

• Model Context Protocol: Connect your documentation and API endpoints to AI tools with a hosted MCP server.

  • URL: https://www.mintlify.com/docs/ai/model-context-protocol.md

• skill.md: Make your docs agent-ready with a structured capability file.

  • URL: https://www.mintlify.com/docs/ai/skillmd.md

• Slack bot: Add a bot to your Slack workspace that answers questions based on your documentation.

  • URL: https://www.mintlify.com/docs/ai/slack-bot.md

• Add SDK examples: Display SDK code samples in your API documentation.

  • URL: https://www.mintlify.com/docs/api-playground/adding-sdk-examples.md

• AsyncAPI setup: Create websocket documentation with AsyncAPI specifications.

  • URL: https://www.mintlify.com/docs/api-playground/asyncapi-setup.md

• Complex data types: Describe APIs with flexible schemas, optional properties, and multiple data formats using oneOf, anyOf, and allOf keywords.

  • URL: https://www.mintlify.com/docs/api-playground/complex-data-types.md

• Manage page visibility: Control which API endpoints appear in your documentation navigation.

  • URL: https://www.mintlify.com/docs/api-playground/managing-page-visibility.md

• Create manual API pages: Document API endpoints manually with MDX files.

  • URL: https://www.mintlify.com/docs/api-playground/mdx-setup.md

• Multiple responses: Document multiple response variations for API endpoints.

  • URL: https://www.mintlify.com/docs/api-playground/multiple-responses.md

• OpenAPI setup: Generate API pages from your OpenAPI specification automatically.

  • URL: https://www.mintlify.com/docs/api-playground/openapi-setup.md

• Playground: Let developers test API endpoints directly in your documentation.

  • URL: https://www.mintlify.com/docs/api-playground/overview.md

• Troubleshooting: Resolve common issues with API page configuration.

  • URL: https://www.mintlify.com/docs/api-playground/troubleshooting.md

• Create agent job: Creates a new agent job that can generate and edit documentation based on provided messages and branch information.

  • URL: https://www.mintlify.com/docs/api/agent/create-agent-job.md

• Get agent job by ID: Retrieves the details and status of a specific agent job by its ID.

  • URL: https://www.mintlify.com/docs/api/agent/get-agent-job.md

• Get all agent jobs: Retrieves all agent jobs for the specified domain, including their status and details.

  • URL: https://www.mintlify.com/docs/api/agent/get-all-jobs.md

• Get assistant conversations: Returns paginated AI assistant conversation history

  • URL: https://www.mintlify.com/docs/api/analytics/assistant-conversations.md

• Get user feedback: Returns paginated user feedback with optional filtering

  • URL: https://www.mintlify.com/docs/api/analytics/feedback.md

• Assistant message: Generates a response message from the assistant for the specified domain. Compatible with AI SDK v5+.

  • URL: https://www.mintlify.com/docs/api/assistant/create-assistant-message-v2.md

• Search documentation: Perform semantic and keyword searches across your documentation with configurable filtering and pagination.

  • URL: https://www.mintlify.com/docs/api/assistant/search.md

• Introduction: Trigger updates, embed AI assistant, export analytics, and more

  • URL: https://www.mintlify.com/docs/api/introduction.md

• Get update status: Get the status of an update from the status ID

  • URL: https://www.mintlify.com/docs/api/update/status.md

• Trigger update: Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.

  • URL: https://www.mintlify.com/docs/api/update/trigger.md

• Accordions: Use accordions to show and hide content.

  • URL: https://www.mintlify.com/docs/components/accordions.md

• Badge: Use badges to highlight status, labels, or metadata inline or standalone.

  • URL: https://www.mintlify.com/docs/components/badge.md

• Banner: Add a banner to display important site-wide announcements and notifications.

  • URL: https://www.mintlify.com/docs/components/banner.md

• Callouts: Use callouts to style and emphasize important content.

  • URL: https://www.mintlify.com/docs/components/callouts.md

• Cards: Highlight main points or links with customizable layouts and icons.

  • URL: https://www.mintlify.com/docs/components/cards.md

• Code groups: Display multiple code examples in one component

  • URL: https://www.mintlify.com/docs/components/code-groups.md

• Color: Display color palettes with click-to-copy capability.

  • URL: https://www.mintlify.com/docs/components/color.md

• Columns: Show elements side by side

  • URL: https://www.mintlify.com/docs/components/columns.md

• Examples: Display code blocks in the right sidebar on desktop devices

  • URL: https://www.mintlify.com/docs/components/examples.md

• Expandables: Toggle to display nested properties

  • URL: https://www.mintlify.com/docs/components/expandables.md

• Fields: Document API request and response parameters with type information.

  • URL: https://www.mintlify.com/docs/components/fields.md

• Frames: Add visual emphasis with styled frames around images and other components.

  • URL: https://www.mintlify.com/docs/components/frames.md

• Icons: Use icons from popular libraries, external URLs, or files in your project.

  • URL: https://www.mintlify.com/docs/components/icons.md

• Overview: Component library for layout, emphasis, API documentation, and navigation.

  • URL: https://www.mintlify.com/docs/components/index.md

• Mermaid: Create flowcharts, diagrams, and visualizations with Mermaid syntax.

  • URL: https://www.mintlify.com/docs/components/mermaid-diagrams.md

• Panel: Customize the content of the right side panel on a page.

  • URL: https://www.mintlify.com/docs/components/panel.md

• Prompt: Display pre-built AI prompts with copy and Cursor integration actions.

  • URL: https://www.mintlify.com/docs/components/prompt.md

• Response fields: Display API response values.

  • URL: https://www.mintlify.com/docs/components/responses.md

• Steps: Create numbered step-by-step procedures.

  • URL: https://www.mintlify.com/docs/components/steps.md

• Tabs: Organize content with tabs to show different options or versions.

  • URL: https://www.mintlify.com/docs/components/tabs.md

• Tiles: Display visual previews with titles and descriptions in a grid layout.

  • URL: https://www.mintlify.com/docs/components/tiles.md

• Tooltips: Add contextual help with hover tooltips for terms and concepts.

  • URL: https://www.mintlify.com/docs/components/tooltips.md

• Tree: Use tree components to display hierarchical file and folder structures.

  • URL: https://www.mintlify.com/docs/components/tree.md

• Update: Display product updates and changelog entries in a timeline format.

  • URL: https://www.mintlify.com/docs/components/update.md

• View: Create multi-view content for different programming languages or frameworks.

  • URL: https://www.mintlify.com/docs/components/view.md

• Changelogs: Create product changelogs with RSS feed support for subscribers.

  • URL: https://www.mintlify.com/docs/create/changelogs.md

• Format code: Display and style inline code and code blocks.

  • URL: https://www.mintlify.com/docs/create/code.md

• Files: Serve static assets from your documentation.

  • URL: https://www.mintlify.com/docs/create/files.md

• Images and embeds: Add images, videos, and iframes.

  • URL: https://www.mintlify.com/docs/create/image-embeds.md

• Lists and tables: Format structured data with tables and lists.

  • URL: https://www.mintlify.com/docs/create/list-table.md

• Personalized content: Show custom content based on user data and authentication.

  • URL: https://www.mintlify.com/docs/create/personalization.md

• Redirects: Configure redirects for moved, renamed, or deleted pages.

  • URL: https://www.mintlify.com/docs/create/redirects.md

• Reusable snippets: Create reusable snippets to maintain consistency across pages.

  • URL: https://www.mintlify.com/docs/create/reusable-snippets.md

• Format text: Learn how to format text, create headers, and style content.

  • URL: https://www.mintlify.com/docs/create/text.md

• Custom 404 page: Customize the title and description of your 404 error page.

  • URL: https://www.mintlify.com/docs/customize/custom-404-page.md

• Custom domain: Host your documentation on a custom domain.

  • URL: https://www.mintlify.com/docs/customize/custom-domain.md

• Custom scripts: Add custom JavaScript and CSS to fully customize the look and feel of your documentation.

  • URL: https://www.mintlify.com/docs/customize/custom-scripts.md

• Fonts: Customize typography with Google Fonts or self-hosted fonts.

  • URL: https://www.mintlify.com/docs/customize/fonts.md

• React: Build interactive and reusable elements with React components.

  • URL: https://www.mintlify.com/docs/customize/react-components.md

• Themes: Choose the appearance of your documentation.

  • URL: https://www.mintlify.com/docs/customize/themes.md

• Audit logs: Review the actions that members of your organization perform.

  • URL: https://www.mintlify.com/docs/dashboard/audit-logs.md

• Deployment permissions: Understand deployment differences between people in your organization and other contributors.

  • URL: https://www.mintlify.com/docs/dashboard/permissions.md

• Roles: Assign admin, editor, or viewer roles to manage team access and permissions.

  • URL: https://www.mintlify.com/docs/dashboard/roles.md

• Security contact: Set an email address for communications related to customer and platform security.

  • URL: https://www.mintlify.com/docs/dashboard/security-contact.md

• Single sign-on (SSO): Set up SAML or OIDC with identity providers for team authentication.

  • URL: https://www.mintlify.com/docs/dashboard/sso.md

• Authentication setup: Control access to your documentation by authenticating users.

  • URL: https://www.mintlify.com/docs/deploy/authentication-setup.md

• CI checks: Automate broken link checks, linting, and grammar validation in CI/CD.

  • URL: https://www.mintlify.com/docs/deploy/ci.md

• Cloudflare: Host documentation at a subpath on Cloudflare Workers.

  • URL: https://www.mintlify.com/docs/deploy/cloudflare.md

• Content Security Policy (CSP) configuration: Configure CSP headers to allow Mintlify resources while maintaining security for reverse proxies, firewalls, and networks that enforce strict security policies.

  • URL: https://www.mintlify.com/docs/deploy/csp-configuration.md

• Deployments: Manage deployments, view history, and monitor status.

  • URL: https://www.mintlify.com/docs/deploy/deployments.md

• Overview: Host your documentation at the /docs subpath on your domain.

  • URL: https://www.mintlify.com/docs/deploy/docs-subpath.md

• GitHub Enterprise Server: Set up the GitHub App on your GitHub Enterprise Server installation.

  • URL: https://www.mintlify.com/docs/deploy/ghes.md

• GitHub: Connect to a GitHub repository for automated deployments, pull request previews, and continuous synchronization.

  • URL: https://www.mintlify.com/docs/deploy/github.md

• GitLab: Connect to a GitLab repository for automated deployments and preview builds.

  • URL: https://www.mintlify.com/docs/deploy/gitlab.md

• Monorepo setup: Configure documentation path and content directory for monorepo projects.

  • URL: https://www.mintlify.com/docs/deploy/monorepo.md

• Preview deployments: Get unique preview URLs for pull requests to review changes before merging.

  • URL: https://www.mintlify.com/docs/deploy/preview-deployments.md

• Reverse proxy: Configure a custom reverse proxy to serve your documentation.

  • URL: https://www.mintlify.com/docs/deploy/reverse-proxy.md

• AWS Route 53 and CloudFront: Deploy documentation at a subpath on AWS with Route 53 DNS and CloudFront CDN.

  • URL: https://www.mintlify.com/docs/deploy/route53-cloudfront.md

• Vercel: Deploy documentation to a subpath on Vercel.

  • URL: https://www.mintlify.com/docs/deploy/vercel.md

• External proxies with Vercel: Configure external proxies in front of your Vercel deployment.

  • URL: https://www.mintlify.com/docs/deploy/vercel-external-proxies.md

• Collaborate in the web editor: Work together on documentation with branches, pull requests, preview deployments, and shareable editor links.

  • URL: https://www.mintlify.com/docs/editor/collaborate.md

• Comments: Use comments to leave feedback, ask questions, and discuss changes with your team.

  • URL: https://www.mintlify.com/docs/editor/comments.md

• Configurations: Configure pages, navigation elements, and media using configuration sheets.

  • URL: https://www.mintlify.com/docs/editor/configurations.md

• Git essentials for the web editor: Understand the version control concepts behind the web editor.

  • URL: https://www.mintlify.com/docs/editor/git-essentials.md

• Web editor overview: Edit and publish documentation in your browser.

  • URL: https://www.mintlify.com/docs/editor/index.md

• Keyboard shortcuts: Reference of keyboard shortcuts for the web editor.

  • URL: https://www.mintlify.com/docs/editor/keyboard-shortcuts.md

• Live preview: Preview your documentation site and see changes in real time as you edit.

  • URL: https://www.mintlify.com/docs/editor/live-preview.md

• Add media: Upload and use images and assets in your documentation.

  • URL: https://www.mintlify.com/docs/editor/media.md

• Organize navigation: Organize your documentation structure with the visual navigation editor.

  • URL: https://www.mintlify.com/docs/editor/navigation.md

• Create and edit pages: Create, edit, and organize documentation pages in the web editor.

  • URL: https://www.mintlify.com/docs/editor/pages.md

• Publish changes in the web editor: Save your work and publish changes to your documentation site.

  • URL: https://www.mintlify.com/docs/editor/publish.md

• Suggestions: Propose text changes as suggestions that teammates can accept or reject without editing the page directly.

  • URL: https://www.mintlify.com/docs/editor/suggestions.md

• Accessibility: Create documentation that as many people as possible can use with WCAG compliance.

  • URL: https://www.mintlify.com/docs/guides/accessibility.md

• Tutorial: Build an in-app documentation assistant: Embed the assistant in your application to answer questions with information from your documentation.

  • URL: https://www.mintlify.com/docs/guides/assistant-embed.md

• Tutorial: Auto-update documentation when code is changed: Use the agent API to automatically update your documentation.

  • URL: https://www.mintlify.com/docs/guides/automate-agent.md

• Work with branches: Create branches to preview changes and collaborate before publishing.

  • URL: https://www.mintlify.com/docs/guides/branches.md

• Claude Code: Configure Claude Code to write, review, and update your documentation.

  • URL: https://www.mintlify.com/docs/guides/claude-code.md

• Content templates: Copy and modify these templates to quickly create documentation for different content types.

  • URL: https://www.mintlify.com/docs/guides/content-templates.md

• Content types: Choose the right content type for your documentation goals.

  • URL: https://www.mintlify.com/docs/guides/content-types.md

• Cursor: Configure Cursor to be your writing assistant.

  • URL: https://www.mintlify.com/docs/guides/cursor.md

• Create a custom frontend: Use the Astro integration to render your documentation with a fully custom frontend while using Mintlify's content and AI infrastructure.

  • URL: https://www.mintlify.com/docs/guides/custom-frontend.md

• Create developer documentation: Build documentation that helps developers integrate with your APIs, SDKs, and tools.

  • URL: https://www.mintlify.com/docs/guides/developer-documentation.md

• GEO guide: Optimize docs for AI search and answer engines: Optimize your documentation for AI search and answer engines.

  • URL: https://www.mintlify.com/docs/guides/geo.md

• Git concepts for documentation: Learn version control and collaboration fundamentals for docs-as-code workflows.

  • URL: https://www.mintlify.com/docs/guides/git-concepts.md

• Improve your docs: Use data and metrics to improve your documentation.

  • URL: https://www.mintlify.com/docs/guides/improving-docs.md

• Guides: Learn how to create effective documentation with best practices and workflows.

  • URL: https://www.mintlify.com/docs/guides/index.md

• Internationalization: Set up multi-language documentation to reach global audiences.

  • URL: https://www.mintlify.com/docs/guides/internationalization.md

• Create a knowledge base: Host your internal knowledge base on Mintlify to consolidate information for your team, improve search, and reduce maintenance burden.

  • URL: https://www.mintlify.com/docs/guides/knowledge-base.md

• Linking: Learn how to create internal links, reference API endpoints, and maintain link integrity across your documentation.

  • URL: https://www.mintlify.com/docs/guides/linking.md

• Maintenance: Keep your documentation accurate and up-to-date over time.

  • URL: https://www.mintlify.com/docs/guides/maintenance.md

• Media: Use media effectively while managing maintenance burden.

  • URL: https://www.mintlify.com/docs/guides/media.md

• Migrating MDX API pages to OpenAPI navigation: Migrate to automated OpenAPI generation with flexible navigation.

  • URL: https://www.mintlify.com/docs/guides/migrating-from-mdx.md

• Organize navigation: Design information architecture that aligns with user needs.

  • URL: https://www.mintlify.com/docs/guides/navigation.md

• SEO: Improve SEO to increase documentation discoverability.

  • URL: https://www.mintlify.com/docs/guides/seo.md

• Style and tone: Write effective technical documentation with consistent style.

  • URL: https://www.mintlify.com/docs/guides/style-and-tone.md

• Create a support center: Build a self-service support center that helps customers find answers, reduces ticket volume, and improves customer satisfaction.

  • URL: https://www.mintlify.com/docs/guides/support-center.md

• Understand your audience: Keep user goals at the center of your documentation.

  • URL: https://www.mintlify.com/docs/guides/understand-your-audience.md

• Windsurf: Configure Windsurf to be your writing assistant.

  • URL: https://www.mintlify.com/docs/guides/windsurf.md

• Introduction: Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers.

  • URL: https://www.mintlify.com/docs/index.md

• Install the CLI: Use the CLI to preview docs locally, test changes in real-time, and catch issues before deploying your documentation site.

  • URL: https://www.mintlify.com/docs/installation.md

• Amplitude: Track user behavior and documentation analytics with Amplitude.

  • URL: https://www.mintlify.com/docs/integrations/analytics/amplitude.md

• Clarity: Track user sessions with Microsoft Clarity analytics.

  • URL: https://www.mintlify.com/docs/integrations/analytics/clarity.md

• Clearbit: Enrich user data with Clearbit intelligence.

  • URL: https://www.mintlify.com/docs/integrations/analytics/clearbit.md

• Fathom: Track documentation analytics with Fathom.

  • URL: https://www.mintlify.com/docs/integrations/analytics/fathom.md

• Google Analytics 4: Track visitor behavior and engagement with Google Analytics.

  • URL: https://www.mintlify.com/docs/integrations/analytics/google-analytics.md

• Google Tag Manager: Manage analytics tags and events with Google Tag Manager.

  • URL: https://www.mintlify.com/docs/integrations/analytics/google-tag-manager.md

• Heap: Track user interactions with Heap analytics.

  • URL: https://www.mintlify.com/docs/integrations/analytics/heap.md

• Hightouch: Sync data to Hightouch for audience activation.

  • URL: https://www.mintlify.com/docs/integrations/analytics/hightouch.md

• HotJar: Capture user feedback and heatmaps with HotJar.

  • URL: https://www.mintlify.com/docs/integrations/analytics/hotjar.md

• LogRocket: Monitor user sessions and errors with LogRocket.

  • URL: https://www.mintlify.com/docs/integrations/analytics/logrocket.md

• Mixpanel: Track product analytics and user behavior with Mixpanel.

  • URL: https://www.mintlify.com/docs/integrations/analytics/mixpanel.md

• Analytics integrations: Connect to analytics platforms to track user engagement and documentation usage.

  • URL: https://www.mintlify.com/docs/integrations/analytics/overview.md

• Pirsch: Track privacy-focused analytics with Pirsch.

  • URL: https://www.mintlify.com/docs/integrations/analytics/pirsch.md

• Plausible: Track simple, privacy-respecting analytics with Plausible.

  • URL: https://www.mintlify.com/docs/integrations/analytics/plausible.md

• PostHog: Track product analytics and feature usage with PostHog.

  • URL: https://www.mintlify.com/docs/integrations/analytics/posthog.md

• Segment: Send analytics events to Segment and downstream tools.

  • URL: https://www.mintlify.com/docs/integrations/analytics/segment.md

• Osano: Manage cookie consent with Osano privacy platform.

  • URL: https://www.mintlify.com/docs/integrations/privacy/osano.md

• Privacy integrations: Integrate with data privacy platforms for compliance.

  • URL: https://www.mintlify.com/docs/integrations/privacy/overview.md

• Speakeasy: Automate SDK code samples in your API playground.

  • URL: https://www.mintlify.com/docs/integrations/sdks/speakeasy.md

• Stainless: Automate SDK code samples in your API playground.

  • URL: https://www.mintlify.com/docs/integrations/sdks/stainless.md

• Front: Connect Front chat for customer support conversations.

  • URL: https://www.mintlify.com/docs/integrations/support/front.md

• Intercom: Connect Intercom for in-app customer messaging.

  • URL: https://www.mintlify.com/docs/integrations/support/intercom.md

• Support integrations: Integrate with support platforms for customer assistance.

  • URL: https://www.mintlify.com/docs/integrations/support/overview.md

• Migrate to Mintlify: Learn how to migrate to Mintlify from Docusaurus, ReadMe, or another platform.

  • URL: https://www.mintlify.com/docs/migration.md

• Analytics: Track documentation analytics and understand content effectiveness with visitor data.

  • URL: https://www.mintlify.com/docs/optimize/analytics.md

• Feedback: Monitor user satisfaction and feedback on your documentation.

  • URL: https://www.mintlify.com/docs/optimize/feedback.md

• PDF exports: Export your documentation as a single PDF file.

  • URL: https://www.mintlify.com/docs/optimize/pdf-exports.md

• SEO: Optimize SEO with meta tag configuration for better search visibility.

  • URL: https://www.mintlify.com/docs/optimize/seo.md

• Hidden pages: Hide pages from your navigation while keeping them accessible.

  • URL: https://www.mintlify.com/docs/organize/hidden-pages.md

• Exclude files from publishing: Exclude specific files and directories from your published documentation with a .mintignore file.

  • URL: https://www.mintlify.com/docs/organize/mintignore.md

• Navigation: Design information architecture that aligns with user needs.

  • URL: https://www.mintlify.com/docs/organize/navigation.md

• Pages: Configure page metadata, titles, and frontmatter properties.

  • URL: https://www.mintlify.com/docs/organize/pages.md

• Global settings: Configure site-wide settings in docs.json.

  • URL: https://www.mintlify.com/docs/organize/settings.md

• Quickstart: Deploy your documentation site and make your first change.

  • URL: https://www.mintlify.com/docs/quickstart.md

OpenAPI Specs

• admin-openapi

  • URL: https://www.mintlify.com/docs/admin-openapi.json

• analytics.openapi

  • URL: https://www.mintlify.com/docs/analytics.openapi.json

• discovery-openapi

  • URL: https://www.mintlify.com/docs/discovery-openapi.json

• openapi

  • URL: https://www.mintlify.com/docs/openapi.json

AsyncAPI Specs

• asyncapi
  • URL: https://www.mintlify.com/docs/asyncapi.yaml

How to Use This Skill

Reference these resources when working with Mintlify.