01MVP Docs Starter
写给非程序员的 AI 写作伴侣：配合 Trae / Cursor 等 AI 编辑器，像聊天一样，轻松构建你的现代化知识库网站。无需懂代码，专注于内容创作。
这是一个专为 AI 时代 打造的文档模板。它极度简化，只为让你获得极致的写作与阅读体验。
🤔 为什么选择这个模板？
我们认为，利用 AI 写代码的能力来写文档 + Agent 自动化的模式，是当下管理知识库的最佳实践。
如果你习惯了 Notion 或 Obsidian，不妨试试 AI 编辑器 (Trae / Cursor)，你会发现这不仅是工具的改变，更是创作思维的升级：
- 🚀 AI 帮你 "维护" 文档：无论是润色文章、续写内容，还是整理复杂的资料，AI 都能轻松搞定。代码级的 Diff 对比视图 让你直观看到每一个字的改动，掌控感拉满。
- ⚡️ 解决分享痛点：Markdown 写作很舒服，但分享很麻烦？这个模板帮你自动生成专业的网站，完美解决图片、排版、搜索和手机端阅读问题。
- 🤖 真正 "零门槛"：不懂代码？没关系。这个模板结构清晰，专为 AI "读懂" 而设计。你只需要告诉 AI："帮我把这个部署上线"，剩下的交给它。
总结：用 AI 赋予你 "程序员级" 的生产力，用网站赋予你 "专业级" 的展示效果。
✨ 核心卖点
轻量，极致速度： VitePress 是目前最快的静态网站生成器之一。不仅构建速度快，打开网页更是秒开。没有复杂的后台，没有数据库，一切只为“阅读”而生。
📱 像 App 一样安装到桌面/手机 (PWA)： 通过内置的 PWA 技术，你可以把这个文档网站一键添加到手机主屏幕或电脑桌面。它不仅看起来像个原生 App，还能在没有网络的时候离线阅读！
🤖 自动生成目录导航： 你只管写文件，不用管菜单。只需把文件放进文件夹，侧边栏导航会自动生成。对于不爱折腾配置的小白来说，这是最省心的功能。
🇨🇳 专为中文写作优化： 默认就是中文界面，搜索也是中文优化的。不管是字体排版还是标点符号，都调整到了最适合中文阅读的状态。
🧩 丰富的写作工具： 不仅仅是文字。你可以像程序员一样画流程图 (Mermaid)，做任务列表，或者漂亮的选项卡。让你的文档看起来既专业又生动。
🚀 免费的一键发布： 支持 Vercel, EdgeOne 等平台。不需要买服务器，不需要懂 Linux，点一下按钮，你的网站就上线了，全球都能访问。
更多技术细节与工具对比（如 Notion, Astro），请查阅 在线文档。
🚀 一键部署
只需 1 分钟，你就可以拥有一个属于自己的文档网站，并立即分享给朋友！
无需配置本地环境，直接点击下方按钮即可将模板部署到你喜欢的平台：
| 平台 | 部署按钮 | 说明 |
|---|---|---|
| Netlify |  | 国际访问推荐 🌏 部署简单，国内大部分地区可直接访问。 |
| Vercel | 开发者首选 🛠️ 注意：Vercel 提供的默认域名 ( *.vercel.app) 在国内无法直接访问，你需要在Vercel中绑定自己的域名才行。 | |
| EdgeOne |  | 国内访问推荐 🇨🇳 腾讯云出品，国内访问速度很快。 |
🏁 快速开始
0. 一键创建 (npm create)
发布 create-01mvp-docs-starter 后可用：
npm create 01mvp-docs-starter@latest my-docs
# 或
bun create 01mvp-docs-starter my-docs1. 获取项目
推荐直接 Clone 仓库：
git clone https://github.com/01mvp/01mvp-docs-starter.git my-docs
cd my-docs或者直接 下载 ZIP 解压。
2. 安装依赖
推荐使用 Bun 以获得极速体验（当然也支持 npm/yarn/pnpm）：
bun install3. 启动开发环境
bun dev启动后访问 http://localhost:5173 即可看到文档站点。
📂 目录结构
.
├── docs/
│ ├── .vitepress/ # 核心配置
│ │ ├── config.mts # 站点配置 (标题、侧边栏、PWA等)
│ │ └── theme/ # 主题定制
│ ├── guide/ # 示例文档目录
│ ├── public/ # 静态资源 (图片、图标)
│ └── index.md # 首页
├── scripts/ # 辅助脚本
├── package.json
└── README.md🤖 AI 辅助初始化 (推荐)
当你下载并打开这个项目后，可以将以下内容复制给 Trae / Cursor / Claude Code 等 AI 助手，让 AI 帮你快速完成项目的个性化配置：
## 🎯 项目初始化指令
请按照以下步骤帮助我初始化这个 VitePress 文档项目：
1. **项目基础信息更新**：
* 检查 `package.json`，询问我新的项目名称 (`name`)、描述 (`description`) 和作者 (`author`)，并进行更新。
* 检查 `docs/.vitepress/config.mts`，更新站点的 `title` 和 `description`。
2. **社交链接配置**：
* 在 `docs/.vitepress/config.mts` 中找到 `socialLinks` 配置（如果没有请添加）。
* 询问我的 GitHub 仓库地址和 Twitter/X 地址，并更新图标链接。
3. **PWA 配置**：
* 检查 `docs/.vitepress/config.mts` 中的 PWA 配置 (`VitePWA`)。
* 将 `manifest` 中的 `name`, `short_name`, `description` 更新为我的项目信息。
* 提醒我替换 `docs/public` 目录下的 `pwa-192x192.png` 和 `pwa-512x512.png` 图标。
4. **清理示例内容**：
* 询问是否需要保留 `docs/guide` 下的示例文件（如 `deploy.md`, `images.md`）。
* 如果不需要，请帮我删除它们。
请一步步引导我完成以上操作。License
MIT