Skip to content

MaaXYZ/MaaFrameworkDocsWebsite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MaaFramework 文档网站

这是 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 改进文档!

  1. Fork 本仓库
  2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

许可证

本文档遵循与 MaaFramework 相同的开源协议。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •