# krpanoDocumentation

**Repository Path**: lith02/krpano-documentation

## Basic Information

- **Project Name**: krpanoDocumentation
- **Description**: krpano中文文档
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-12-15
- **Last Updated**: 2026-01-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# krpano 中文文档网 - 前端项目说明
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

## 项目介绍
本项目是 **krpano 中文文档网** 的前端实现，旨在为国内开发者提供清晰、完整、易理解的 krpano 全景开发中文参考文档，解决官方文档英文门槛高、内容分散的问题。
网站集成了 krpano 核心语法、API 解析、案例演示、常见问题解答等内容，适配 PC/移动端访问，支持文档检索、目录锚点跳转等便捷功能。

✨ 在线访问：[krpano 中文文档网](https://www.krpano720.top/dist/#/welcome)（目前网站正在建设中）

## 核心功能
- 📚 完整覆盖 krpano 官方文档核心内容的中文翻译与解析
- 🔍 文档关键词检索，快速定位所需知识点
- 🔗 目录锚点联动，文档阅读体验优化
- 🧩 集成 krpano 示例代码在线预览/复制功能
- ⚡ 轻量加载，基于 CDN 加速静态资源

## 技术栈
| 技术/框架       | 用途                     |
|----------------|--------------------------|
| Vue 3 (Composition API) | 前端核心框架             |
| Vite           | 构建工具 & 开发服务器    |
| Vue Router     | 路由管理                 |
| Pinia          | 状态管理（检索/主题等）|
| Tailwind CSS   | 样式开发                 |
| Axios          | 接口请求（检索/文档数据） |
| highlight.js   | 代码高亮                 |

## 快速开始
### 环境要求
- nodejs：版本20+
- vite：较新版本(5.0.0)
- npm/yarn 

### 安装与运行
```bash
# 克隆项目
git clone https://gitee.com/lith02/krpano-documentation.git

# 进入项目目录
cd krpanoDocumentation

# 安装依赖
npm install 或 yarn install

# 本地开发
vite serve

# 打包构建
vite build

```

### 目录结构
```
├── public/          # 静态资源（krpano 示例文件、图标等）
├── src/
│   ├── assets/      # 样式、图片、字体等资源
│   ├── components/  # 通用组件（搜索框、目录、代码块等）
│   ├── router/      # 路由配置（文档分类/详情页）
│   ├── stores/      # Pinia 状态（检索关键词、主题等）
│   ├── views/       # 页面视图（首页、文档页、404等）
│   ├── main.js      # 入口文件
│   └── style.css    # 全局样式
├── .env.development # 开发环境配置
├── .env.production  # 生产环境配置
├── vite.config.js   # Vite 配置
└── package.json     # 依赖与脚本
```

## 部署说明
### 静态部署
1. 执行 `vite build` 生成 `dist` 目录；
2. 将 `dist` 目录上传至 Nginx/Apache/OSS 等静态服务器；
3. 配置服务器伪静态（Vue Router 历史模式）：
   ```nginx
   # Nginx 示例配置
   location / {
     try_files $uri $uri/ /index.html;
     root /usr/share/nginx/html/krpano-docs;
     index index.html;
   }
   ```

### 容器部署（可选）
```bash
# 构建镜像
docker build -t krpano-docs-cn:latest .

# 运行容器
docker run -d -p 8080:80 krpano-docs-cn:latest
```

## 贡献指南
### 文档纠错/补充
1. Fork 本仓库；
2. 修改 `src/assets/docs/` 下的文档数据文件；
3. 提交 PR（注明修改内容/原因）。

### 功能开发
1. 遵循项目代码规范（ESLint + Prettier）；
2. 新增功能需配套编写注释与示例；
3. 确保多终端适配性。

## 推广与支持
如果本文档对你的 krpano 开发有帮助，欢迎：
1. 🌟 Star 本仓库，让更多开发者看到；
2. 🔗 转发分享 [krpano 中文文档网](https://www.krpano720.top/dist/#/welcome) 给有需要的同行；
3. 🐞 提交 Issue 反馈问题/建议，帮助文档持续完善。

## 免责声明
- 本网站为 krpano 非官方中文文档，内容基于 krpano 官方文档翻译/解析，版权归 krpano 官方所有；
- 文档内容仅供学习交流使用，请勿用于商业侵权场景。

## 联系方式

---
⭐ 欢迎使用 krpano 中文文档网，让全景开发更简单！  
👉 官网地址：[https://www.krpano720.top/dist/#/welcome]