Skip to content

Commit 7be8240

Browse files
authored
docs: Update README.md
1 parent e1f2947 commit 7be8240

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
如果你无法修改笔记库文件,你可以使用另一个方案:建立一个代理仓库。
1717

18-
该仓库中除了需要添加前面说的工作流文件外,还需要往添加一个 `agency` 文件,并将其第一行修改成对应笔记库的克隆地址 (.git结尾那个)。
18+
该仓库中除了需要添加前面说的工作流文件外,还需要往添加一个 `agency` 文件,并将其第一行修改成对应笔记库的克隆地址 (格式为 `https://... .git`)。
1919

2020
这样也可以将目标文档库编译成静态文档网站。
2121

@@ -25,10 +25,10 @@
2525

2626
也可以,你的文档部分需要在 `docs` 文件夹里,其他项目部分在不要放这个文件夹里,就可以了。
2727

28-
## 一些特殊情况
28+
### 前面两个可选方案的原理
2929

30-
- 如果文档中有 `agency` 文件,则会选择 `agency` 文件的第一行为仓库地址 (格式为 `https://... .git`),否则选择当前仓库为文档库。所以你除了可以在原仓库的基础上新增工作流,也可以创建一个代理仓库用于生成文档而不必修改原仓库。
31-
- 如果文档中有 `docs` 文件夹,则会选择 `docs` 文件夹为文档库,否则选择整个仓库内容为文档库。所以你的仓库是纯粹的文档库或是带有文档的项目,都可以用。
30+
- 如果文档中有 `agency` 文件:会选择 `agency` 文件的第一行为仓库地址 (格式为 `https://... .git`),否则选择当前仓库为文档库。所以你除了可以在原仓库的基础上新增工作流,也可以创建一个代理仓库用于生成文档而不必修改原仓库。
31+
- 如果文档中有 `docs` 文件夹:会选择 `docs` 文件夹为文档库,否则选择整个仓库内容为文档库。所以你的仓库是纯粹的文档库或是带有文档的项目,都可以用。
3232

3333
## FAQ (常见问题)
3434

0 commit comments

Comments
 (0)