LLM-Optimized Content Cache: www.mintlify.com
AI-friendly mirror of www.mintlify.com · 50 pages · 21,043 words · Updated February 27, 2026
Content
Homepage (1)
Main landing pages and site entry points
Mintlify - The Intelligent Documentation Platform
Integrate AI into every part of your docs lifecycle. Woven into how your knowledge is written, maintained, and understood by both users and LLMs.
Articles & Blog Posts (48)
Long-form content, blog posts, and editorial pieces
安装 CLI - Mintlify
使用 CLI 在撰写和编辑时本地预览文档。上线前即可实时查看更改、测试文档站点的外观与功能，并及时发现断链或无障碍问题等故障。 CLI 还提供维护文档的实用工具，包括用于重命名文件、验证 OpenAPI 规范以及在不同格式之间迁移 content 的命令。
了解你的受众 - Mintlify
为多个受众写作常常会导致折中，结果谁也不满意。每篇内容都应聚焦于一个特定的用户画像。 你的受众可能是：
https://www.mintlify.com/docs/zh/guides/understand-your-audience
指南 - Mintlify
本节中的指南提供了关于如何创建文档的建议，帮助你的用户取得成功。无论你是从零开始，还是在改进现有文档，这些指南都能帮助你规划、撰写和维护文档。 最重要的是，要始终考虑用户的需求和目标。围绕能帮助他们使用你的产品并尽快回到自己任务的内容进行文档编写。
Discord 机器人 - Mintlify
Discord 机器人可以基于你的文档内容为社区提供实时解答。该机器人使用 Mintlify AI 助手搜索你的文档并提供准确且带引用的回答，因此答案始终是最新的。 Discord 机器人仅在公开频道中生效。它会响应对它的 @ 提及，或者在指定频道中对所有消息进行回复。 每条由 Discord 机器人发送的消息都会计入你的 AI 助手消息用量。
Quickstart - Mintlify
After you complete this guide, you’ll have a live documentation site ready to customize and update.
PDF exports - Mintlify
You can export your docs as a single PDF file for offline viewing. The PDF contains all the content in the docs, including images and links, and a navigable table of contents.
Install the CLI - Mintlify
Use the CLI to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site’s appearance and features, and catch issues like br...
SEO - Mintlify
Make your writing and structure easy for search engines to scan.
GEO guide: Optimize docs for AI search and answer engines - Mintlify
Optimize your documentation for both traditional search engines and AI-powered answer engines like ChatGPT, Perplexity, and Google AI Overviews. Generative Engine Optimization (GEO) focuses on bein...
Accessibility - Mintlify
When you create accessible documentation, you prioritize content design that makes your documentation usable by as many people as possible regardless of how they access and interact with your docum...
Démarrage rapide - Mintlify
Après avoir terminé ce guide, vous disposerez d’un site de documentation en ligne prêt à être personnalisé et mis à jour.
Migrer vers Mintlify - Mintlify
Migrez votre documentation en utilisant le package @mintlify/scraping. Ce package extrait votre contenu et le convertit pour utiliser les composants Mintlify.
Aperçu de l’éditeur web - Mintlify
Créez, modifiez et publiez votre documentation directement dans votre navigateur avec l’éditeur web. Affichez et partagez des aperçus de vos modifications, gérez la structure de navigation de votre...
Documentation native à l’IA - Mintlify
Lorsque vous hébergez votre documentation sur Mintlify, des fonctionnalités d’IA intégrées aident vos utilisateurs à trouver des réponses et votre équipe à maintenir le contenu plus efficacement. V...
Qu'est-ce que l'agent ? - Mintlify
L’agent est un outil d’IA qui crée des pull requests (demandes de fusion) avec des modifications proposées pour votre documentation, en fonction de vos instructions. Lorsque vous envoyez une requêt...
Migrar a Mintlify - Mintlify
Migra tu documentación usando el paquete @mintlify/scraping. El paquete extrae tu contenido y lo convierte para usar componentes de Mintlify.
Contenido multimedia - Mintlify
Las capturas de pantalla, los GIFs y los videos pueden mejorar la documentación, pero requieren mantenimiento continuo a medida que cambian los elementos de la interfaz. Úsalos de forma selectiva p...
Ejemplos - Mintlify
Los componentes
Git essentials for the web editor - Mintlify
Git lets you control and track changes to files. Git is the version control system of choice for docs-as-code workflows where you manage documentation the same way you would any other codebase. The...
Collaborate in the web editor - Mintlify
Collaborate with your team on documentation using branch-based workflows, pull requests, and preview deployments. If you aren’t familiar with Git, see Git essentials for the web editor.
Preview deployments - Mintlify
Preview deployments let you see how changes to your docs look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes. Preview URLs are...
Authentication setup - Mintlify
Authentication requires users to log in before accessing your documentation. When you enable authentication, users must log in to access any content. You can configure specific pages or groups as p...
Custom scripts - Mintlify
Use CSS to style HTML elements or add custom CSS and JavaScript to fully customize the look and feel of your documentation.
View - Mintlify
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 differe...
Tabs - Mintlify
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.
Icons - Mintlify
Use icons from Font Awesome, Lucide, Tabler, SVGs, external URLs, or files in your project to enhance your documentation.
Fields - Mintlify
Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.
Badge - Mintlify
Use badges to display status indicators, labels, or metadata. Badges can be used inline within text or as standalone elements.
Playground - Mintlify
{ "text": "
https://www.mintlify.com/docs/api-playground/websocket-playground
Troubleshooting - Mintlify
Resolve common issues with API page configuration.
https://www.mintlify.com/docs/api-playground/troubleshooting
Multiple responses - Mintlify
If your API returns different responses based on input parameters, user context, or other conditions of the request, you can document multiple response examples with the examples property. This pro...
https://www.mintlify.com/docs/api-playground/multiple-responses
Manage page visibility - Mintlify
For internal-only endpoints, deprecated operations, beta features, or endpoints that should be accessible via direct URL but not discoverable through site navigation, you can control which OpenAPI ...
https://www.mintlify.com/docs/api-playground/managing-page-visibility
Complex data types - Mintlify
When your API accepts multiple data formats, has conditional fields, or uses inheritance patterns, OpenAPI’s schema composition keywords help you document these flexible structures. Using oneOf, an...
https://www.mintlify.com/docs/api-playground/complex-data-types
skill.md - Mintlify
Mintlify hosts a skill.md file at the root of your project that describes what AI agents can do with your product. The skill.md specification is a structured, machine-readable format that makes cap...
Model Context Protocol - Mintlify
The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. Mintlify generates an MCP server from y...
What is the agent? - Mintlify
The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent:
Laravel
Known globally for its elegant PHP framework, Laravel has built an expansive community by prioritizing an exceptional developer experience.
Kalshi
Kalshi is the first regulated prediction market in the United States, allowing people to trade on the outcome of real-world events. Behind the scenes, its developer platform and APIs make it p...
Why do we need MCP if skills exist now?
The simple answer is auth, but skills and MCP solve different problems. Skills package knowledge. MCP packages authenticated, scoped access on a user's behalf.
https://www.mintlify.com/blog/why-do-we-need-mcp-if-skills-exist
What makes good API documentation? Best tools and examples
This blog was updated on October 24, 2025.
https://www.mintlify.com/blog/top-7-api-documentation-tools-of-2025
skill.md: An open standard for agent skills
All Mintlify documentation sites now contain a /.well-known/skills/default/skill.md file at their base URL. In accordance with the Cloudflare RFC, agentskills proposal, and Vercel skills CLI. Skill...
Simplifying docs for AI with /llms.txt
Our team recently released support for /llms.txt and /llms-full.txt, meaning that Mintlify now automatically generates and hosts all docs in a plain text format for easier ingestion by large langua...
https://www.mintlify.com/blog/simplifying-docs-with-llms-txt
How Pinecone writes documentation
Jesse Seldess runs documentation at Pinecone, where he's shaping how developers learn and succeed with one of the leading vector database platforms. Previously, he's scaled developer education from...
https://www.mintlify.com/blog/how-technical-writers-at-pinecone-write-documentation
Your docs, your frontend, our content engine
We built Mintlify so teams could ship great developer docs without building infrastructure. That works for most companies but not all.
Building an LSP for your docs
I work at Mintlify, where we provide a platform that helps companies create product documentation that developers love. Part of doing our job well is keeping up with the latest and greatest industr...
https://www.mintlify.com/blog/building-an-lsp-for-your-docs-by-overcoming-vercel
Listings & Categories (1)
Category pages, archives, and content aggregation pages
概览 - Mintlify
Tabs将相关内容组织成可切换的标签视图。代码组以多种语言显示代码示例。步骤以编号格式显示分步说明。列在响应式布局中将内容并排排布。面板创建用于呈现补充内容的侧边栏面板。标注使用带样式的警示提示突出重要信息。横幅在页面顶部显示醒目的公告。徽章添加行内标签和状态指示器。更新突出显示新的或已更新的内容。框架为图片和内容添加边框和样式效果。工具提示鼠标悬停时显示更多信息。Prompt展示可复制的 AI
Resources
- llms.txt — AI crawler index (llmstxt.org spec)
- sitemap.xml — XML sitemap for crawler discovery
- robots.txt — Crawler directives
- About this cache — Methodology, technical details, and usage guidelines