Skip to content

Commit 9b974e4

Browse files
YangRuchengYangRucheng
authored
docs(github_releases): update docs (#409)
1 parent ed46b34 commit 9b974e4

2 files changed

Lines changed: 260 additions & 0 deletions

File tree

‎docs/guide/drivers/github_releases.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 41
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "302"
14+
# this page is sticky in article list
15+
sticky: true
16+
# this page will appear in starred articles
17+
star: true
18+
---
19+
# GitHub Releases
20+
21+
:::tip
22+
GitHub API rate limits: The primary rate limit for unauthenticated requests is 60 requests per hour. Making API requests using a personal access token counts toward your personal rate limit of 5,000 requests per hour.
23+
:::
24+
25+
## Repo Structure
26+
27+
:::tabs#UrlTree
28+
@tab 1
29+
30+
The simplest usage is to directly write `owner/repository`, only one can be filled in.
31+
32+
##### Input
33+
34+
```
35+
alistGo/alist
36+
```
37+
38+
The effect is the same as the following:
39+
```
40+
/:alistGo/alist
41+
```
42+
43+
@tab 2
44+
45+
Mount to a subdirectory, you can mount multiple repositories
46+
47+
##### Input
48+
49+
```
50+
/alist-gh:alistGo/alist
51+
/alist-web-gh:alistGo/alist-web
52+
```
53+
54+
The leading `/` can be omitted:
55+
56+
```
57+
alist-gh:alistGo/alist
58+
alist-web-gh:alistGo/alist-web
59+
```
60+
61+
:::
62+
63+
## Show README file
64+
65+
Off switch：
66+
```
67+
alist/
68+
├── alist-linux-amd64.tar.gz
69+
└── alist-windows-amd64.zip
70+
```
71+
72+
On switch：
73+
```
74+
alist/
75+
├── alist-linux-amd64.tar.gz
76+
├── alist-windows-amd64.zip
77+
├── README.md
78+
├── README_cn.md
79+
└── LICENSE
80+
```
81+
82+
If enabled, the total size and modification time of the folder will not be displayed.
83+
84+
## Token
85+
86+
Required when accessing private repositories, and can also reduce the impact of rate limits.
87+
88+
Log in GitHub and visit: <https://github.com/settings/tokens>
89+
90+
## Show all version
91+
92+
Off switch:
93+
```
94+
alist/
95+
├── alist-linux-amd64.tar.gz
96+
└── alist-windows-amd64.zip
97+
```
98+
99+
On switch：
100+
```
101+
alist/
102+
├── v3.41.0/
103+
│ ├── alist-linux-amd64.tar.gz
104+
│ └── alist-windows-amd64.zip
105+
├── v3.40.0/
106+
│ ├── alist-linux-amd64.tar.gz
107+
│ └── alist-windows-amd64.zip
108+
└── v3.39.4/
109+
├── alist-linux-amd64.tar.gz
110+
└── alist-windows-amd64.zip
111+
```
112+
113+
### **The default download method used**
114+
115+
```mermaid
116+
---
117+
title: Which download method is used by default?
118+
---
119+
flowchart TB
120+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
121+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
122+
subgraph ide1 [ ]
123+
a1
124+
end
125+
a1[302]:::someclass====|default|a2[user equipment]
126+
classDef someclass fill:#f96
127+
c1[local proxy]-.alternative.->a2[user equipment]
128+
click a1 "../drivers/common.html#webdav-policy"
129+
click b1 "../drivers/common.html#webdav-policy"
130+
```
131+

‎docs/zh/guide/drivers/github_releases.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
# This is the icon of the page
3+
icon: iconfont icon-state
4+
# This control sidebar order
5+
order: 41
6+
# A page can have multiple categories
7+
category:
8+
- Guide
9+
# A page can have multiple tags
10+
tag:
11+
- Storage
12+
- Guide
13+
- "302"
14+
# this page is sticky in article list
15+
sticky: true
16+
# this page will appear in starred articles
17+
star: true
18+
---
19+
# GitHub Releases
20+
21+
:::tip
22+
GitHub API 速率限制：未经身份验证的请求的主要速率限制为每小时 60 个请求。使用个人访问令牌发出 API 请求计入您每小时 5000 个请求的个人速率限制。
23+
:::
24+
25+
## 仓库结构
26+
27+
:::tabs#UrlTree
28+
@tab 1
29+
30+
最简单的用法，直接写 `所有者/仓库`，只能填一个
31+
32+
##### 输入
33+
34+
```
35+
alistGo/alist
36+
```
37+
38+
与下面的写法效果一致：
39+
```
40+
/:alistGo/alist
41+
```
42+
43+
@tab 2
44+
45+
挂载到子目录，可以挂多个仓库
46+
47+
##### 输入
48+
49+
```
50+
/alist-gh:alistGo/alist
51+
/alist-web-gh:alistGo/alist-web
52+
```
53+
54+
最前面的 `/` 可以省略：
55+
56+
```
57+
alist-gh:alistGo/alist
58+
alist-web-gh:alistGo/alist-web
59+
```
60+
61+
:::
62+
63+
## 显示 README、LICENSE 文件
64+
65+
开启前：
66+
```
67+
alist/
68+
├── alist-linux-amd64.tar.gz
69+
└── alist-windows-amd64.zip
70+
```
71+
72+
开启后：
73+
```
74+
alist/
75+
├── alist-linux-amd64.tar.gz
76+
├── alist-windows-amd64.zip
77+
├── README.md
78+
├── README_cn.md
79+
└── LICENSE
80+
```
81+
82+
开启后，不显示文件夹总大小和修改时间。
83+
84+
## 令牌
85+
86+
访问私有仓库时需要，也可减少速率访问限制的影响。访问：<https://github.com/settings/tokens>
87+
88+
## 显示所有版本
89+
90+
开启前：
91+
```
92+
alist/
93+
├── alist-linux-amd64.tar.gz
94+
└── alist-windows-amd64.zip
95+
```
96+
97+
开启后：
98+
```
99+
alist/
100+
├── v3.41.0/
101+
│ ├── alist-linux-amd64.tar.gz
102+
│ └── alist-windows-amd64.zip
103+
├── v3.40.0/
104+
│ ├── alist-linux-amd64.tar.gz
105+
│ └── alist-windows-amd64.zip
106+
└── v3.39.4/
107+
├── alist-linux-amd64.tar.gz
108+
└── alist-windows-amd64.zip
109+
```
110+
111+
### **默认使用的下载方式**
112+
113+
```mermaid
114+
---
115+
title: 默认使用的哪种下载方式？
116+
---
117+
flowchart TB
118+
style a1 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff
119+
style a2 fill:#ff7575,stroke:#333,stroke-width:4px
120+
subgraph ide1 [ ]
121+
a1
122+
end
123+
a1[302]:::someclass====|默认|a2[用户设备]
124+
classDef someclass fill:#f96
125+
c1[本机代理]-.备选.->a2[用户设备]
126+
click a1 "../drivers/common.html#webdav-策略"
127+
click b1 "../drivers/common.html#webdav-策略"
128+
```
129+

0 commit comments

Comments
 (0)