Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 3fe957d

Browse files
github-actions[bot]sy-records
andauthored
New Crowdin translations by GitHub Action (#59)
Co-authored-by: Luffy <52o@qq52o.cn>
1 parent af61a8c commit 3fe957d

22 files changed

+6628
-1133
lines changed

‎README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,29 @@
1-
## docsify
1+
# docsify
22

33
> 一个神奇的文档网站生成器。
44
55
## 概述
66

7-
docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 `.html` 文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 `index.html` 就可以开始编写文档并直接[部署在 GitHub Pages](zh-cn/deploy.md)。
7+
docsify 可以快速帮你生成文档网站。不同于 GitBook 的地方是它不会生成静态的 `.html` 文件。 相反,它能智能加载和解析 Markdown 文件,并将其显示为网站。 要开始使用它,只需创建一个 `index.html` 并将其[部署到 GitHub Pages](zh-cn/deploy.md)。
88

99
查看[快速开始](zh-cn/quickstart.md)了解详情。
1010

1111
## 特性
1212

13-
- 无需构建,写完文档直接发布
14-
- 容易使用并且轻量 (压缩后 ~21kB)
13+
- 没有静态生成的 html 文件
14+
- 简单和轻量
1515
- 智能的全文搜索
1616
- 提供多套主题
1717
- 丰富的 API
1818
- 支持 Emoji
19-
- 兼容 IE11
20-
- 支持服务端渲染 SSR ([示例](https://github.com/docsifyjs/docsify-ssr-demo))
2119

2220
## 示例
2321

2422
可以查看 [Showcase](https://github.com/docsifyjs/docsify/#showcase) 来了解更多在使用 docsify 的文档项目。
2523

2624
## 捐赠
2725

28-
如果你觉得 docsify 对你有帮助,或者想对我微小的工作一点资瓷,欢迎给我[捐赠](https://github.com/QingWei-Li/donate)。
26+
如果你认为 docsify 对你有帮助,或者我的工作有价值,请考虑捐赠。 欢迎帮我[买杯咖啡](https://github.com/QingWei-Li/donate)。:heart:
2927

3028
## 社区
3129

‎_sidebar.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,32 @@
1-
* 入门
2-
3-
* [快速开始](zh-cn/quickstart.md)
4-
* [多页文档](zh-cn/more-pages.md)
5-
* [定制导航栏](zh-cn/custom-navbar.md)
6-
* [封面](zh-cn/cover.md)
7-
8-
* 定制化
9-
10-
* [配置项](zh-cn/configuration.md)
11-
* [主题](zh-cn/themes.md)
12-
* [插件列表](zh-cn/plugins.md)
13-
* [开发插件](zh-cn/write-a-plugin.md)
14-
* [Markdown 配置](zh-cn/markdown.md)
15-
* [代码高亮](zh-cn/language-highlight.md)
16-
17-
* 指南
18-
19-
* [部署](zh-cn/deploy.md)
20-
* [文档助手](zh-cn/helpers.md)
21-
* [兼容 Vue](zh-cn/vue.md)
22-
* [CDN](zh-cn/cdn.md)
23-
* [离线模式(PWA)](zh-cn/pwa.md)
24-
* [服务端渲染 (SSR)](zh-cn/ssr.md)
25-
* [文件嵌入](zh-cn/embed-files.md)
26-
27-
* [Awesome docsify](zh-cn/awesome.md)
28-
* [Changelog](zh-cn/changelog.md)
1+
<!-- markdownlint-disable first-line-h1 -->
2+
3+
- 入门
4+
5+
- [快速开始](zh-cn/quickstart.md)
6+
- [添加页面](zh-cn/adding-pages.md)
7+
- [封面](zh-cn/cover.md)
8+
- [定制导航栏](zh-cn/custom-navbar.md)
9+
10+
- 定制化
11+
12+
- [配置项](zh-cn/configuration.md)
13+
- [主题](zh-cn/themes.md)
14+
- [插件列表](zh-cn/plugins.md)
15+
- [开发插件](zh-cn/write-a-plugin.md)
16+
- [Markdown 配置](zh-cn/markdown.md)
17+
- [代码高亮](zh-cn/language-highlight.md)
18+
- [Emoji](zh-cn/emoji.md)
19+
20+
- 指南
21+
22+
- [部署](zh-cn/deploy.md)
23+
- [文档助手](zh-cn/helpers.md)
24+
- [兼容 Vue](zh-cn/vue.md)
25+
- [CDN](zh-cn/cdn.md)
26+
- [离线模式(PWA)](zh-cn/pwa.md)
27+
- [文件嵌入](zh-cn/embed-files.md)
28+
- [UI Kit](zh-cn/ui-kit.md)
29+
30+
- [Awesome docsify](zh-cn/awesome.md)
31+
32+
- [Changelog](zh-cn/changelog.md)

‎adding-pages.md

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# 添加页面
2+
3+
如果你需要更多页面,你可以简单地在 docsify 目录中创建更多 markdown 文件。 如果创建了名为 `guide.md` 的文件,则可通过 `/#/guide` 访问该文件。
4+
5+
例如,目录结构如下:
6+
7+
```text
8+
.
9+
└── docs
10+
├── README.md
11+
├── guide.md
12+
└── zh-cn
13+
├── README.md
14+
└── guide.md
15+
```
16+
17+
匹配路由
18+
19+
```text
20+
docs/README.md => http://domain.com
21+
docs/guide.md => http://domain.com/#/guide
22+
docs/zh-cn/README.md => http://domain.com/#/zh-cn/
23+
docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide
24+
```
25+
26+
## 侧边栏
27+
28+
为了拥有侧边栏,你可以创建自己的侧边栏 `_sidebar.md`(有关示例,请参阅[本文档的侧边栏](https://github.com/docsifyjs/docsify/blob/main/docs/_sidebar.md)):
29+
30+
首先,你需要设置为 `loadSidebar` 为 **true**。 详情请参见[配置段落](zh-cn/configuration#loadsidebar)。
31+
32+
```html
33+
<!-- index.html -->
34+
35+
<script>
36+
window.$docsify = {
37+
loadSidebar: true,
38+
};
39+
</script>
40+
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
41+
```
42+
43+
创建 `_sidebar.md`:
44+
45+
```markdown
46+
<!-- docs/_sidebar.md -->
47+
48+
- [Home](/)
49+
- [Page 1](page-1.md)
50+
```
51+
52+
创建章节标题:
53+
54+
```markdown
55+
<!-- docs/_sidebar.md -->
56+
57+
- Section Header 1
58+
59+
- [Home](/)
60+
- [Page 1](page-1.md)
61+
62+
- Section Header 2
63+
64+
- [Page 2](page-2.md)
65+
- [Page 3](page-3.md)
66+
```
67+
68+
需要在 `./docs` 目录创建 `.nojekyll` 命名的空文件,阻止 GitHub Pages 忽略命名是下划线开头的文件。
69+
70+
!> Docsify 只查找当前文件夹中的 `_sidebar.md`,并使用它,否则会返回到使用 `window.$docsify.loadSidebar` 配置。
71+
72+
示例文件结构:
73+
74+
```text
75+
└── docs/
76+
├── _sidebar.md
77+
├── index.md
78+
├── getting-started.md
79+
└── running-services.md
80+
```
81+
82+
## 嵌套侧边栏
83+
84+
你可能希望侧边栏在导航后更新以反映当前目录。 这可以通过在每个文件夹中添加一个 `_sidebar.md` 文件来实现。
85+
86+
`_sidebar.md` 会从每一级目录加载。 如果当前目录中没有 `_sidebar.md`,则会返回上一级目录。 例如,如果当前路径是 `/guide/quick-start`,则将从 `/guide/_sidebar.md` 加载 `_sidebar.md`。
87+
88+
你可以指定 `alias` 以避免不必要的回退。
89+
90+
```html
91+
<script>
92+
window.$docsify = {
93+
loadSidebar: true,
94+
alias: {
95+
'/.*/_sidebar.md': '/_sidebar.md',
96+
},
97+
};
98+
</script>
99+
```
100+
101+
!> 你可以在一个子目录中创建一个 `README.md` 文件来作为路由的默认网页。
102+
103+
## 用侧边栏中选定的条目名称作为页面标题
104+
105+
页面的 `title` 标签是根据_选定的_侧边栏项目名称生成的。 为了更好地进行搜索引擎优化,你可以在文件名后指定一个字符串来自定义标题。
106+
107+
```markdown
108+
<!-- docs/_sidebar.md -->
109+
110+
- [Home](/)
111+
- [Guide](guide.md 'The greatest guide in the world')
112+
```
113+
114+
## 目录
115+
116+
创建 `_sidebar.md` 后,侧边栏内容将根据 markdown 文件中的标题自动生成。
117+
118+
自定义侧边栏还可以通过设置 `subMaxLevel` 自动生成目录,请比较 [subMaxLevel 配置](zh-cn/configuration#submaxlevel)。
119+
120+
```html
121+
<!-- index.html -->
122+
123+
<script>
124+
window.$docsify = {
125+
loadSidebar: true,
126+
subMaxLevel: 2,
127+
};
128+
</script>
129+
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
130+
```
131+
132+
## 忽略副标题
133+
134+
当设置了 `subMaxLevel` 时,默认情况下每个标题都会自动添加到目录中。 如果你想忽略特定的标题,可以给它添加 `<!-- {docsify-ignore} -->` 。
135+
136+
```markdown
137+
# Getting Started
138+
139+
## Header <!-- {docsify-ignore} -->
140+
141+
该标题不会出现在侧边栏目录中。
142+
```
143+
144+
要忽略特定页面上的所有标题,你可以在页面的第一个标题上使用 `<!-- {docsify-ignore-all} -->` 。
145+
146+
```markdown
147+
# Getting Started <!-- {docsify-ignore-all} -->
148+
149+
## Header
150+
151+
该标题不会出现在侧边栏的目录中。
152+
```
153+
154+
在使用时,`<!-- {docsify-ignore} -->` 和 `<!-- {docsify-ignore-all} -->` 都不会在页面上呈现。
155+
156+
`{docsify-ignore}` 和 `{docsify-ignore-all}` 也可以做同样的事情。

‎cdn.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,58 @@
11
# CDN
22

3-
推荐使用 [jsDelivr](//cdn.jsdelivr.net),能及时获取到最新版。你也可以在[cdn.jsdelivr.net/npm/docsify/](cdn.jsdelivr.net/npm/docsify/)中浏览npm包的源代码。
3+
Docsify 的 [npm package](https://www.npmjs.com/package/docsify) 是随着每个版本自动发布到 CDN 中的。 内容可以在每个 CDN 上查看。
44

5-
## 获取最新版本
5+
Docsify 推荐 [jsDelivr](//cdn.jsdelivr.net) 为其首选的 CDN:
66

7-
不指定特定版本号时将引入最新版。
7+
-https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
88

9-
```html
10-
<!-- 引入 css -->
11-
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
9+
在没有 jsDelivr 的地方,也可能需要其他的 CDN:
1210

13-
<!-- 引入 script -->
14-
<scriptsrc="//cdn.jsdelivr.net/npm/docsify/lib/docsify.js"></script>
15-
```
11+
-https://cdnjs.com/libraries/docsify
12+
-https://unpkg.com/browse/docsify/
13+
-https://www.bootcdn.cn/docsify/ (支持国内)
1614

17-
也可以使用 [压缩版文件](#compressed-file).
15+
## 指定版本
1816

19-
## 获取指定版本
17+
请注意以下 CDN URL 中的`@`版本锁定。 这样就可以指定最新的主版本、次版本、补丁或特定 [semver](https://semver.org) 版本号。
2018

21-
如果担心频繁地版本更新又可能引入未知 Bug,我们也可以使用具体的版本。规则是 `//cdn.jsdelivr.net/npm/docsify@VERSION/`
19+
- MAJOR 版本包括不兼容变更<br>
20+
`1.0.0` → `2.0.0`
21+
- MINOR 版本包括兼容性的新功能<br>
22+
`1.0.0` → `1.1.0`
23+
- PATCH版本包括兼容性的错误修复<br>
24+
`1.0.0` → `1.0.1`
2225

23-
```html
24-
<!-- 引入 css -->
25-
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.10.2/themes/vue.css">
26+
从文件名中移除`.min`,可获取未压缩的资源。
2627

27-
<!-- 引入 script -->
28-
<script src="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/docsify.js"></script>
29-
```
28+
## 最新主要版本
3029

31-
!> 指定 *VERSION* 为 `latest` 可以强制每次都请求最新版本。
30+
指定最新的主要版本允许您的网站在发布时接收所有非破坏性的增强("次级"更新)和错误修复("补丁"更新)。 对于那些倾向于零维护又可以随着新版本的发布更新其网站的风险最小化的人来说,这是一个好的选择。
3231

33-
## 压缩版
32+
?> 发布新的主要版本时,你需要在你的 CDN URLs 中的 `@` 符号后手动更新主要版本号。
3433

35-
CSS 的压缩文件位于 `/lib/themes/` 目录下,JS 的压缩文件是原有文件路径的基础上加 `.min` 后缀。
34+
<!-- prettier-ignore -->
3635

3736
```html
38-
<!-- 引入 css -->
39-
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
37+
<!-- 主题 -->
38+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5/themes/vue.min.css" />
4039

41-
<!-- 引入 script -->
42-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
40+
<!-- Docsify -->
41+
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
4342
```
4443

45-
```html
46-
<!-- 引入 css -->
47-
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/themes/vue.css">
44+
## 获取指定版本 :id=specific-version
4845

49-
<!-- 引入 script -->
50-
<script src="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/docsify.min.js"></script>
51-
```
46+
指定一个准确的版本可以防止将来的任何更新影响你的网站。 对于那些愿意在发布新版本时手动更新资源的人来说,这是一个很好的选项。
5247

53-
## 其他 CDN
48+
?> 新版本发布后,你需要在你的 CDN URLs 中的 '@' 符号后手动更新版本号。
5449

55-
- https://www.bootcdn.cn/docsify/ (支持国内)
56-
- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
57-
- https://cdnjs.com/libraries/docsify
58-
- https://unpkg.com/browse/docsify/
50+
<!-- prettier-ignore -->
51+
52+
```html
53+
<!-- 主题 -->
54+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@5.0.0/themes/vue.min.css" />
5955

56+
<!-- Docsify -->
57+
<script src="//cdn.jsdelivr.net/npm/docsify@5.0.0/dist/docsify.min.js"></script>
58+
```

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /