Skip to content

Commit 79bf809

Browse files
wu-clanwu-clan
authored
Migrating from mkdocs to zensical (#49)
* Migrating from mkdocs to zensical * Update docs ci * Fix lint
1 parent 27e939b commit 79bf809

27 files changed

Lines changed: 651 additions & 874 deletions

‎.github/workflows/docs.yml‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ jobs:
1414
if: github.event.repository.fork == false
1515
steps:
1616
- uses: actions/checkout@v4
17-
1817
- name: Configure Git Credentials
1918
run: |
2019
git config user.name github-actions[bot]
@@ -24,20 +23,20 @@ jobs:
2423
uses: astral-sh/setup-uv@v6
2524

2625
- name: Set up Python
27-
run: uv python install
26+
run: uv python install 3.10
2827

2928
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
3029

3130
- uses: actions/cache@v4
3231
with:
33-
key: mkdocs-material-${{ env.cache_id }}
32+
key: zensical-${{ env.cache_id }}
3433
path: .cache
3534
restore-keys: |
36-
mkdocs-material-
35+
zensical-
3736
38-
- run: sudo apt-get install pngquant
3937
- run: uv sync --group docs
40-
- run: uv run mkdocs gh-deploy --force
38+
- run: uv run zensical build -f zensical.toml --clean
39+
- run: uv run ghp-import -n -p -f site
4140

4241
env:
4342
GH_TOKEN: ${{ secrets.GH_TOKEN }}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ venv/
77
.vscode/
88
.ruff_cache/
99
dist/
10+
site/
1011
.claude/
1112
.coverage
1213
coverage.xml

‎.pre-commit-config.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ repos:
66
- id: check-toml
77

88
- repo: https://github.com/charliermarsh/ruff-pre-commit
9-
rev: v0.15.11
9+
rev: v0.15.14
1010
hooks:
1111
- id: ruff
1212
args:
@@ -15,7 +15,7 @@ repos:
1515
- id: ruff-format
1616

1717
- repo: https://github.com/astral-sh/uv-pre-commit
18-
rev: 0.11.7
18+
rev: 0.11.16
1919
hooks:
2020
- id: uv-lock
2121
- id: uv-export

‎docs/clients/dingtalk.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1-
## 注册账号
1+
# 钉钉
22

3-
地址：[dingtalk](https://n.dingtalk.com/dingding/h5-register/index.html#/)
3+
钉钉登录暂未整理完整接入步骤。
44

5-
如果已有则忽略该步骤，直接进入第二步
5+
## 入口
66

7-
## 创建第三方应用
7+
- 注册：[dingtalk](https://n.dingtalk.com/dingding/h5-register/index.html#/)
88

9-
登录已注册的账号...
9+
## 状态
10+
11+
该客户端目前处于计划中。如你需要此能力，欢迎提交 Issue 或 PR。

‎docs/clients/feishu.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
## 注册账号
1+
# 飞书
22

3-
地址：[feishu](https://www.feishu.cn/accounts/page/ug_register)
3+
用于接入飞书开放平台 OAuth 登录。
44

5-
如果已有则忽略该步骤，直接进入第二步
5+
## 申请步骤
66

7-
## 创建第三方应用
7+
1. 注册或登录 [飞书](https://www.feishu.cn/accounts/page/ug_register)。
8+
2. 进入 [飞书开放平台](https://open.feishu.cn/) 控制台。
89

9-
### 登录
10+
![dev.png](../public/images/feishu/dev.png)
1011

11-
登录[飞书开放平台](https://open.feishu.cn/)，通过主页右上角进入个人设置页
12+
3. 创建应用。
1213

13-
![dev.png](../public/images/feishu/dev.png)
14+
![new.png](../public/images/feishu/new.png)
1415

15-
### 创建应用
16+
4. 配置回调地址。
1617

17-
![new.png](../public/images/feishu/new.png)
18+
![callback.png](../public/images/feishu/callback.png)
1819

19-
配置回调地址
20+
5. 配置所需权限。
2021

21-
![callback.png](../public/images/feishu/callback.png)
22+
![permission.png](../public/images/feishu/permission.png)
2223

23-
配置应用权限
24+
6. 记录应用密钥。
2425

25-
![permission.png](../public/images/feishu/permission.png)
26+
![secrets.png](../public/images/feishu/secrets.png)
2627

27-
### 获取密钥
28+
## 集成需要
2829

29-
![secrets.png](../public/images/feishu/secrets.png)
30-
31-
记录 `Client ID`、`Client Secret`、`重定向 URL`，这三个东西在我们集成的时候都用得到，请妥善保管 `Client ID` 和
32-
`Client Secret`
30+
- `Client ID`
31+
- `Client Secret`
32+
- `重定向 URL`

‎docs/clients/gitee.md‎

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,35 @@
1-
## 注册账号
1+
# Gitee
22

3-
地址：[Gitee](https://gitee.com/)
3+
用于接入 Gitee 第三方登录。
44

5-
如果已有则忽略该步骤，直接进入第二步
5+
## 申请步骤
66

7-
## 创建第三方应用
7+
1. 登录 [Gitee](https://gitee.com/)，进入个人设置页。
88

9-
### 登录
9+
![settings.png](../public/images/gitee/settings.png)
1010

11-
登陆已注册的账号，通过主页右上角进入个人设置页
11+
2. 进入第三方应用页面。
1212

13-
![settings.png](../public/images/gitee/settings.png)
13+
![dev.png](../public/images/gitee/dev.png)
1414

15-
### 创建应用
15+
3. 创建应用。
1616

17-
进入第三方应用界面
17+
![new.png](../public/images/gitee/new.png)
1818

19-
![dev.png](../public/images/gitee/dev.png)
20-
21-
创建应用
22-
23-
![new.png](../public/images/gitee/new.png)
24-
25-
信息输入完成后，点击创建应用
19+
4. 填写应用信息并提交。
2620

2721
!!! warning
2822

29-
切记勾选 `emails` 选项
23+
如需获取邮箱，请勾选 `emails` 权限。
3024

31-
![save.png](../public/images/gitee/save.png)
25+
![save.png](../public/images/gitee/save.png)
3226

33-
### 获取密钥
27+
5. 创建完成后记录密钥。
3428

35-
创建完成后，页面将自动刷新并创建密钥
29+
![secrets.png](../public/images/gitee/secrets.png)
3630

37-
![secrets.png](../public/images/gitee/secrets.png)
31+
## 集成需要
3832

39-
记录 `Client ID`、`Client Secret`、`应用回调地址`，这三个东西在我们集成的时候都用得到，请妥善保管 `Client ID` 和
40-
`Client Secret`
33+
- `Client ID`
34+
- `Client Secret`
35+
- `应用回调地址`

‎docs/clients/github.md‎

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,39 @@
1-
## 注册账号
1+
# GitHub
22

3-
地址：[GitHub](https://github.com/)
3+
用于接入 GitHub OAuth App 登录。
44

5-
如果已有则忽略该步骤，直接进入第二步
5+
## 申请步骤
66

7-
## 创建第三方应用
7+
1. 登录 [GitHub](https://github.com/)，进入个人设置页。
88

9-
### 登录
9+
![settings.png](../public/images/github/settings.png)
1010

11-
登录已注册的账号，通过主页右上角进入个人设置页
11+
2. 进入开发者设置。
1212

13-
![settings.png](../public/images/github/settings.png)
13+
![dev.png](../public/images/github/dev.png)
1414

15-
### 创建应用
15+
3. 创建 OAuth App。
1616

17-
进入开发者界面
17+
![new.png](../public/images/github/new.png)
1818

19-
![dev.png](../public/images/github/dev.png)
19+
4. 填写应用信息：
2020

21-
创建 OAuth app
21+
- `Application name`：应用名称
22+
- `Homepage URL`：应用首页
23+
- `Application description`：应用描述
24+
- `Authorization callback URL`：授权回调地址，例如 `http://localhost:8000/auth/github/callback`
25+
- `Enable Device Flow`：通常不需要勾选
2226

23-
![new.png](../public/images/github/new.png)
27+
5. 提交创建。
2428

25-
- `Application name` 填写自己的网站名称
26-
- `Homepage URL` 填写自己的网站首页地址
27-
- `Application description` 填写自己的应用描述
28-
- `Authorization callback URL` 用户授权后的跳转地址，通常情况下，开发者需要在此路由代码中实现用户注册、绑定等操作
29-
- `Enable Device Flow` 不需要勾选
29+
![save.png](../public/images/github/save.png)
3030

31-
信息输入完成后，点击下方绿色的 ==`Register applaction`== 按钮创建应用
31+
6. 在应用详情页创建并记录密钥。
3232

33-
![save.png](../public/images/github/save.png)
33+
![secrets.png](../public/images/github/secrets.png)
3434

35-
### 创建密钥
35+
## 集成需要
3636

37-
创建完成后，进入应用详情页
38-
39-
![secrets.png](../public/images/github/secrets.png)
40-
41-
记录 `Client ID`、`Client Secret`、`Authorization callback URL`，这三个东西在我们集成的时候都用得到，请妥善保管 `Client ID`
42-
和 `Client Secret`
37+
- `Client ID`
38+
- `Client Secret`
39+
- `Authorization callback URL`

‎docs/clients/google.md‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
1-
## 创建第三方应用
1+
# Google
22

3-
### 登录
3+
用于接入 Google OAuth 2.0 登录。
44

5-
登录 Google 开发者中心：[console.developers.google](https://console.developers.google.com/apis/dashboard)
5+
## 申请步骤
66

7-
### 创建项目
7+
1. 登录 [Google 开发者中心](https://console.developers.google.com/apis/dashboard)。
8+
2. 创建或选择项目。
89

9-
![new.png](../public/images/google/dev.png)
10+
![dev.png](../public/images/google/dev.png)
1011

11-
创建凭据
12+
3. 创建 OAuth 客户端凭据。
1213

13-
![new.png](../public/images/google/new.png)
14+
![new.png](../public/images/google/new.png)
1415

15-
信息输入完成后，点击创建应用
16+
4. 填写应用信息和重定向 URI。
1617

17-
![save.png](../public/images/google/save.png)
18+
![save.png](../public/images/google/save.png)
1819

19-
### 获取密钥
20+
5. 创建完成后记录密钥。
2021

21-
创建完成后，页面将自动刷新并创建密钥
22+
![secrets.png](../public/images/google/secrets.png)
2223

23-
![secrets.png](../public/images/google/secrets.png)
24+
## 集成需要
2425

25-
记录 `客户端ID`、`客户端密钥`、`重定向 URI`，这三个东西在我们集成的时候都用得到，请妥善保管 `客户端ID` 和 `客户端密钥`
26+
- `客户端 ID`
27+
- `客户端密钥`
28+
- `重定向 URI`

‎docs/clients/linuxdo.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
1-
## 注册账号
1+
# LinuxDo
22

3-
地址：[LinuxDo](https://linux.do/)
3+
用于接入 LinuxDo Connect 登录。
44

5-
如果已有则忽略该步骤，直接进入第二步
5+
## 申请步骤
66

7-
## 创建第三方应用
7+
1. 登录 [LinuxDo](https://linux.do/)，从左侧进入 Connect 页面。
88

9-
### 登录
9+
![connect.png](../public/images/linuxdo/connect.png)
1010

11-
登录已注册的账号，通过主页左侧 Connect 进入 connect 页面
11+
2. 进入开发者页面。
1212

13-
![connect.png](../public/images/linuxdo/connect.png)
13+
![dev.png](../public/images/linuxdo/dev.png)
1414

15-
### 创建应用
15+
3. 申请新接入。
1616

17-
进入开发者界面
17+
![new.png](../public/images/linuxdo/new.png)
1818

19-
![dev.png](../public/images/linuxdo/dev.png)
19+
4. 填写信息并保存。
2020

21-
申请新接入
21+
![save.png](../public/images/linuxdo/save.png)
2222

23-
![new.png](../public/images/linuxdo/new.png)
23+
5. 在应用详情页记录密钥。
2424

25-
信息输入完成后，点击下方蓝色的 ==`保存`== 按钮创建应用
25+
![secrets.png](../public/images/linuxdo/secrets.png)
2626

27-
![save.png](../public/images/linuxdo/save.png)
27+
## 集成需要
2828

29-
创建完成后，进入应用详情页
30-
31-
![secrets.png](../public/images/linuxdo/secrets.png)
32-
33-
记录 `Client ID`、`Client Secret`、`回调地址`，这三个东西在我们集成的时候都用得到，请妥善保管 `Client ID` 和 `Client Secret`
29+
- `Client ID`
30+
- `Client Secret`
31+
- `回调地址`

‎docs/clients/oschina.md‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
1-
## 注册账号
1+
# 开源中国
22

3-
地址：[oschina](https://www.oschina.net/)
3+
用于接入 OSChina 第三方登录。
44

5-
如果已有则忽略该步骤，直接进入第二步
5+
## 申请步骤
66

7-
## 创建第三方应用
7+
1. 登录 [开源中国](https://www.oschina.net/)。
8+
2. 从页脚进入开放平台或文档入口。
89

9-
### 登录
10+
![settings.png](../public/images/oschina/settings.png)
1011

11-
登录已注册的账号，通过页脚进入文档页
12+
3. 创建应用。
1213

13-
![settings.png](../public/images/oschina/settings.png)
14+
![new.png](../public/images/oschina/new.png)
1415

15-
### 创建应用
16+
4. 填写信息并确认添加。
1617

17-
![new.png](../public/images/oschina/new.png)
18+
![save.png](../public/images/oschina/save.png)
1819

19-
信息输入完成后，点击确认添加
20+
5. 创建完成后记录密钥。
2021

21-
![save.png](../public/images/oschina/save.png)
22+
![secrets.png](../public/images/oschina/secrets.png)
2223

23-
### 获取密钥
24+
## 集成需要
2425

25-
创建完成后，页面将自动刷新并创建密钥
26-
27-
![secrets.png](../public/images/oschina/secrets.png)
28-
29-
记录 `应用ID`、`应用私钥`、`回调地址`，这三个东西在我们集成的时候都用得到，请妥善保管 应用ID 和 应用私钥
26+
- `应用 ID`
27+
- `应用私钥`
28+
- `回调地址`

0 commit comments

Comments
 (0)