Skip to content

🏃‍♂️ 快速开始

欢迎使用 My Docs！本指南将帮助您快速上手并部署自己的专业文档系统。

环境要求

  • Python 3.8+
  • Node.js 16+
  • Git

安装步骤

1. 克隆项目

git clone https://gitee.com/oneclick-app/pinstaller-doc.git
cd pinstaller-doc

2. 安装依赖

pip install -r requirements.txt

3. 本地预览

mkdocs serve

访问 http://localhost:8000 查看文档效果。

部署选项

Vercel 部署（推荐）

# 安装 Vercel CLI
npm i -g vercel

# 登录并部署
vercel login
vercel --prod

GitHub Pages 部署

# 构建静态文件
mkdocs build

# 部署到 GitHub Pages
mkdocs gh-deploy

自建服务器部署

# 构建静态文件
mkdocs build

# 将 site/ 目录上传到您的服务器

快速配置

修改基本信息

编辑 mkdocs.yml 文件：

site_name: 您的项目名称
site_url: https://your-domain.com
repo_url: https://github.com/your-username/your-repo

添加新文档

在 src/ 目录下创建 Markdown 文件，然后在 mkdocs.yml 的 nav 部分添加导航。

下一步