Skip to main content
通用文档站点 is a general-purpose documentation platform that lets you write, organize, and publish content for your users using Markdown and MDX. This page introduces the platform’s core concepts and key features so you know where to start and what to expect.

Content writing

Write documentation pages using Markdown and MDX with rich UI components.

Navigation setup

Organize your site with tabs, groups, and pages so users find content easily.

Customization

Apply your brand colors, logo, and typography to make the site your own.

Configuration

Control every aspect of your site through the docs.json configuration file.

​
Key concepts

Pages are MDX files that make up your documentation. Each file maps to a URL on your site. You write content using Markdown syntax and Mintlify components, and add frontmatter at the top of each file to set the page title, description, and sidebar label. Place pages in any directory structure that matches your site’s organization.
Components are rich UI elements you embed directly in your MDX pages. They include callouts (Note, Warning, Tip), code blocks with syntax highlighting, cards, steps, tabs, accordions, and more. Components help you present information clearly without writing custom HTML or CSS.
The docs.json file at the root of your docs folder controls your site’s global settings. You use it to set your site name, theme, brand colors, logo, navigation structure, and integrations. Every change you make to docs.json applies across the entire site.

​
Platform highlights

  • Markdown & MDX support — write content in standard Markdown with the option to embed interactive React components using MDX
  • Rich component library — use built-in callouts, cards, steps, code groups, accordions, and more to structure your content
  • Customizable themes — apply brand colors, custom fonts, logos, and favicons to match your product’s identity
  • Flexible navigation — build multi-level navigation with tabs, groups, anchors, and dropdowns to suit any content structure
  • Fast publishing — deploy your documentation site quickly and push updates without complex build pipelines