# pinstaller-doc

**Repository Path**: oneclick-app/pinstaller-doc

## Basic Information

- **Project Name**: pinstaller-doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-14
- **Last Updated**: 2025-10-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PInstaller 文档系统

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgitee.com%2Foneclick-app%2Fpinstaller-doc.git)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://gitee.com/oneclick-app/pinstaller-doc)

基于 MkDocs + Material 主题的专业文档系统，模仿 LanceDB 的文档架构。

## 🚀 快速开始

### 安装依赖
```bash
pip install -r requirements.txt
```

### 本地预览
```bash
mkdocs serve
```
访问 http://localhost:8000

### 部署更新
```bash
mkdocs build && vercel --prod
```

## 📁 项目结构

```
pinstaller/
├── src/                    # 📝 文档内容（编辑这里）
│   ├── index.md           # 首页
│   ├── quickstart/        # 快速开始
│   ├── concepts/          # 核心概念
│   ├── guides/            # 使用指南
│   ├── examples/          # 示例代码
│   ├── integrations/      # 集成方案
│   ├── faq.md             # 常见问题
│   └── troubleshooting.md # 故障排除
├── mkdocs.yml             # ⚙️ 配置文件
├── requirements.txt       # 📦 Python依赖
└── package.json          # 🚀 部署配置
```

## 📝 编辑文档

1. **修改内容**：编辑 `src/` 目录下的 `.md` 文件
2. **添加页面**：在 `src/` 创建文件，在 `mkdocs.yml` 添加导航
3. **本地预览**：`mkdocs serve`
4. **部署更新**：`mkdocs build && vercel --prod`

## 🌐 在线地址

- **生产环境**: https://my-docs-i7wa8odk8-woshihoujinxin-6615s-projects.vercel.app
- **Git仓库**: https://gitee.com/oneclick-app/pinstaller-doc.git

## 🚀 部署选项

### 一键部署（推荐）
- **Vercel**: 点击上方按钮（可能需要手动导入Gitee仓库）
- **Netlify**: 点击上方按钮，支持Gitee仓库

### 手动部署步骤
1. 访问 [Vercel](https://vercel.com) 或 [Netlify](https://netlify.com)
2. 选择"Import Project"
3. 手动输入仓库地址: `https://gitee.com/oneclick-app/pinstaller-doc.git`
4. 配置构建设置（已预设，通常自动识别）
5. 点击部署

### 命令行部署（开发者）
```bash
# 本地预览
mkdocs serve

# 构建并部署到Vercel
mkdocs build && vercel --prod
```

## 💡 提示

- 只编辑 `src/` 目录下的文件
- `dist/` 和 `site/` 是自动生成的，不要手动编辑
- 修改后记得运行 `mkdocs build` 重新构建

---

**简洁明了，专注于核心功能！**