多语言文档工具

gm-mcp 是一个基于 VitePress 构建的多语言文档脚手架工具,支持中文、英文和俄文,提供响应式设计、本地搜索和美观的现代化界面。

  • by studiogmls
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 studiogmls/gm-mcp-docs

使用说明

gm-mcp 文档

这是 gm-mcp 脚手架工具的多语言文档系统,使用 VitePress 构建。

功能特性

  • 🌍 多语言支持 - 中文、英文、俄文
  • 📱 响应式设计 - 适配各种设备
  • 🔍 本地搜索 - 支持多语言搜索
  • 🎨 美观界面 - 现代化的文档设计
  • 📚 完整内容 - 涵盖所有功能和使用方法

快速开始

安装依赖

cd docs
npm install

开发模式

npm run dev

访问 http://localhost:5173 查看文档。

构建文档

npm run build

预览构建结果

npm run preview

文档结构

docs/
├── .vitepress/
│   ├── config.js              # VitePress配置
│   └── dist/                  # 构建输出
├── api/                       # API文档
├── guide/                     # 中文指南
├── templates/                  # 中文模板文档
├── en/                        # 英文文档
├── ru/                        # 俄文文档
├── index.md                   # 中文首页
├── changelog.md               # 更新日志
└── package.json               # 文档项目配置

多语言访问

  • 中文: http://localhost:5173/
  • 英文: http://localhost:5173/en/
  • 俄文: http://localhost:5173/ru/

导航结构

头部导航

所有文档路由都已添加到头部导航中,使用下拉菜单组织:

  • 首页 - 项目介绍
  • 指南 - 使用指南(快速开始、安装、基本用法、高级用法)
  • 模板 - 项目模板(概览、基础、高级、最小)
  • API - API参考(命令列表、配置选项)
  • 更新日志 - 版本变更记录

侧边栏

每个语言版本都有对应的侧边栏导航,方便快速访问相关页面。

技术栈

  • VitePress - 静态站点生成器
  • Vue 3 - 前端框架
  • TypeScript - 类型支持
  • Markdown - 文档编写

贡献文档

  1. 在对应语言目录下编辑 .md 文件
  2. 更新导航配置(如需要)
  3. 测试构建和预览
  4. 提交更改

部署

构建完成后,dist/ 目录包含所有静态文件,可以部署到任何静态网站托管服务。