这是 MaaFramework 的官方文档网站,使用 Rspress 构建。
pnpm install
pnpm dev
访问 http://localhost:5173/ 查看文档网站。
pnpm build
构建产物将生成在 doc_build
目录下。
pnpm preview
docs/
├── index.md # 中文首页
├── public/ # 静态资源
│ └── maafw.png # Logo
├── zh/ # 中文文档
│ └── index.md # 首页
└── en/ # 英文文档
└── index.md # 首页
- 📚 多语言支持: 支持中英文文档,自动切换语言
- 🔍 全文搜索: 内置搜索功能,快速查找内容
- 📱 响应式设计: 适配各种设备屏幕
- 🎯 自动大纲: 自动生成文档大纲,方便导航
- 🌙 暗色模式: 支持明暗主题切换
- ⚡ 快速构建: 基于 Rspress,构建速度极快
欢迎提交 PR 改进文档!
- Fork 本仓库
- 创建您的特性分支 (
git checkout -b feature/AmazingFeature
) - 提交您的更改 (
git commit -m 'Add some AmazingFeature'
) - 推送到分支 (
git push origin feature/AmazingFeature
) - 打开一个 Pull Request
本文档遵循与 MaaFramework 相同的开源协议。