Get started with 通用文档站点 in minutes

This guide walks you through creating and publishing your first documentation page with 通用文档站点. By the end, you will have a working site with a configured navigation, a live preview, and a page ready to share with your users.

Create your docs folder

Create a directory to hold all your documentation files. This folder is the root of your site — every page, image, and configuration file lives here. The docs.json file that controls your site settings must be placed at the top level of this directory.

mkdir my-docs
cd my-docs

Configure docs.json

Create a docs.json file at the root of your docs folder. This file sets your site name, theme, brand colors, and navigation structure. The example below is a minimal configuration to get you started.

{
  "$schema": "https://mintlify.com/docs.json",
  "name": "My Documentation",
  "theme": "willow",
  "colors": {
    "primary": "#4F6AF0"
  },
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          {
            "group": "Get Started",
            "pages": ["index"]
          }
        ]
      }
    ]
  }
}

Write your first page

Create an index.mdx file in your docs folder. Add YAML frontmatter at the top to set the page title and description, then write your content below using Markdown. You can use components like <Note> to highlight important information.

---
title: "Welcome to My Documentation"
description: "Everything you need to get up and running."
---

Welcome to the documentation. This page introduces the project and helps you get started quickly.

<Note>
  Looking for a specific topic? Use the search bar at the top of the page to find what you need.
</Note>

## Next steps

- Read the installation guide to set up your environment
- Browse the API reference for detailed endpoint documentation
- Check the guides section for tutorials and examples

Preview locally

Install the Mintlify CLI and run the local preview server to see your changes in real time. Every time you save a file, the preview updates automatically in your browser.

npm i -g mint
mint dev

Open http://localhost:3000 in your browser to view your site.

Publish

When you are happy with your content, deploy your documentation site to make it available to your users. Connect your docs folder to 通用文档站点’s deployment pipeline, trigger a build, and share the published URL with your audience. Updates you push to your docs folder will be reflected on the live site after each deployment.

To learn more about writing MDX pages — including how to use components, structure content, and add images — see the content writing guide.

Get Started

Guides

Configuration

Get started with 通用文档站点 in minutes