Skip to content

Commit 71c75dd

Browse files
committed
add README
1 parent 74ee138 commit 71c75dd

File tree

3 files changed

+33
-4
lines changed

3 files changed

+33
-4
lines changed

.github/workflows/docs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
branches:
66
- main
77
paths:
8-
- '**' # 监控所有文件变化
8+
- '**'
99

1010
jobs:
1111
deploy:
@@ -20,12 +20,13 @@ jobs:
2020

2121
- name: Install dependencies
2222
run: |
23-
npm install -g gitbook-cli
24-
gitbook install
23+
npm init -y
24+
npm install honkit --save-dev
25+
npm install
2526
2627
- name: Build documentation
2728
run: |
28-
gitbook build
29+
npx honkit build
2930
3031
- name: Deploy to GitHub Pages
3132
uses: peaceiris/actions-gh-pages@v3

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# GoBatch 文档
2+
3+
这是 GoBatch 批处理框架的官方文档仓库。
4+
5+
## 在线文档
6+
7+
访问 [https://chararch.github.io/gobatch-doc](https://chararch.github.io/gobatch-doc) 查看在线文档。
8+
9+
---
10+
11+
# GoBatch Documentation
12+
13+
This is the official documentation repository for the GoBatch processing framework.
14+
15+
## Online Documentation
16+
Visit [https://chararch.github.io/gobatch-doc](https://chararch.github.io/gobatch-doc) to view the online documentation.

package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"name": "gobatch-doc",
3+
"version": "1.0.0",
4+
"description": "GoBatch Documentation",
5+
"scripts": {
6+
"serve": "honkit serve",
7+
"build": "honkit build"
8+
},
9+
"devDependencies": {
10+
"honkit": "^4.0.0"
11+
}
12+
}

0 commit comments

Comments
 (0)