https://github.com/ruyisdk/docs

Documents for RUYISDK
https://github.com/ruyisdk/docs

Last synced: 2 months ago
JSON representation

Documents for RUYISDK

• Host: GitHub
• URL: https://github.com/ruyisdk/docs
• Owner: ruyisdk
• Created: 2023-06-23T02:01:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-10T05:57:51.000Z (10 months ago)
• Last Synced: 2024-04-10T10:37:33.635Z (10 months ago)
• Size: 7.57 MB
• Stars: 3
• Watchers: 1
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# RuyiSDK docs

文档包括RuyiSDK的总体介绍和各个组成部分的介绍和使用方法。

## 关于docs仓库

### 技术

docs仓库采用vitepress技术将Markdown格式的文档自动生成为web页面，结合github-pages 设置，能够自动将文档更新进行发布。

### 仓库目录介绍

- docs ： Markdown文档；采用分级管理。

- .vitepress/config.mts : 目录索引定义。

### 贡献文档

欢迎大家一起参与RuyiSDK文档贡献。贡献方法：

1. fork 本仓库；

2. 在docs/docs/zh 目录下按需新建目录和markdown文档，或者修改已有的markdown文档；

3. 修改docs/docs/.vitepress/config.mts 文档调整目录；

4. 提交修改并创建pull request将文档贡献提交到docs仓库，等待仓库管理员审核合入；

5. pr被合入后大约几十秒或几分钟后，访问 https://ruyisdk.github.io/docs 检查网页是否更新。

## 访问docs网站

网址：https://ruyisdk.github.io/docs