Skip to content

Commit 6704cd8

Browse files
committed
New Crowdin translations by GitHub Action
1 parent 128f0cc commit 6704cd8

9 files changed

Lines changed: 250 additions & 29 deletions

File tree

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@
44
55
## 概述
66

7-
docsify 可以快速帮你生成文档网站。 不同于 GitBook 的地方是它不会生成静态的 `.html` 文件。 相反,它能智能加载和解析 Markdown 文件,并将其显示为网站。 要开始使用它,只需创建一个 `index.html` 并将其[部署到 GitHub Pages](zh-cn/deploy.md)
8-
9-
查看[快速开始](zh-cn/quickstart.md)了解详情。
7+
Docsify turns your Markdown files into a documentation website instantly. Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an `index.html` file and [deploy it on GitHub Pages](deploy.md) (for more details see the [Quick start](quickstart.md) guide).
108

119
## 特性
1210

13-
- 没有静态生成的 html 文件
11+
- No statically built HTML files
1412
- 简单和轻量
1513
- 智能的全文搜索
1614
- 提供多套主题

_sidebar.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,9 @@
2727
- [文件嵌入](zh-cn/embed-files.md)
2828
- [UI Kit](zh-cn/ui-kit.md)
2929

30+
- 升级
31+
32+
- [v4 到 v5](zh-cn/v5-upgrade.md)
33+
3034
* [Awesome docsify](zh-cn/awesome.md)
3135
* [Changelog](zh-cn/changelog.md)

configuration.md

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,22 @@ window.$docsify = {
240240
};
241241
```
242242

243+
## fallbackDefaultLanguage
244+
245+
- 类型:`String`
246+
- 默认:`''`
247+
248+
当请求的页面不存在给定的语言时,Docsify 将回退到此选项指定的语言。
249+
250+
例如,在上述情况下,如果 `/de/overview` 不存在,而 `fallbackDefaultLanguage` 被配置为 `zh-cn`,Docsify 将获取 `/zh-cn/overview` 而不是 `/overview`
251+
252+
```js
253+
window.$docsify = {
254+
fallbackLanguages: ['fr', 'de'],
255+
fallbackDefaultLanguage: 'zh-cn', // default: ''
256+
};
257+
```
258+
243259
## formatUpdated
244260

245261
- 类型:`String|Function`
@@ -262,7 +278,7 @@ window.$docsify = {
262278
## hideSidebar
263279

264280
- 类型:`Boolean`
265-
- 默认:`true`
281+
- 默认:`false`
266282

267283
该选项将完全隐藏侧边栏,不会在侧边栏显示任何内容。
268284

@@ -390,7 +406,7 @@ window.$docsify = {
390406

391407
- 类型:`Function`
392408

393-
参考 [Markdown 配置](zh-cn/markdown.md)
409+
请参见 [Markdown 配置](zh-cn/markdown.md)
394410

395411
```js
396412
window.$docsify = {
@@ -440,7 +456,7 @@ window.$docsify = {
440456

441457
## name
442458

443-
- 类型:`String`
459+
- 类型:`Boolean | String`
444460

445461
在侧边栏中显示的网站名称。
446462

@@ -458,6 +474,22 @@ window.$docsify = {
458474
};
459475
```
460476

477+
如果`true`, 网站名称将从文档的 `<title>` 标签中推出。
478+
479+
```js
480+
window.$docsify = {
481+
name: true,
482+
};
483+
```
484+
485+
如果 `false` 或为空,则不显示名称。
486+
487+
```js
488+
window.$docsify = {
489+
name: false,
490+
};
491+
```
492+
461493
## nameLink
462494

463495
- 类型:`String`
@@ -518,7 +550,7 @@ window.$docsify = {
518550
<span class="emoji">👎︎</span>
519551
</output>
520552

521-
要渲染短代码作为文本,用“&colon;”HTML实体替换`:`字符
553+
要渲染短代码作为文本,请将 `:` 字符替换为 `&colon;` HTML 实体
522554

523555
```markdown
524556
&colon;100&colon;
@@ -636,6 +668,10 @@ window.$docsify = {
636668
};
637669
```
638670

671+
## plugins
672+
673+
请参见[插件列表](zh-cn/plugins.md)
674+
639675
## relativePath
640676

641677
- 类型:`Boolean`
@@ -690,6 +726,8 @@ window.$docsify = {
690726
};
691727
```
692728

729+
如果未定义或为空,则不显示 GitHub corner。
730+
693731
## requestHeaders
694732

695733
- 类型:`Object`
@@ -841,9 +879,9 @@ window.$docsify = {
841879
决定是否/如何显示网站的 [skip navigation link](https://webaim.org/techniques/skipnav/)
842880

843881
```js
844-
// Render skip link for all routes (default)
882+
// Render skip link for all routes
845883
window.$docsify = {
846-
skipLink: 'Skip to main content',
884+
skipLink: 'Skip to content',
847885
};
848886
```
849887

@@ -866,6 +904,13 @@ window.$docsify = {
866904
};
867905
```
868906

907+
```js
908+
// Use default
909+
window.$docsify = {
910+
skipLink: true, // "Skip to main content"
911+
};
912+
```
913+
869914
## subMaxLevel
870915

871916
- 类型:`Number`

deploy.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,3 +213,30 @@ frontend:
213213
- Publish directory:`docs`
214214

215215
6. 点击**Create site**。
216+
217+
## DeployHQ
218+
219+
[DeployHQ](https://www.deployhq.com/) 是一个部署自动化平台,可将你的代码部署到 SSH/SFTP 服务器、FTP 服务器、云存储(亚马逊 S3、Cloudflare R2)和现代托管平台(Netlify、Heroku)。
220+
221+
> [!IMPORTANT] DeployHQ 不会托管你的网站。 它能自动将 Docsify 文件部署到你选择的托管服务提供商或服务器上。
222+
223+
使用 DeployHQ 部署 Docsify 网站:
224+
225+
1. 注册 [DeployHQ 账户](https://www.deployhq.com/) 并验证你的电子邮件。
226+
227+
2. 点击 **Projects** 和 **New Project**,创建第一个项目。 连接 Git 仓库(GitHub、GitLab、Bitbucket 或任何私有仓库)。 授权 DeployHQ 访问你的版本库。
228+
229+
3. 添加服务器并输入服务器详细信息:
230+
231+
- 给你的服务器一个名称
232+
- 选择协议(SSH/SFTP、FTP 或云平台)
233+
- 输入服务器主机名、用户名和密码/SSH 密钥
234+
- 设置 **Deployment Path** 到你的 web 根目录(例如,`public_html/`)
235+
236+
4. 由于 Docsify 不需要构建步骤,你可以直接部署文件。 如果你的 Docsify 文件在 `docs/` 文件夹中,配置你的服务器设置中的 **Source Path** 到 `docs/`。
237+
238+
5. 单击 **Deploy Project**,然后选择服务器并单击 **Deploy**,开始首次部署。
239+
240+
你的 Docsify 网站将部署到你的服务器上。 你可以启用自动部署功能,在每次 Git 推送时进行部署,也可以安排在特定时间进行部署。
241+
242+
有关高级部署功能的更多信息,请参阅 [DeployHQ 文档](https://www.deployhq.com/support)。

embed-files.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,21 @@ Front Matter 通常在 Jekyl 等博客系统中使用,用于定义文档的元
6565
```
6666

6767
在你的代码文件中,你需要用斜线 `/// [demo]` 包裹该片段(片段的前后都要有)。
68-
或者你也可以使用 `### [demo]`
68+
或者你也可以使用 `### [demo]` 默认情况下,只省略标识符。 要省略片段输出中包含标识符的整行,请添加 `:omitFragmentLine` 选项。 如你的代码片段是 HTML 等,而你想隐藏 Docsify 片段标识符,使其不显示在 HTML 源代码中,则此功能非常有用。 <!-- /// [demo] -->`在源文件中,而`:omitFragmentLine `将使`-->\` 不显示在 Docsify 代码片段中。
6969

70-
示例:
70+
示例:在源文件 \_media/example.js 中,包含了 `/// [demo]` 标识符:
71+
72+
```markdown
73+
[filename](../_media/example.js ':include :type=code')
74+
```
75+
76+
[filename](../_media/example.js ":include :type=code")
77+
78+
添加 `:fragment=demo` 的结果如下:
79+
80+
```markdown
81+
[filename](../_media/example.js ':include :type=code :fragment=demo')
82+
```
7183

7284
[filename](../_media/example.js ":include :type=code :fragment=demo")
7385

plugins.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# 插件列表
22

3+
这些是 Docsify 的内置和外部插件。
4+
5+
也可以参阅如何[编写插件](zh-cn/write-a-plugin.md)
6+
37
## 全文搜索
48

59
默认情况下,当前页面上的超链接会被识别,内容会被保存到 `IndexedDB`。 你也可以指定文件的路径。
@@ -26,7 +30,7 @@
2630
insertBefore: '.sidebar-nav', // CSS selector in .sidebar scope
2731
2832
maxAge: 86400000, // Expiration time, the default one day
29-
paths: [], // or 'auto'
33+
paths: [], // string[] of files to search in, or 'auto' for discovery based on your sidebar
3034
placeholder: 'Type to search',
3135
3236
// Localization

quickstart.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ docsify init ./docs
2222
- `README.md` 会做为主页内容渲染
2323
- `.nojekyll` 用于阻止 GitHub Pages 忽略掉下划线开头的文件
2424

25-
直接编辑 `docs/README.md` 就能更新文档内容,当然也可以[添加更多页面](zh-cn/adding-pages)
25+
直接编辑 `docs/README.md` 就能更新文档内容,当然也可以[添加更多页面](zh-cn/adding-pages.md)
2626

2727
## 本地预览
2828

@@ -91,7 +91,7 @@ docsify serve docs
9191
<script src="//cdn.jsdelivr.net/npm/docsify@5"></script>
9292
```
9393

94-
如果你希望将 docsify 锁定到特定版本,请在 URL 中的 `@` 符号后指定完整版本。 这是最安全的方法,可确保无论 docsify 的未来版本如何更改,你的网站都将以相同的方式显示和运行。
94+
如果您想确保绝对不会出现会破坏网站的更改(非主要更新可能会无意中引入破坏性更改,尽管它们的目的不是这样),请在 URL 中的 `@` 符号后指定完整版本。 这是最安全的方法,可确保无论 docsify 的未来版本如何更改,你的网站都将以相同的方式显示和运行。
9595

9696
<!-- prettier-ignore -->
9797

@@ -103,9 +103,11 @@ docsify serve docs
103103
<script src="//cdn.jsdelivr.net/npm/docsify@5.0.0"></script>
104104
```
105105

106+
JSDelivr 支持 [npm-compatible semver ranges](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#dependencies),因此也可以使用版本语法,例如 `@^5.0.0` 表示最新的 v5 版本,`@5.0.x` 表示最新的 v5.0 补丁版本(例如 你将收到 5.0.4,但不是 5.1.0),`@5.x` 表示最新的 v5 次版本和补丁版本(实际上与 `@5``@^5.0.0` 相同),等等。
107+
106108
### 手动预览你的网站
107109

108-
如果你的系统里安装了 Python 的话,也可以很容易地启动一个静态服务器去预览你的网站
110+
如果你的系统上安装了 Python,你可以很容易地使用它来运行静态服务器来预览你的网站,而不是使用 `docsify-cli` 中的 `docsify serve`
109111

110112
```python
111113
# Python 2

themes.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
1111
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/core.min.css" />
1212
```
1313

14-
## 主题附加组件
14+
## 主题附加组件 :id=theme-add-ons
1515

1616
主题附加组件与[核心主题](#core-theme)结合使用。 附加组件包含修改[主题属性](#theme-properties)值和/或添加自定义样式声明的 CSS 规则。 它们通常(但不总是)可以与其他附加组件一起使用。
1717

@@ -27,7 +27,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
2727
<link rel="stylesheet" href="..." />
2828
```
2929

30-
### 核心深色(附加组件)
30+
### 核心深色(附加组件) :id=core-dark-add-on
3131

3232
[核心主题](#core-theme)的深色模式样式。 只有在操作系统的暗模式激活时,才能通过指定 `media` 属性来应用样式。
3333

@@ -67,7 +67,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
6767
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/addons/core-dark.min.css" media="(prefers-color-scheme: dark)" />
6868
```
6969

70-
### Vue 主题(附加组件)
70+
### Vue 主题(附加组件) :id=vue-theme-add-on
7171

7272
备受欢迎的 Docsify v4 主题。
7373

@@ -89,7 +89,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
8989
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/dist/themes/addons/vue.min.css" />
9090
```
9191

92-
##
92+
## :id=classes
9393

9494
[核心主题](#core-theme)提供了多个 CSS 类,用于自定义 Docsify 网站。 这些类应用于 `index.html` 页面中的 `<body>` 元素。
9595

@@ -99,7 +99,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
9999
<body class="...">
100100
```
101101

102-
### 加载中
102+
### 加载中 :id=loading
103103

104104
在等待 Docsify 初始化时显示加载动画。
105105

@@ -113,7 +113,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
113113
<div class="loading" style="margin: auto;"></div>
114114
</output>
115115

116-
### 侧边栏格线
116+
### 侧边栏格线 :id=sidebar-chevrons
117117

118118
在侧边栏的页面链接上显示展开/折叠图标。
119119

@@ -154,7 +154,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
154154
}
155155
```
156156

157-
### 侧边栏组
157+
### 侧边栏组 :id=sidebar-groups
158158

159159
在侧边栏的链接组之间添加视觉区分。
160160

@@ -178,7 +178,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
178178
<body class="sidebar-group-underline">
179179
```
180180

181-
### 侧边栏链接夹
181+
### 侧边栏链接夹 :id=sidebar-link-clamp
182182

183183
将多行侧边栏链接限制为单行,后加省略号。
184184

@@ -193,7 +193,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
193193
<body class="sidebar-link-clamp">
194194
```
195195

196-
### 侧边栏切换
196+
### 侧边栏切换 :id=sidebar-toggle
197197

198198
在侧边栏切换按钮中显示 "hamburger" 图标(三行),而不是默认的 "kebab" 图标。
199199

@@ -219,7 +219,7 @@ Docsify "核心" 主题包含呈现 Docsify 网站所需的所有样式和[主
219219
<body class="sidebar-toggle-hamburger">
220220
```
221221

222-
## 定制
222+
## 定制 :id=customization
223223

224224
Docsify 提供了[主题属性](#theme-properties)以简化对经常修改的样式的自定义。
225225

@@ -323,19 +323,19 @@ Docsify 提供了[主题属性](#theme-properties)以简化对经常修改的样
323323

324324
> [!TIP] **主题和插件作者**:我们鼓励你利用这些自定义主题属性,并在你的项目中提供类似的自定义选项。
325325
326-
### Common
326+
### Common :id=common
327327

328328
以下是最常修改的主题属性。 [Advanced](#advanced) 主题属性也可以使用,但通常不需要修改。
329329

330330
[\_vars.css](https://raw.githubusercontent.com/docsifyjs/docsify/refs/heads/develop/src/themes/shared/_vars.css ":include")
331331

332-
### Advanced
332+
### Advanced :id=advanced
333333

334334
Advanced 主题属性也可供使用,但通常无需修改。 从 [common](#common) 主题属性导出的值,但也可根据需要明确设置。
335335

336336
[\_vars-advanced.css](https://raw.githubusercontent.com/docsifyjs/docsify/refs/heads/develop/src/themes/shared/_vars-advanced.css ":include")
337337

338-
## 社区
338+
## 社区 :id=community
339339

340340
有关其他社区主题,请参见 [Awesome Docsify](zh-cn/awesome)
341341

0 commit comments

Comments
 (0)