Skip to content

Commit e1f2947

Browse files
authored
docs: Update README.md
1 parent 11f0d7a commit e1f2947

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
# 生成文档网站 (零配置极简版)
22

3-
## 构建过程
3+
## 构建方法
4+
5+
### 两步完成你的文档网站
46

57
1. 复制 .github 文件到你的项目根目录上 (主要使用 `.github/workflows/static.yml`)。此时commit后就会自动构建啦,可能需要稍等一段时间 (在顶部栏中的actions可以看到进度),等待构建完成后进行下一步。
68
2. github的项目页中,以此选择:setting > page > 将 `Source` 设为 `Deploy from a branch`,将 `Branch` 设置为 `gh-pages`,如下图所示。当启用page后,你就可以通过该图中上面给出的链接来访问你的网站了!
79

810
![alt text](./assets/6a664307563c3775cb5c78cd1f3fbc13.png)
911

12+
### 可选:代理库
13+
14+
可选方案:以上方案实现了构建库与笔记库分离,但依然需要往笔记库添加工作流文件。
15+
16+
如果你无法修改笔记库文件,你可以使用另一个方案:建立一个代理仓库。
17+
18+
该仓库中除了需要添加前面说的工作流文件外,还需要往添加一个 `agency` 文件,并将其第一行修改成对应笔记库的克隆地址 (.git结尾那个)。
19+
20+
这样也可以将目标文档库编译成静态文档网站。
21+
22+
### 可选:项目与文档混合的文档库
23+
24+
可选方案:如果你的笔记库不是纯粹的笔记,而是 "项目+文档" 的形式。
25+
26+
也可以,你的文档部分需要在 `docs` 文件夹里,其他项目部分在不要放这个文件夹里,就可以了。
27+
1028
## 一些特殊情况
1129

1230
- 如果文档中有 `agency` 文件,则会选择 `agency` 文件的第一行为仓库地址 (格式为 `https://... .git`),否则选择当前仓库为文档库。所以你除了可以在原仓库的基础上新增工作流,也可以创建一个代理仓库用于生成文档而不必修改原仓库。

0 commit comments

Comments
 (0)