Skip to content

Commit 9943226

Browse files
authored
docs: Update README.md
1 parent 5f21213 commit 9943226

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,34 @@
44

55
## 构建方法
66

7-
### 两步完成你的文档网站
7+
两步完成你的文档网站
88

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

1212
![alt text](./assets/6a664307563c3775cb5c78cd1f3fbc13.png)
1313

14+
## 功能
15+
16+
对比其他文档部署框架有什么优点?为什么选用 LincDocs Workflow?
17+
18+
- 更适配obsidian:
19+
对部分obsidian特性与插件进行支持。如anyblock、callout语法、wiki双链、关系图谱等
20+
- 操作简单,无需配置,开箱即用:
21+
两步完成,工作流会自动根据仓库添加需要的配置
22+
- 零添加,无配置,无污染:
23+
构建库与文档库分离,单工作流文件部署。不需要添加配置文件以及对文档仓库进行污染。
24+
- 迁移支持优化:
25+
支持从obsidian中迁移、支持识别mdBook的 `SUMMARY.md` 文件作为目录。只要你拥有一个markdown笔记库,就能轻松构建自己的在线文档!
26+
- 强大搜索:
27+
像 mdBook 就只能搜索英文
28+
- 插件丰富:
29+
除前面说到的部分obsidian扩展外,还支持 mermaid、plantuml、markdown-it-container 等
30+
- 支持扩展、自定义
31+
想要更多的功能,可以创建github,可以fork编译系统并自行修改
32+
33+
## 构建方法 - 可选
34+
1435
### 可选:代理库
1536

1637
可选方案:以上方案实现了构建库与笔记库分离,但依然需要往笔记库添加工作流文件。
@@ -56,3 +77,5 @@
5677
略,提issue,有人问我再回
5778
- 我没有在这里找到我的问题?
5879
在issue中搜索看是否有人问过相同的问题,看是否能解决。若没有,则提issue
80+
- 还有其他好用的单工作流部署系统吗?
81+
github默认的jekyll、python的mkdocs-material、mdBook、cookbook 等

0 commit comments

Comments
 (0)