Skip to content

Commit c83adf7

Browse files
authored
Update docs (#23)
1 parent cefb56f commit c83adf7

File tree

4 files changed

+34
-7
lines changed

4 files changed

+34
-7
lines changed

cdn.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ CSS 的压缩文件位于 `/lib/themes/` 目录下,JS 的压缩文件是原有
5252

5353
## 其他 CDN
5454

55-
- http://www.bootcdn.cn/docsify (支持国内)
55+
- https://www.bootcdn.cn/docsify/ (支持国内)
5656
- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
5757
- https://cdnjs.com/libraries/docsify
58+
- https://unpkg.com/browse/docsify/
5859

helpers.md

+9
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,14 @@ docsify 扩展了一些 Markdown 语法,可以让文档更易读。
5959
[link](/demo ':disabled')
6060
```
6161

62+
## 跨域链接
63+
64+
只有当你同时设置了 `routerMode: 'history'``externalLinkTarget: '_self'` 时,你需要为这些跨域链接添加这个配置。
65+
66+
```md
67+
[example.com](https://example.com/ ':crossorgin')
68+
```
69+
6270
## Github 任务列表
6371

6472
```md
@@ -100,6 +108,7 @@ docsify 扩展了一些 Markdown 语法,可以让文档更易读。
100108
```md
101109
![logo](https://docsify.js.org/_media/icon.svg ':class=someCssClass')
102110
```
111+
103112
### 设置图片的 ID
104113

105114
```md

more-pages.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -101,24 +101,24 @@ docs/zh-cn/guide.md => http://domain.com/zh-cn/guide
101101

102102
## 忽略副标题
103103

104-
当设置了 `subMaxLevel` 时,默认情况下每个标题都会自动添加到目录中。如果你想忽略特定的标题,可以给它添加  `{docsify-ignore}`
104+
当设置了 `subMaxLevel` 时,默认情况下每个标题都会自动添加到目录中。如果你想忽略特定的标题,可以给它添加 `<!-- {docsify-ignore} -->`
105105

106106
```markdown
107107
# Getting Started
108108

109-
## Header {docsify-ignore}
109+
## Header <!-- {docsify-ignore} -->
110110

111111
该标题不会出现在侧边栏的目录中。
112112
```
113113

114-
要忽略特定页面上的所有标题,你可以在页面的第一个标题上使用 `{docsify-ignore-all}`
114+
要忽略特定页面上的所有标题,你可以在页面的第一个标题上使用 `<!-- {docsify-ignore-all} -->`
115115

116116
```markdown
117-
# 入门 {docsify-ignore-all}
117+
# Getting Started <!-- {docsify-ignore-all} -->
118118

119-
## 标题
119+
## Header
120120

121121
该标题不会出现在侧边栏的目录中。
122122
```
123123

124-
在使用时, `{docsify-ignore}``{docsify-ignore-all}` 都不会在页面上呈现。
124+
在使用时, `<!-- {docsify-ignore} -->``<!-- {docsify-ignore-all} -->` 都不会在页面上呈现。

plugins.md

+17
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,23 @@
3838
3939
// 搜索标题的最大层级, 1 - 6
4040
depth: 2,
41+
42+
hideOtherSidebarContent: false, // 是否隐藏其他侧边栏内容
43+
44+
// 避免搜索索引冲突
45+
// 同一域下的多个网站之间
46+
namespace: 'website-1',
47+
48+
// 使用不同的索引作为路径前缀(namespaces)
49+
// 注意:仅适用于 paths: 'auto' 模式
50+
//
51+
// 初始化索引时,我们从侧边栏查找第一个路径
52+
// 如果它与列表中的前缀匹配,我们将切换到相应的索引
53+
pathNamespaces: ['/zh-cn', '/ru-ru', '/ru-ru/v1'],
54+
55+
// 您可以提供一个正则表达式来匹配前缀。在这种情况下,
56+
// 匹配到的字符串将被用来识别索引
57+
pathNamespaces: /^(\/(zh-cn|ru-ru))?(\/(v1|v2))?/
4158
}
4259
}
4360
</script>

0 commit comments

Comments
 (0)