# yuanshendocs

**Repository Path**: KYJGYSDT/yuanshendocs

## Basic Information

- **Project Name**: yuanshendocs
- **Description**: 空荧地图文档仓库。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://yuanshen.site/docs/
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 2
- **Created**: 2021-06-07
- **Last Updated**: 2024-05-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: vue3, vuepress2, yuanshen, genshinmap, vite

## README

# 原神地图文档

[![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/jiazengp/genshinmap-docs)
![GitHub Repo stars](https://img.shields.io/github/stars/jiazengp/GenshinMapDocs)
[![Star](https://gitee.com/KYJGYSDT/yuanshendocs/badge/star.svg?theme=dark)](https://gitee.com/KYJGYSDT/yuanshendocs/stargazers)
[![Release Deployment](https://github.com/jiazengp/genshinmap-docs/actions/workflows/deployment.yml/badge.svg)](https://github.com/jiazengp/genshinmap-docs/actions/workflows/deployment.yml)
[![CodeQL](https://github.com/jiazengp/genshinmap-docs/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/jiazengp/genshinmap-docs/actions/workflows/codeql-analysis.yml)
![Top Language](https://img.shields.io/github/languages/top/jiazengp/GenshinMapDocs)]
[![license](https://img.shields.io/badge/license-MIT-green)](https://gitee.com/KYJGYSDT/yuanshendocs/blob/master/LICENSE)
[![node](https://img.shields.io/badge/node-%3E%3D%2012.0.0-brightgreen)](https://nodejs.org/)
[![types](https://img.shields.io/npm/types/ts)](https://img.shields.io/npm/types/ts)

[English](./README.md) | [日本語](./README.ja.md)| 简体中文

## 状态

W.I.P.

## 开发

```shell
# install dependencies

yarn

# run in dev mode

cd yuanshenmap-docs
yarn docs:dev

# run in build

yarn docs:build2
```

## 文档

见 [Documentation](https://yuanshen.site/docs/developer/documentation)。

## 贡献指南

见 [Contributing Guide](https://yuanshen.site/docs/contributing.html)。

## 计划

有关于我们未来的计划 [roadmap](https://yuanshen.site/docs/developer/documentation/roadmap.html)。

## 许可证

MIT