> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cooree.co/llms.txt
> Use this file to discover all available pages before exploring further.

# README 预览

> 预览仓库根目录下的 README.md 文件

本页预览仓库根目录下的 `README.md` 文件。切换到「预览」标签查看渲染效果,切换到「源码」标签查看原始 Markdown 内容。

<Tip>
  本页内容是 `README.md` 的静态快照。源文件更新后,请同步更新本页。
</Tip>

<Tabs>
  <Tab title="预览">
    # Mintlify Starter Kit

    Use the starter kit to get your docs deployed and ready to customize.

    Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

    * Guide pages
    * Navigation
    * Customizations
    * API reference pages
    * Use of popular components

    **[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**

    ## AI-assisted writing

    Set up your AI coding tool to work with Mintlify:

    ```bash theme={null}
    npx skills add https://mintlify.com/docs
    ```

    This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

    See the [AI tools guides](/ai-tools) for tool-specific setup.

    ## Development

    Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:

    ```
    npm i -g mint
    ```

    Run the following command at the root of your documentation, where your `docs.json` is located:

    ```
    mint dev
    ```

    View your local preview at `http://localhost:3000`.

    ## Publishing changes

    Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

    ## Need help?

    ### Troubleshooting

    * If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
    * If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.

    ### Resources

    * [Mintlify documentation](https://mintlify.com/docs)
  </Tab>

  <Tab title="源码">
    ````md theme={null}
    # Mintlify Starter Kit

    Use the starter kit to get your docs deployed and ready to customize.

    Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

    - Guide pages
    - Navigation
    - Customizations
    - API reference pages
    - Use of popular components

    **[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)**

    ## AI-assisted writing

    Set up your AI coding tool to work with Mintlify:

    ```bash
    npx skills add https://mintlify.com/docs
    ```

    This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

    See the [AI tools guides](/ai-tools) for tool-specific setup.

    ## Development

    Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:

    ```
    npm i -g mint
    ```

    Run the following command at the root of your documentation, where your `docs.json` is located:

    ```
    mint dev
    ```

    View your local preview at `http://localhost:3000`.

    ## Publishing changes

    Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

    ## Need help?

    ### Troubleshooting

    - If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI.
    - If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.

    ### Resources

    - [Mintlify documentation](https://mintlify.com/docs)
    ````
  </Tab>
</Tabs>
