diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index 9d29fb2b9..b17e66db4 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -2,6 +2,7 @@ title: "llms.txt" description: "Automatically generate llms.txt and llms-full.txt files so AI tools like ChatGPT and Claude can index and understand your documentation." keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"] +boost: 3 --- import { PreviewButton } from "/snippets/previewbutton.jsx" diff --git a/ai/skillmd.mdx b/ai/skillmd.mdx index ac3401554..a813a7520 100644 --- a/ai/skillmd.mdx +++ b/ai/skillmd.mdx @@ -2,6 +2,7 @@ title: "skill.md" description: "Make your documentation agent-ready with automatically generated skill.md files that describe your product's capabilities for AI agents." keywords: ["AI agents", "skills", "agent skills", "agents"] +boost: 3 --- Mintlify hosts a `skill.md` file at the root of your project that describes what AI agents can do with your product. diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index cac66b75f..cb973d03c 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -2,6 +2,7 @@ title: "Playground" description: "Let developers test API endpoints directly in your documentation with an interactive playground that sends real requests and shows responses." keywords: ["interactive", "API", "endpoint testing", "live API requests", "request builder"] +boost: 3 --- The API playground is an interactive environment that lets users test and explore your API endpoints. Developers can craft API requests, submit them, and view responses without leaving your documentation. diff --git a/api-playground/troubleshooting.mdx b/api-playground/troubleshooting.mdx index b4201889c..a5c95e878 100644 --- a/api-playground/troubleshooting.mdx +++ b/api-playground/troubleshooting.mdx @@ -2,6 +2,7 @@ title: "Troubleshooting" description: "Troubleshoot common issues with API playground configuration, including OpenAPI validation errors, missing endpoints, and auth problems." keywords: ["API troubleshooting", "invalid OpenAPI", "configuration issues"] +boost: 3 --- If your API pages aren't displaying correctly, check these common configuration issues. diff --git a/api/introduction.mdx b/api/introduction.mdx index 960840f5c..2b5c58408 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -2,6 +2,7 @@ title: "Introduction" description: "Use the Mintlify REST API to trigger deployments, embed an AI assistant, export analytics data, and manage documentation programmatically." keywords: ["REST API", "endpoints", "API keys"] +boost: 3 --- The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data. diff --git a/assistant/index.mdx b/assistant/index.mdx index 6039b6fc3..920fb06ea 100644 --- a/assistant/index.mdx +++ b/assistant/index.mdx @@ -2,6 +2,7 @@ title: "Assistant" description: "Add an AI-powered chat assistant to your documentation site that answers user questions, cites sources, and generates code examples on demand." keywords: ["chat", "RAG", "user support", "multimodal"] +boost: 3 --- diff --git a/cli/commands.mdx b/cli/commands.mdx index deb5b256c..92cdda419 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -2,6 +2,7 @@ title: "Commands" description: "Complete reference for every Mintlify CLI command and flag, including mint dev, mint build, mint validate, mint analytics, and more." keywords: ["CLI", "mint", "commands", "flags", "reference"] +boost: 3 --- ## Global flags diff --git a/components/accordions.mdx b/components/accordions.mdx index 80614d05f..cb82201a3 100644 --- a/components/accordions.mdx +++ b/components/accordions.mdx @@ -2,6 +2,7 @@ title: "Accordions" description: "Use the accordion component to show and hide content sections, organize related information, and enable progressive disclosure in your docs." keywords: ["accordions", "collapsible content", "expandable sections", "progressive disclosure"] +boost: 3 --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/badge.mdx b/components/badge.mdx index e51d2c619..e61b948ba 100644 --- a/components/badge.mdx +++ b/components/badge.mdx @@ -2,6 +2,7 @@ title: "Badge" description: "Use the badge component to highlight status indicators, version labels, or metadata inline with customizable colors and hover tooltips." keywords: ["badge", "label", "tag", "status", "indicator"] +boost: 3 --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/banner.mdx b/components/banner.mdx index 94182636b..b580a0845 100644 --- a/components/banner.mdx +++ b/components/banner.mdx @@ -2,6 +2,7 @@ title: "Banner" description: "Add a dismissible banner at the top of your documentation site to display important announcements, release notes, or notifications." keywords: ["banner", "announcements", "site-wide"] +boost: 3 --- Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and you can make them dismissible. By default, banners use the color defined by the `colors.dark` property in your `docs.json`. You can change the appearance with the `type` property or override the background entirely with `color`. diff --git a/components/callouts.mdx b/components/callouts.mdx index 78c6065f4..615174d4d 100644 --- a/components/callouts.mdx +++ b/components/callouts.mdx @@ -2,6 +2,7 @@ title: "Callouts" description: "Add info, notes, tips, checks, warnings, danger, and custom callout components to highlight important information in your documentation." keywords: ["callouts", "notes", "warnings", "info boxes", "tips", "emphasis", "highlight"] +boost: 3 --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/cards.mdx b/components/cards.mdx index 804355e98..f9d173771 100644 --- a/components/cards.mdx +++ b/components/cards.mdx @@ -2,6 +2,7 @@ title: "Cards" description: "Use the Mintlify Card component to display links, icons, images, and grouped content as visual containers, including horizontal layouts and CardGroup grids." keywords: ["cards", "visual containers"] +boost: 3 --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/color.mdx b/components/color.mdx index 2d693fb2e..b85eaa369 100644 --- a/components/color.mdx +++ b/components/color.mdx @@ -2,6 +2,7 @@ title: "Color" description: "Display color swatches with hex values and click-to-copy capability using the color component for design system and branding documentation." keywords: ["color", "palette", "colors", "design system", "hex", "rgb", "rgba", "hsl", "oklch"] +boost: 3 --- Use the Color component to showcase color palettes in your documentation. Display colors in a compact grid or organize them in a table with labeled rows. diff --git a/components/columns.mdx b/components/columns.mdx index ef87e7ffa..6afc0c61c 100644 --- a/components/columns.mdx +++ b/components/columns.mdx @@ -2,6 +2,7 @@ title: 'Columns' description: "Arrange cards and other components in a responsive multi-column grid layout with the columns component, including customizable column counts." keywords: ['card groups', 'grid layout', 'multi-column layout'] +boost: 3 --- The `Columns` component lets you arrange content in a responsive grid layout. It's most often used to put cards in a grid, by specifying the number of grid columns. You can also use the `Column` sub-component to wrap arbitrary content. Columns are responsive and automatically adjust for smaller screens. diff --git a/components/examples.mdx b/components/examples.mdx index 948e8b37d..6dfcbe718 100644 --- a/components/examples.mdx +++ b/components/examples.mdx @@ -2,6 +2,7 @@ title: "Examples" description: "Display code examples in the right sidebar panel on desktop devices to show request and response samples alongside API documentation." keywords: ["RequestExample", "ResponseExample", "code examples", "request-response"] +boost: 3 --- The `` and `` components display code blocks in the right sidebar to create a two-column layout that keeps examples visible while users scroll through your content. Use these components for API documentation, but they work on all pages. diff --git a/components/expandables.mdx b/components/expandables.mdx index e9065f6bd..ef2031460 100644 --- a/components/expandables.mdx +++ b/components/expandables.mdx @@ -2,6 +2,7 @@ title: "Expandables" description: "Use the expandable component to toggle nested object properties in API documentation, showing child fields for request and response objects." keywords: ["expandables", "nested properties", "expandable fields", "toggle content"] +boost: 3 --- Use expandables to show and hide nested content within response fields. They are particularly useful for displaying complex object properties in API documentation. diff --git a/components/fields.mdx b/components/fields.mdx index fe53ea0ed..4c323fa35 100644 --- a/components/fields.mdx +++ b/components/fields.mdx @@ -2,6 +2,7 @@ title: "Fields" description: "Use ParamField and ResponseField components to document API request and response parameters with types, defaults, and validation rules." keywords: ["ParamField", "ResponseField", "request parameters", "response documentation"] +boost: 3 --- Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields. diff --git a/components/frames.mdx b/components/frames.mdx index 7c903be3d..6f598336b 100644 --- a/components/frames.mdx +++ b/components/frames.mdx @@ -2,6 +2,7 @@ title: "Frames" description: "Wrap images, videos, and other components with the frame component to add styled borders, captions, and visual emphasis to your content." keywords: ["image frames", "visual emphasis", "captions", "border"] +boost: 3 --- Use frames to display images, diagrams, videos, or other visual content with consistent styling and optional captions. Frames center content and provide visual separation from surrounding text. diff --git a/components/icons.mdx b/components/icons.mdx index fb6b764e3..6dbd1fe10 100644 --- a/components/icons.mdx +++ b/components/icons.mdx @@ -2,6 +2,7 @@ title: "Icons" description: "Add icons from Font Awesome, Lucide, Tabler, or custom sources to your documentation pages using the icon component with size and color options." keywords: ["Font Awesome", "Lucide", "Tabler", "SVGs"] +boost: 3 --- import IconsRequired from "/snippets/icons-required.mdx"; diff --git a/components/index.mdx b/components/index.mdx index b54daa174..f574738b3 100644 --- a/components/index.mdx +++ b/components/index.mdx @@ -3,6 +3,7 @@ title: "Overview" description: "Browse the full Mintlify component library for layout, emphasis, API documentation, and navigation elements available in your MDX pages." keywords: ["MDX components", "documentation components", "UI components", "components"] +boost: 3 --- Mintlify provides built-in MDX components for your documentation pages. Use these components to structure content, draw attention to important information, document APIs, and guide navigation. diff --git a/components/mermaid-diagrams.mdx b/components/mermaid-diagrams.mdx index 922d7084d..81913aea1 100644 --- a/components/mermaid-diagrams.mdx +++ b/components/mermaid-diagrams.mdx @@ -2,6 +2,7 @@ title: "Mermaid" description: "Create flowcharts, sequence diagrams, and other visualizations in your documentation using Mermaid syntax with automatic rendering." keywords: ["Mermaid", "flowcharts", "diagrams"] +boost: 3 --- [Mermaid](https://mermaid.js.org/) lets you build flowcharts, sequence diagrams, Gantt charts, and other diagrams using text and code. diff --git a/components/panel.mdx b/components/panel.mdx index 1867bffe3..efb8e8939 100644 --- a/components/panel.mdx +++ b/components/panel.mdx @@ -2,6 +2,7 @@ title: "Panel" description: "Customize the right side panel content on documentation pages to display supplementary information, examples, or navigation elements." keywords: ["sidebar"] +boost: 3 --- You can use the `` component to customize the right side panel of a page with any components that you want. diff --git a/components/prompt.mdx b/components/prompt.mdx index f6796e175..2455816d5 100644 --- a/components/prompt.mdx +++ b/components/prompt.mdx @@ -2,6 +2,7 @@ title: "Prompt" description: "Display pre-built AI prompts with one-click copy and Cursor integration buttons so users can quickly use prompts in their AI tools." keywords: ["prompt", "AI", "cursor", "copy", "prompt card"] +boost: 3 --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/steps.mdx b/components/steps.mdx index 0a3c33793..a2d74ebb6 100644 --- a/components/steps.mdx +++ b/components/steps.mdx @@ -2,6 +2,7 @@ title: "Steps" description: "Create numbered step-by-step procedures with the steps component to guide users through sequential tasks, tutorials, and setup workflows." keywords: ["sequence", "numbered steps", "procedures", "tutorial steps"] +boost: 3 --- import IconsOptional from "/snippets/icons-optional.mdx"; diff --git a/components/tabs.mdx b/components/tabs.mdx index 46d9c03aa..634d3054e 100644 --- a/components/tabs.mdx +++ b/components/tabs.mdx @@ -2,6 +2,7 @@ title: "Tabs" description: "Use the tab component to organize content into switchable panels for showing different options, platform versions, or language examples." keywords: ["tabbed content", "content panels", "switchable content"] +boost: 3 --- Use tabs to organize content into multiple panels that users can switch between. You can add any number of tabs and include other components inside each tab. diff --git a/components/tiles.mdx b/components/tiles.mdx index 5a91e383d..57d8828ca 100644 --- a/components/tiles.mdx +++ b/components/tiles.mdx @@ -2,6 +2,7 @@ title: "Tiles" description: "Use the tiles component to display visual previews with image thumbnails, titles, and descriptions in a responsive grid layout for your docs." keywords: ["tiles", "visual preview", "grid", "showcase"] +boost: 3 --- Use tiles to create visual showcase elements with a patterned background, title, and description. Tiles are ideal for displaying component previews, feature highlights, or navigation items in a grid layout. diff --git a/components/tooltips.mdx b/components/tooltips.mdx index 00d23df59..3be3dedd5 100644 --- a/components/tooltips.mdx +++ b/components/tooltips.mdx @@ -2,6 +2,7 @@ title: "Tooltips" description: "Add tooltips to display contextual definitions and explanations when users hover over terms, abbreviations, or technical concepts in your documentation." keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"] +boost: 3 --- Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links. diff --git a/components/tree.mdx b/components/tree.mdx index ef9162bfb..7cd86a18c 100644 --- a/components/tree.mdx +++ b/components/tree.mdx @@ -2,6 +2,7 @@ title: "Tree" description: "Use the tree component to display hierarchical file and folder structures with collapsible nodes and syntax highlighting for path names." keywords: ["tree", "file tree", "folder structure", "hierarchical navigation", "file system"] +boost: 3 --- Use tree components to display hierarchical structures like file systems, project directories, or nested content. The tree component supports keyboard navigation and accessibility features. diff --git a/components/update.mdx b/components/update.mdx index 1c0ca3e9b..57d13e14a 100644 --- a/components/update.mdx +++ b/components/update.mdx @@ -2,6 +2,7 @@ title: "Update" description: "Use the update component to display product updates, release notes, and changelog entries in a structured timeline format with dates." keywords: ["changelogs", "product updates", "release notes"] +boost: 3 --- Use the `Update` component to display changelog entries, version updates, and release notes with consistent formatting. diff --git a/components/view.mdx b/components/view.mdx index 4c4969bdf..d065d6bbb 100644 --- a/components/view.mdx +++ b/components/view.mdx @@ -2,6 +2,7 @@ title: "View" description: "Use the view component to create switchable content panels for different programming languages, frameworks, or configuration alternatives." keywords: ["selector", "language-specific content", "content switching"] +boost: 3 --- Use the `View` component to create content that changes based on the selected view in a multi-view dropdown. This is particularly useful for showing code examples or documentation specific to different programming languages or frameworks. diff --git a/components/visibility.mdx b/components/visibility.mdx index a01e445a9..3b97d8157 100644 --- a/components/visibility.mdx +++ b/components/visibility.mdx @@ -2,6 +2,7 @@ title: "Visibility" description: "Use the visibility component to show different content to humans on the web UI and to AI agents in Markdown output for conditional rendering." keywords: ["visibility", "agents", "humans", "markdown", "AI", "conditional content"] +boost: 3 --- Use the `Visibility` component to show different content to humans reading your site versus AI agents processing the Markdown output. This lets you customize information for each audience without maintaining separate pages. diff --git a/create/changelogs.mdx b/create/changelogs.mdx index 02d98dfad..f11a5c08f 100644 --- a/create/changelogs.mdx +++ b/create/changelogs.mdx @@ -2,6 +2,7 @@ title: "Changelogs" description: "Create product changelogs with date-based entries, RSS feed support, and subscriber notifications to keep users informed about updates." keywords: ["product updates", "release notes", "RSS"] +boost: 3 --- Create a changelog for your docs by adding [Update components](/components/update) to a page. diff --git a/create/files.mdx b/create/files.mdx index 0aa83502a..d0f742766 100644 --- a/create/files.mdx +++ b/create/files.mdx @@ -2,6 +2,7 @@ title: "Files" description: "Serve static assets like images, videos, PDFs, and data files from your documentation repository with automatic optimization and CDN delivery." keywords: ["static assets","supported file types"] +boost: 3 --- Mintlify automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have `/images/my-logo.png` in your repo, the image file is available at `https://docs.your-project.com/images/my-logo.png`. diff --git a/create/redirects.mdx b/create/redirects.mdx index 40c145bc0..b9254ac49 100644 --- a/create/redirects.mdx +++ b/create/redirects.mdx @@ -2,6 +2,7 @@ title: "Redirects" description: "Configure URL redirects in docs.json for moved, renamed, or deleted documentation pages to preserve SEO rankings and prevent broken links." keywords: ["redirects"] +boost: 3 --- When you change the path of a file in your docs folder, it also changes the URL path to that page. This may happen when restructuring your docs or changing the sidebar title. diff --git a/customize/fonts.mdx b/customize/fonts.mdx index 5dfe491e5..c2d1a2286 100644 --- a/customize/fonts.mdx +++ b/customize/fonts.mdx @@ -2,6 +2,7 @@ title: "Fonts" description: "Customize typography on your documentation site with Google Fonts or self-hosted font files for headings, body text, and code blocks." keywords: ["Google Fonts", "local fonts", "custom typography"] +boost: 3 --- Set a custom font for your entire site or separately for headings and body text. Use Google Fonts, local font files, or externally hosted fonts. The default font varies by theme. diff --git a/customize/react-components.mdx b/customize/react-components.mdx index 159b84100..c42a8d00b 100644 --- a/customize/react-components.mdx +++ b/customize/react-components.mdx @@ -2,6 +2,7 @@ title: "React" description: "Build interactive and reusable elements with custom React components in your Mintlify documentation using JSX, state, and client-side logic." keywords: ["React components", "interactive components", "JSX", "custom components"] +boost: 3 --- import { ColorGenerator } from "/snippets/color-generator.jsx"; diff --git a/customize/themes.mdx b/customize/themes.mdx index 71c839d8d..91bb93005 100644 --- a/customize/themes.mdx +++ b/customize/themes.mdx @@ -3,6 +3,7 @@ title: "Themes" description: "Choose and configure a theme to customize your documentation site's colors, dark mode behavior, layout style, and overall visual appearance." mode: "frame" keywords: ["theme selection", "Mint", "Maple", "Palm", "Willow", "Linden", "Almond", "Aspen", "Sequoia", "customize appearance"] +boost: 3 --- export const ThemeCard = ({ title, value, description, href }) => { diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index 0a8555716..41367cb43 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -2,6 +2,7 @@ title: "Roles" description: "Assign admin, editor, or viewer roles to team members to control access levels, editing permissions, and deployment capabilities in Mintlify." keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "permissions"] +boost: 3 --- diff --git a/deploy/cloudflare.mdx b/deploy/cloudflare.mdx index d3c561599..3a6631376 100644 --- a/deploy/cloudflare.mdx +++ b/deploy/cloudflare.mdx @@ -2,6 +2,7 @@ title: "Cloudflare" description: "Deploy your Mintlify documentation at a subpath on your domain using Cloudflare Workers with step-by-step setup and DNS configuration." keywords: ["Cloudflare Workers", "subpath routing", "reverse proxy setup", "Worker configuration"] +boost: 3 --- import Propagating from "/snippets/custom-subpath-propagating.mdx"; diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index e68ee0633..87fbb44fb 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -2,6 +2,7 @@ title: "Deployments" description: "Manage documentation deployments in the Mintlify dashboard, including viewing deployment history, monitoring build status, and troubleshooting." keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] +boost: 3 --- Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. diff --git a/deploy/docs-subpath.mdx b/deploy/docs-subpath.mdx index 80882ab4c..d0dd91b78 100644 --- a/deploy/docs-subpath.mdx +++ b/deploy/docs-subpath.mdx @@ -2,6 +2,7 @@ title: "Overview" description: "Host your Mintlify documentation at a /docs subpath on your main domain using Cloudflare Workers, Vercel rewrites, or an nginx reverse proxy." keywords: ["subpath routing", "/docs setup"] +boost: 3 --- Host your documentation at a subpath like `your-domain.com/docs` to keep your docs on your main domain, which makes them easier to find and maintains a cohesive brand experience for your users. diff --git a/deploy/github.mdx b/deploy/github.mdx index 336e6f153..0724faf29 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -2,6 +2,7 @@ title: "GitHub" description: "Connect your GitHub repository to Mintlify for automated deployments, pull request preview builds, and continuous documentation synchronization." keywords: ["GitHub App","repository connection","automated deployments"] +boost: 3 --- Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index fb50a5dbe..f695e1239 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -2,6 +2,7 @@ title: "GitLab" description: "Connect your GitLab repository to Mintlify for automated documentation deployments, merge request previews, and continuous synchronization." keywords: ["GitLab integration", "access tokens", "merge request previews", "self-hosted", "instance"] +boost: 3 --- Mintlify uses access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify. diff --git a/deploy/vercel.mdx b/deploy/vercel.mdx index 9cf909dc2..08819b9b1 100644 --- a/deploy/vercel.mdx +++ b/deploy/vercel.mdx @@ -2,6 +2,7 @@ title: "Vercel" description: "Configure Vercel rewrites to serve your Mintlify documentation at a subpath on your main domain with step-by-step vercel.json setup." keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"] +boost: 3 --- import { VercelJsonGenerator } from "/snippets/vercel-json-generator.mdx"; diff --git a/editor/configurations.mdx b/editor/configurations.mdx index bf2eff40b..704098954 100644 --- a/editor/configurations.mdx +++ b/editor/configurations.mdx @@ -2,6 +2,7 @@ title: "Configurations" description: "Edit site branding, colors, appearance, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync." keywords: ["editor", "configurations", "settings", "branding", "theme"] +boost: 3 --- Configure your documentation site's branding, appearance, and features from the **Configurations** panel in the web editor. Configuration changes sync in real-time with other editors on the same branch, so your team always sees the latest settings. diff --git a/guides/index.mdx b/guides/index.mdx index 627676545..3a6f3a69a 100644 --- a/guides/index.mdx +++ b/guides/index.mdx @@ -1,6 +1,7 @@ --- title: "Guides" description: "Browse guides on documentation best practices, content strategy, SEO optimization, accessibility, and docs-as-code workflows for your team." +boost: 3 --- The guides in this section contain advice for creating documentation that helps your users succeed. Whether you're starting from scratch or improving existing docs, these guides help you plan, write, and maintain your documentation. diff --git a/index.mdx b/index.mdx index 8885e44dd..1d55eec22 100644 --- a/index.mdx +++ b/index.mdx @@ -3,6 +3,7 @@ title: "Introduction" description: "Mintlify is an AI-native documentation platform built for developers, with beautiful defaults, interactive API playgrounds, and smart search." mode: "frame" keywords: ["overview", "platform", "getting started", "features"] +boost: 3 --- export const HeroCard = ({ filename, title, description, href }) => { diff --git a/integrations/analytics/amplitude.mdx b/integrations/analytics/amplitude.mdx index 8e5035a56..fe7fefa4b 100644 --- a/integrations/analytics/amplitude.mdx +++ b/integrations/analytics/amplitude.mdx @@ -2,6 +2,7 @@ title: "Amplitude" description: "Integrate Amplitude analytics with your Mintlify documentation site to track user behavior, page views, and content engagement metrics." keywords: ["Amplitude integration", "Amplitude API key", "user behavior tracking", "product analytics"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Amplitude. diff --git a/integrations/analytics/clarity.mdx b/integrations/analytics/clarity.mdx index 6463d98a6..f01d8b095 100644 --- a/integrations/analytics/clarity.mdx +++ b/integrations/analytics/clarity.mdx @@ -2,6 +2,7 @@ title: "Clarity" description: "Integrate Microsoft Clarity with your Mintlify documentation site to capture session recordings, heatmaps, and user interaction analytics." keywords: ["Microsoft Clarity", "session recording", "heatmaps", "user sessions"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Microsoft Clarity. diff --git a/integrations/analytics/clearbit.mdx b/integrations/analytics/clearbit.mdx index bcc90ca03..f25b923c5 100644 --- a/integrations/analytics/clearbit.mdx +++ b/integrations/analytics/clearbit.mdx @@ -2,6 +2,7 @@ title: "Clearbit" description: "Integrate Clearbit with your Mintlify documentation to enrich visitor data, identify visiting companies, and track enterprise engagement." keywords: ["Clearbit integration", "user enrichment", "visitor intelligence", "public API key"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Clearbit. diff --git a/integrations/analytics/fathom.mdx b/integrations/analytics/fathom.mdx index d499604ab..b2a96a8a4 100644 --- a/integrations/analytics/fathom.mdx +++ b/integrations/analytics/fathom.mdx @@ -2,6 +2,7 @@ title: "Fathom" description: "Integrate Fathom Analytics with your Mintlify documentation for privacy-focused, GDPR-compliant visitor tracking with a simple site ID setup." keywords: ["Fathom Analytics", "privacy-focused analytics", "site ID", "simple analytics"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Fathom. diff --git a/integrations/analytics/heap.mdx b/integrations/analytics/heap.mdx index de88710ce..10a87af05 100644 --- a/integrations/analytics/heap.mdx +++ b/integrations/analytics/heap.mdx @@ -2,6 +2,7 @@ title: "Heap" description: "Integrate Heap analytics with your Mintlify documentation site to automatically capture user interactions and events for behavioral analysis." keywords: ["Heap Analytics", "automatic event tracking", "Heap app ID", "user interaction tracking"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Heap. diff --git a/integrations/analytics/hightouch.mdx b/integrations/analytics/hightouch.mdx index 09e8ab0b2..523bba205 100644 --- a/integrations/analytics/hightouch.mdx +++ b/integrations/analytics/hightouch.mdx @@ -2,6 +2,7 @@ title: "Hightouch" description: "Integrate Hightouch with your Mintlify documentation to sync analytics data for audience activation, segmentation, and downstream tool routing." keywords: ["Hightouch integration", "data activation", "write key", "audience sync"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Hightouch. diff --git a/integrations/analytics/hotjar.mdx b/integrations/analytics/hotjar.mdx index 460870d5a..9d50ddd88 100644 --- a/integrations/analytics/hotjar.mdx +++ b/integrations/analytics/hotjar.mdx @@ -2,6 +2,7 @@ title: "Hotjar" description: "Integrate Hotjar with your Mintlify documentation site to capture session recordings, heatmaps, and user feedback for experience insights." keywords: ["Hotjar integration", "user feedback", "session recordings", "behavior analytics"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Hotjar. diff --git a/integrations/analytics/logrocket.mdx b/integrations/analytics/logrocket.mdx index 25bec41ef..d60e6d52c 100644 --- a/integrations/analytics/logrocket.mdx +++ b/integrations/analytics/logrocket.mdx @@ -2,6 +2,7 @@ title: "LogRocket" description: "Integrate LogRocket with your Mintlify documentation to replay user sessions, monitor frontend errors, and debug interaction issues in detail." keywords: ["LogRocket integration", "session replay", "error monitoring", "app ID"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to LogRocket. diff --git a/integrations/analytics/mixpanel.mdx b/integrations/analytics/mixpanel.mdx index c69d8f06b..e7b2d036a 100644 --- a/integrations/analytics/mixpanel.mdx +++ b/integrations/analytics/mixpanel.mdx @@ -2,6 +2,7 @@ title: "Mixpanel" description: "Integrate Mixpanel with your Mintlify documentation site to track product analytics, user behavior funnels, and content engagement events." keywords: ["Mixpanel integration", "product analytics", "event tracking", "token"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Mixpanel. diff --git a/integrations/analytics/pirsch.mdx b/integrations/analytics/pirsch.mdx index d001d9ab7..0d4add254 100644 --- a/integrations/analytics/pirsch.mdx +++ b/integrations/analytics/pirsch.mdx @@ -2,6 +2,7 @@ title: "Pirsch" description: "Integrate Pirsch with your Mintlify documentation for GDPR-compliant, cookie-free analytics that tracks page views without collecting personal data." keywords: ["Pirsch Analytics", "privacy analytics", "identification code", "GDPR-compliant"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to Pirsch. diff --git a/integrations/analytics/plausible.mdx b/integrations/analytics/plausible.mdx index 1f436cf0b..53bf46a94 100644 --- a/integrations/analytics/plausible.mdx +++ b/integrations/analytics/plausible.mdx @@ -2,6 +2,7 @@ title: "Plausible" description: "Integrate Plausible Analytics with your Mintlify documentation for lightweight, privacy-respecting visitor tracking without cookies or consent banners." keywords: ["Plausible Analytics", "privacy-respecting analytics", "self-hosted analytics", "domain configuration"] +boost: 3 --- Add your site's domain to `docs.json` to send analytics to Plausible. diff --git a/integrations/analytics/posthog.mdx b/integrations/analytics/posthog.mdx index 05a1d41e8..5b62c76ec 100644 --- a/integrations/analytics/posthog.mdx +++ b/integrations/analytics/posthog.mdx @@ -2,6 +2,7 @@ title: "PostHog" description: "Integrate PostHog with your Mintlify documentation site to track product analytics, feature usage, and user behavior with your API key." keywords: ["PostHog integration", "product analytics", "feature flags", "self-hosted PostHog"] +boost: 3 --- Add the following to your `docs.json` file to send analytics to PostHog. diff --git a/integrations/analytics/segment.mdx b/integrations/analytics/segment.mdx index 01acde6b5..d7f54e15a 100644 --- a/integrations/analytics/segment.mdx +++ b/integrations/analytics/segment.mdx @@ -2,6 +2,7 @@ title: "Segment" description: "Integrate Segment with your Mintlify documentation to route analytics events to downstream tools like warehouses, CRMs, and marketing platforms." keywords: ["Segment integration", "write key", "event streaming", "CDP integration"] +boost: 3 --- Add your Segment write key to your `docs.json` file to send analytics to Segment. diff --git a/integrations/privacy/osano.mdx b/integrations/privacy/osano.mdx index 15b4a1e9c..db21ddd50 100644 --- a/integrations/privacy/osano.mdx +++ b/integrations/privacy/osano.mdx @@ -2,6 +2,7 @@ title: "Osano" description: "Integrate Osano with your Mintlify documentation site to manage cookie consent banners, privacy preferences, and regulatory compliance." keywords: ["Osano integration", "cookie consent manager", "GDPR compliance"] +boost: 3 --- Add [Osano](https://www.osano.com/) cookie consent to your docs with a [custom JavaScript file](/customize/custom-scripts#custom-javascript) in your repository. diff --git a/integrations/sdks/speakeasy.mdx b/integrations/sdks/speakeasy.mdx index 554b94775..e679c5f0f 100644 --- a/integrations/sdks/speakeasy.mdx +++ b/integrations/sdks/speakeasy.mdx @@ -2,6 +2,7 @@ title: "Speakeasy" description: "Display autogenerated SDK code samples from Speakeasy in your API playground with multi-language examples for Python, TypeScript, Go, and more." keywords: ["Speakeasy SDK", "autogenerated SDKs", "SDK code samples", "API playground integration"] +boost: 3 --- You can integrate autogenerated code snippets from Speakeasy SDKs directly into Mintlify API reference documentation. SDK usage snippets appear in the [interactive playground](/api-playground/overview) of Mintlify-powered documentation sites. diff --git a/integrations/sdks/stainless.mdx b/integrations/sdks/stainless.mdx index 6dc960519..3f495fbf9 100644 --- a/integrations/sdks/stainless.mdx +++ b/integrations/sdks/stainless.mdx @@ -2,6 +2,7 @@ title: "Stainless" description: "Display autogenerated SDK code samples from Stainless in your API playground with type-safe examples across Python, TypeScript, and other SDKs." keywords: ["Stainless SDK", "SDK generation", "API client libraries", "type-safe SDKs"] +boost: 3 --- ## Prerequisites diff --git a/integrations/support/front.mdx b/integrations/support/front.mdx index 6279249bc..b6e2c4732 100644 --- a/integrations/support/front.mdx +++ b/integrations/support/front.mdx @@ -2,6 +2,7 @@ title: "Front" description: "Integrate Front chat with your Mintlify documentation site so visitors can start customer support conversations directly from your docs pages." keywords: ["Front Chat", "chat widget integration", "chat ID", "customer conversations"] +boost: 3 --- Add the following to your `docs.json` file to add a [Front Chat](https://front.com) widget. diff --git a/integrations/support/intercom.mdx b/integrations/support/intercom.mdx index 57094eeed..7596156a1 100644 --- a/integrations/support/intercom.mdx +++ b/integrations/support/intercom.mdx @@ -2,6 +2,7 @@ title: "Intercom" description: "Integrate the Intercom chat widget into your Mintlify documentation site to provide real-time customer messaging, support, and onboarding help." keywords: ["Intercom integration", "Intercom widget", "app ID", "in-app messaging"] +boost: 3 --- Add the following to your `docs.json` file to add an [Intercom](https://www.intercom.com) widget. diff --git a/optimize/analytics.mdx b/optimize/analytics.mdx index e3a54d6b6..d5509a477 100644 --- a/optimize/analytics.mdx +++ b/optimize/analytics.mdx @@ -2,6 +2,7 @@ title: "Analytics" description: "Track documentation analytics in the Mintlify dashboard to understand page views, visitor trends, search queries, and content effectiveness." keywords: ["analytics","metrics","page views","traffic","trends","insights"] +boost: 3 --- The [analytics](https://dashboard.mintlify.com/products/analytics/v2/) page in your dashboard shows data about visitors to your docs, how they interact with the assistant, what they search for, and their feedback. Use this information to identify which pages are most valuable to your users and track trends over time. diff --git a/optimize/feedback.mdx b/optimize/feedback.mdx index 89aef6bc8..220297c13 100644 --- a/optimize/feedback.mdx +++ b/optimize/feedback.mdx @@ -2,6 +2,7 @@ title: "Feedback" description: "Monitor user satisfaction with built-in feedback widgets, page ratings, and thumbs up/down reactions to identify documentation improvement areas." keywords: ["user feedback", "thumbs rating", "contextual", "satisfaction", "agents"] +boost: 3 --- diff --git a/optimize/seo.mdx b/optimize/seo.mdx index 8e5e70a9d..8f8761b09 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -2,6 +2,7 @@ title: "SEO" description: "Configure meta tags, Open Graph properties, canonical URLs, and page-level SEO settings to improve your documentation's search engine ranking." keywords: ["meta tags", "sitemap", "robots.txt", "SEO", "search engine optimization"] +boost: 3 --- Mintlify automatically handles many SEO best practices, including: diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 1a0b1da75..49ee26a60 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -2,6 +2,7 @@ title: "Navigation" description: "Configure your documentation site navigation with groups, pages, dropdowns, tabs, and anchors in docs.json to build a sidebar structure." keywords: ["navigation structure", "sidebar configuration", "page organization", "navigation groups"] +boost: 3 --- The [navigation](/organize/settings-structure#navigation) property in `docs.json` controls the structure and information hierarchy of your documentation. diff --git a/organize/pages.mdx b/organize/pages.mdx index cb4a86240..bb2e82909 100644 --- a/organize/pages.mdx +++ b/organize/pages.mdx @@ -2,6 +2,7 @@ title: "Pages" description: "Configure page metadata, titles, descriptions, icons, and layout modes using YAML frontmatter properties at the top of your MDX documentation." keywords: ["tags", "tag", "frontmatter", "metadata", "layout"] +boost: 3 --- Each page is a Markdown file. You can use either `.mdx` or `.md` file types for your pages. We recommend MDX, which combines Markdown with React components for rich, interactive documentation. Plain Markdown (`.md`) can expedite migration from other platforms, but switching to MDX enables more features. diff --git a/organize/settings-integrations.mdx b/organize/settings-integrations.mdx index 94dff19af..91d774fbb 100644 --- a/organize/settings-integrations.mdx +++ b/organize/settings-integrations.mdx @@ -2,6 +2,7 @@ title: "Integrations" description: "Connect analytics platforms, chat widgets, and third-party services to your Mintlify documentation site through the docs.json integrations config." keywords: ["integrations", "analytics", "google analytics", "posthog", "segment", "intercom", "hotjar", "mixpanel", "amplitude", "docs.json"] +boost: 3 --- Use the `integrations` field in `docs.json` to connect third-party analytics platforms, chat tools, and other services to your documentation site. diff --git a/quickstart.mdx b/quickstart.mdx index e63558ca3..083392251 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -2,6 +2,7 @@ title: "Quickstart" description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git." keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"] +boost: 3 --- import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; diff --git a/workflows/index.mdx b/workflows/index.mdx index da9fd38dd..5ead465d7 100644 --- a/workflows/index.mdx +++ b/workflows/index.mdx @@ -2,6 +2,7 @@ title: "Overview" description: "Automate documentation maintenance with Mintlify workflows. Run the agent on a schedule or in response to GitHub and GitLab repository pushes." keywords: ["automation", "automate", "cron", "agent"] +boost: 3 ---