# Doccupine > Documentation for Doccupine. Every page link below points to a markdown mirror; drop the .md suffix for the HTML version. Full corpus in one file: https://docs.doccupine.com/llms-full.txt Agent skill: https://docs.doccupine.com/skill.md MCP server (streamable HTTP; tools: search_docs, get_doc, list_docs): https://docs.doccupine.com/api/mcp ## Docs ### Getting Started - [Introduction](https://docs.doccupine.com/index.md): Doccupine is a free and open-source documentation platform. Write MDX, get a production-ready site with AI chat, built-in components, and an MCP server - in one command. - [What is Doccupine](https://docs.doccupine.com/what-is-doccupine.md): Doccupine is a CLI that turns a directory of MDX files into a complete, production-ready documentation website - no frontend work required. - [Commands](https://docs.doccupine.com/commands.md): In this page, you can find all the commands available in Doccupine CLI. ### Components - [Components](https://docs.doccupine.com/components.md): Explore the full library of built-in components available in your documentation pages. - [Headers and Text](https://docs.doccupine.com/headers-and-text.md): Learn how to structure and style your content with headers, formatting, and links. - [Lists and tables](https://docs.doccupine.com/lists-and-tables.md): Present structured information using lists or tables. - [Code](https://docs.doccupine.com/code.md): Learn how to display inline code and code blocks in documentation. - [Prompt](https://docs.doccupine.com/prompt.md): Display re-usable AI prompts that readers can copy or open directly in Cursor. - [Callouts](https://docs.doccupine.com/callouts.md): Make your content stand out by using callouts for extra emphasis. - [Accordion](https://docs.doccupine.com/accordion.md): Interactive panels for toggling visibility of content. - [Tabs](https://docs.doccupine.com/tabs.md): Use the Tabs component to display different content sections in a switchable panel layout. - [Steps](https://docs.doccupine.com/steps.md): Guide readers step-by-step using the Steps component. - [Tree](https://docs.doccupine.com/tree.md): Display hierarchical file and folder structures with collapsible nodes. - [Cards](https://docs.doccupine.com/cards.md): Cards act as visual containers for your content, giving you flexibility to combine text, icons, images, and links in a clean and organized way. - [Buttons](https://docs.doccupine.com/buttons.md): A flexible action component supporting variants, sizes, icons, and links. - [Badges](https://docs.doccupine.com/badges.md): Highlight statuses, version labels, and metadata inline with colored badges. - [Tooltips](https://docs.doccupine.com/tooltips.md): Show contextual definitions and explanations when readers hover over a term. - [Images and embeds](https://docs.doccupine.com/images-and-embeds.md): Enrich your documentation with visuals, videos, and interactive embeds. - [Frames](https://docs.doccupine.com/frames.md): Give images, videos, and diagrams a bordered container with an optional caption. - [Icons](https://docs.doccupine.com/icons.md): Integrate visual icons from well-known libraries to enrich your documentation. - [Columns](https://docs.doccupine.com/columns.md): Columns are used to organize content in a grid-like structure. - [Side Panel](https://docs.doccupine.com/side-panel.md): Replace a page's table of contents with your own content, pinned to the right rail on desktop and inline on mobile. - [Fields](https://docs.doccupine.com/fields.md): Configure parameters for your API or SDK documentation. - [API Playground](https://docs.doccupine.com/api-playground.md): Turn an OpenAPI document into an interactive API reference where readers send real requests and see live responses, right inside your docs. - [Update](https://docs.doccupine.com/update.md): Easily manage and present change history. - [Color Swatches](https://docs.doccupine.com/color-swatches.md): Display color palettes with labeled swatches to document your theme colors. - [Mermaid](https://docs.doccupine.com/mermaid.md): Create flowcharts, sequence diagrams, and other visualizations using Mermaid syntax. - [Space](https://docs.doccupine.com/space.md): Add a precise vertical or horizontal gap between blocks, with per-breakpoint control. ### Configuration - [Globals](https://docs.doccupine.com/globals.md): Configure global settings for your documentation. - [Navigation](https://docs.doccupine.com/navigation.md): Organize and structure your navigation. - [Sections](https://docs.doccupine.com/sections.md): Split your documentation into top-level sections with independent sidebars. - [Footer Links](https://docs.doccupine.com/footer-links.md): Add static links at the bottom of the documentation pages. - [Theme](https://docs.doccupine.com/theme.md): Customize the documentation UI colors with a theme.json file. - [Fonts](https://docs.doccupine.com/fonts.md): Customize the documentation typography with a fonts.json file (Google Fonts or local custom fonts). - [Media and assets](https://docs.doccupine.com/media-and-assets.md): Serve static files like images, favicons, fonts, and Open Graph previews from the public directory. ### AI & Integrations - [AI Assistant](https://docs.doccupine.com/ai-assistant.md): Integrate AI capabilities into your Doccupine documentation using OpenAI, Anthropic, or Google Gemini. - [Model Context Protocol](https://docs.doccupine.com/model-context-protocol.md): Connect your Doccupine documentation to AI tools with an MCP server for enhanced AI-powered documentation search. - [Analytics](https://docs.doccupine.com/analytics.md): Add PostHog analytics to your documentation site with an analytics.json file for both client-side and server-side tracking. ### Deployment - [Deployment & Hosting](https://docs.doccupine.com/deployment-and-hosting.md): Deploy your documentation site with the Doccupine Platform or self-host on any platform that supports Next.js. - [Authentication](https://docs.doccupine.com/authentication.md): Password protect your documentation site with a single environment variable that gates pages, content APIs, and search crawlers behind a shared password. ## Platform ### Getting Started - [Platform Overview](https://docs.doccupine.com/platform.md): Learn how to use the Doccupine platform to create, customize, and deploy documentation websites. - [Creating a Project](https://docs.doccupine.com/platform/creating-a-project.md): Set up a new documentation project with a managed repository, your own GitHub account, or a repository you already have. - [Import from GitHub](https://docs.doccupine.com/platform/import-from-github.md): Paste a GitHub repository and let Doccupine's AI write a complete documentation site from your code. ### Editing - [File Editor](https://docs.doccupine.com/platform/file-editor.md): Browse, create, and edit your documentation files directly in the browser. - [Publishing Changes](https://docs.doccupine.com/platform/publishing.md): Commit your edits to GitHub and deploy your documentation site with one click. - [Agent Sync](https://docs.doccupine.com/platform/self-updating-docs.md): Agent Sync links documentation pages to the code they describe and rewrites them when that code changes, keeping your docs self-updating. ### Configuration - [Site Settings](https://docs.doccupine.com/platform/site-settings.md): Configure your documentation site's name, description, icon, and image. - [Theme Settings](https://docs.doccupine.com/platform/theme-settings.md): Customize your documentation site's color palette, logos, and dark mode appearance. - [Navigation Settings](https://docs.doccupine.com/platform/navigation-settings.md): Define the sidebar structure for your documentation site using the drag-and-drop Navigation Builder. - [Fonts Settings](https://docs.doccupine.com/platform/fonts-settings.md): Configure custom typography with Google Fonts or local font files. - [Footer Links](https://docs.doccupine.com/platform/footer-links.md): Add quick-access link buttons to your site's footer for GitHub, Discord, and other external resources. - [Authentication](https://docs.doccupine.com/platform/authentication.md): Put your documentation site behind a shared password, and understand what that protects. ### AI & Integrations - [AI Assistant](https://docs.doccupine.com/platform/ai-assistant.md): Configure the built-in AI assistant that ships with every Doccupine documentation site. - [MCP](https://docs.doccupine.com/platform/mcp.md): Connect external AI apps like Claude and Cursor to your documentation with a Model Context Protocol server, and protect it with an API key. - [API Playground](https://docs.doccupine.com/platform/api-playground.md): Register an OpenAPI spec and turn it into an interactive API reference with a live request playground. - [Analytics](https://docs.doccupine.com/platform/analytics.md): Enable PostHog analytics to track page views on your documentation site. ### Infrastructure - [Custom Domains](https://docs.doccupine.com/platform/custom-domains.md): Connect your own domain to your documentation site with automatic HTTPS. - [Build & Deploy](https://docs.doccupine.com/platform/build-and-deploy.md): Monitor your documentation site's build status and deployment history. ### Account - [Team Members](https://docs.doccupine.com/platform/team-members.md): Invite collaborators and manage roles for your documentation project. - [Billing](https://docs.doccupine.com/platform/billing.md): Manage your subscription, upgrade plans, and access the billing portal. - [Project Settings](https://docs.doccupine.com/platform/project-settings.md): Rename or delete your documentation project. ## Changelog ### Changelog - [Product updates](https://docs.doccupine.com/changelog.md): New features, improvements, and fixes across every Doccupine release.