Skip to content

Commit fd4bf8c

Browse files
committed
update readme
1 parent 4430aa3 commit fd4bf8c

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# swanlab-docs
22

3+
[![](./assets/readme-1.png)](https://docs.swanlab.cn)
4+
35
为项目贡献的方式不仅仅是贡献代码,包括维护文档、在issue和群中答疑、提交bug等都是为swanlab项目贡献的方式!
46

57
我们在[github仓库](https://github.com/SwanHubX/SwanLab-Docs)中托管了SwanLab的[官方文档](https://docs.swanlab.cn),基于[vitepress](https://vitepress.dev/zh/guide/getting-started)
@@ -14,6 +16,7 @@
1416

1517
```bash
1618
git clone https://github.com/SwanHubX/SwanLab-Docs
19+
cd SwanLab-Docs
1720
```
1821

1922
2. 安装依赖环境
@@ -24,6 +27,7 @@ git clone https://github.com/SwanHubX/SwanLab-Docs
2427

2528
```bash
2629
npm add -D vitepress
30+
npm install
2731
```
2832

2933
### 本地运行文档

assets/readme-1.png

755 KB
Loading

0 commit comments

Comments
 (0)