# mapboxgl-wiki

**Repository Path**: lzugis15/mapboxgl-wiki

## Basic Information

- **Project Name**: mapboxgl-wiki
- **Description**: mapboxgl-wiki
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-19
- **Last Updated**: 2026-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MapboxGL Wiki

基于 VitePress 的 MapboxGL 地图开发文档系统

## 特性

- 📚 完整的中文和英文文档
- 🎨 现代化的响应式设计
- 🌙 深色/浅色主题支持
- 🔍 全文搜索功能
- 📱 移动端友好
- ⚡ 基于 VitePress 构建，加载快速
- 🚀 支持 GitHub Pages 自动部署

## 快速开始

### 安装依赖

```bash
npm install
```

### 本地开发

```bash
npm run docs:dev
```

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

### 构建文档

```bash
npm run docs:build
```

### 预览构建结果

```bash
npm run docs:preview
```

## 项目结构

```
.
├── .github/workflows/    # GitHub Actions 工作流
├── .vitepress/           # VitePress 配置
│   ├── config.ts         # 主配置文件
│   └── theme/            # 主题自定义
│       ├── index.ts      # 主题入口
│       └── style.css     # 自定义样式
├── en/                   # 英文文档
│   ├── guide/            # 指南
│   ├── api/              # API 参考
│   └── examples/         # 示例
├── guide/                # 中文指南
│   ├── introduction.md
│   ├── quick-start.md
│   ├── installation.md
│   ├── map-basics.md
│   ├── layers.md
│   ├── styles.md
│   ├── interactions.md
│   ├── markers.md
│   ├── controls.md
│   ├── animations.md
│   └── performance.md
├── api/                  # 中文 API 参考
│   ├── overview.md
│   ├── map.md
│   ├── marker.md
│   ├── popup.md
│   ├── map-options.md
│   └── layer-specification.md
├── examples/             # 中文示例
│   ├── quick-start.md
│   ├── custom-style.md
│   ├── add-markers.md
│   ├── data-visualization.md
│   └── interactive-map.md
├── index.md              # 首页
├── deploy.js              # 部署脚本
├── package.json          # 项目配置
└── tsconfig.json         # TypeScript 配置
```

## 文档内容

### 指南部分

- **简介**: MapboxGL 概述和主要特性
- **快速开始**: 5 分钟创建第一个地图
- **安装**: 详细的安装和配置指南
- **地图基础**: 地图核心概念和操作
- **图层**: 图层类型和数据管理
- **样式**: 自定义地图样式
- **交互**: 处理用户交互
- **标记**: 添加和管理标记
- **控件**: 地图控件的使用
- **动画**: 地图动画效果
- **性能优化**: 提升地图性能

### API 参考

- **Map 类**: 地图主类的详细文档
- **Marker 类**: 标记类文档
- **Popup 类**: 弹出窗口类文档
- **MapOptions**: 配置选项说明
- **LayerSpecification**: 图层规范

### 示例

- **快速开始**: 基础地图示例
- **自定义样式**: 样式自定义示例
- **添加标记**: 标记使用示例
- **数据可视化**: 高级可视化示例
- **交互式地图**: 复杂交互示例

## 部署到 GitHub Pages

### 方式一：使用 GitHub Actions（推荐）

1. 将代码推送到 GitHub
2. 在 GitHub 仓库设置中启用 GitHub Pages
3. 选择 GitHub Actions 作为部署源
4. 推送代码到 `main` 或 `master` 分支会自动触发部署

### 方式二：手动部署

```bash
npm run deploy
```

或使用手动步骤：

```bash
# 1. 构建文档
npm run docs:build

# 2. 安装 gh-pages（首次）
npm install -g gh-pages

# 3. 部署
gh-pages -d .vitepress/dist
```

### 配置

在 `.vitepress/config.ts` 中修改以下配置：

```typescript
// 修改 base 路径（如果需要）
base: '/your-repo-name/',

// 修改编辑链接
editLink: {
  pattern: 'https://github.com/yourusername/your-repo/edit/main/docs/:path'
}
```

## 配置说明

### 主题自定义

主题配置文件位于 `.vitepress/theme/`：

- `index.ts`: 主题入口，可注册全局组件
- `style.css`: 自定义 CSS 样式

### 多语言支持

支持中文和英文两种语言：
- 中文：根目录
- 英文：`en/` 目录

### 搜索配置

使用本地搜索，支持中文全文搜索。

### Markdown 扩展

- 代码高亮
- 代码组
- 提示框（tip/warning/danger）
- 自定义容器
- 表格
- 任务列表
- Emoji 支持

## 技术栈

- **VitePress**: v1.6.0
- **Node.js**: 16.0+
- **TypeScript**: 5.x

## 贡献指南

欢迎贡献文档！请遵循以下步骤：

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

## 许可证

MIT License

## 相关链接

- [VitePress 官方文档](https://vitepress.dev/)
- [MapboxGL 官方文档](https://docs.mapbox.com/mapbox-gl-js/)
- [GitHub 项目](https://github.com/yourusername/mapboxgl-wiki)

## 支持

如有问题或建议，请提交 Issue。