Skip to main content

安装 Mintlify

首先,确保安装了 Node.js (18+),然后安装 Mintlify CLI:
npm install -g mintlify

本地预览

在项目根目录运行:
mint dev
本地服务器将在 http://localhost:3000 启动,自动检测文件变化并热更新。

文档结构

docs/
├── index.mdx           # 首页
├── quickstart.mdx      # 快速开始
├── development.mdx     # 开发指南
├── docs.json           # 站点配置
├── modules/            # 模块文档
│   ├── overview.mdx
│   ├── robotics.mdx
│   ├── embedded.mdx
│   └── algorithms.mdx
├── contributing/       # 贡献指南
│   ├── guidelines.mdx
│   ├── workflow.mdx
│   └── code-style.mdx
├── community/          # 社区
│   ├── about.mdx
│   ├── a416-lab.mdx
│   └── discord.mdx
├── api-reference/      # API 文档
└── essentials/         # 基础教程

创建新页面

  1. 创建 .mdx 文件
  2. 添加 frontmatter:
---
title: "页面标题"
description: "页面描述"
---
  1. docs.json 中添加导航

组件使用

卡片

<Card title="标题" icon="icon-name">
  内容描述
</Card>

卡片组

<CardGroup cols={2}>
  <Card title="卡片1">内容1</Card>
  <Card title="卡片2">内容2</Card>
</CardGroup>

步骤

<Steps>
  <Step title="步骤1">说明1</Step>
  <Step title="步骤2">说明2</Step>
</Steps>

检查链接

运行以下命令检查死链:
mint broken-links

部署

文档会自动部署到 Mintlify 平台。提交更改到仓库后:
  1. 连接 Gitee/GitHub 仓库到 Mintlify
  2. 推送更改到主分支
  3. 自动构建和部署

更多资源