@@ -72,7 +72,9 @@ window.$docsify = {
7272- 类型:` Boolean `
7373- 默认:` false `
7474
75- 同时设置 ` loadSidebar ` 和 ` autoHeader ` 后,可以根据 ` _sidebar.md ` 的内容自动为每个页面增加标题。 参见 [ #78 ] ( https://github.com/docsifyjs/docsify/issues/78 ) 。
75+ 如果同时启用了 ` loadSidebar ` 和 ` autoHeader ` 功能,则对于 ` _sidebar.md ` 中的每个链接,都会在将其转换为 HTML 之前为页面预置一个标题,但前提是该页面尚未包含 H1 标题。
76+ 77+ 参见 [ #78 ] ( https://github.com/docsifyjs/docsify/issues/78 ) 。
7678
7779``` js
7880window .$docsify = {
@@ -105,14 +107,14 @@ window.$docsify = {
105107- 类型:` Boolean `
106108- 默认:` true `
107109
108- 决定 Docsify 是否应自动处理未捕获的 _ synchronous_ 插件错误。 这可以防止插件错误影响 docsify 正确呈现实时网站内容的能力 。
110+ 决定 Docsify 是否应自动处理未捕获的 _ synchronous_ 插件错误。 这可以防止插件错误影响 docsify 正常渲染网站内容的能力 。
109111
110112## cornerExternalLinkTarget
111113
112114- 类型:` String `
113115- 默认:` '_blank' `
114116
115- 右上角外部链接的打开方式 。 默认为 ` '_blank' ` (在新窗口或者标签页中打开)
117+ 右上角的外部链接打开方式 。 默认为 ` '_blank' ` (在新窗口或者标签页中打开)
116118
117119``` js
118120window .$docsify = {
@@ -163,7 +165,7 @@ window.$docsify = {
163165- 类型:` Boolean `
164166- 默认:` null `
165167
166- 执行页面上的脚本。 仅解析第一个脚本标签([ demo] ( themes ) )。 如果检测到 Vue ,默认情况下是 ` true ` 。
168+ 执行页面上的脚本。 仅解析第一个脚本标签([ demo] ( zh-cn/ themes) )。 如果检测到 Vue ,默认情况下是 ` true ` 。
167169
168170``` js
169171window .$docsify = {
@@ -179,7 +181,7 @@ window.$docsify = {
179181</script>
180182```
181183
182- 注意,如果运行的是外部脚本,例如嵌入的 jsfidle demo,请务必包含 [ external-script] ( zh-cn/plugins.md?id=external-script ) 插件。
184+ 注意,如果运行的是外部脚本,例如嵌入的 jsfidle demo,请确保引入 [ external-script] ( zh-cn/plugins.md?id=external-script ) 插件。
183185
184186## ext
185187
@@ -212,7 +214,7 @@ window.$docsify = {
212214- 类型:` String `
213215- 默认:` '_blank' `
214216
215- 在 markdown 中打开外部链接的目标。 外部链接的打开方式。 默认为 ` '_blank' ` (在新窗口或者标签页中打开)
217+ 在 markdown 中打开外部链接的目标。 默认为 ` '_blank' ` (在新窗口或者标签页中打开)
216218
217219``` js
218220window .$docsify = {
@@ -229,8 +231,8 @@ window.$docsify = {
229231示例:
230232
231233- 尝试获取 ` /de/overview ` 页面。 如果该页面存在,就会显示出来。
232- - 如果不存在则尝试 ` /overview ` (取决于默认语言),如果存在即显示 。 如果该页面存在,就会显示出来。
233- - 然后显示 404 页面 。
234+ - 然后尝试获取默认页面 ` /overview ` (取决于默认语言)。 如果该页面存在,就会显示出来。
235+ - 如果也不存在,显示404页面 。
234236
235237``` js
236238window .$docsify = {
@@ -262,7 +264,7 @@ window.$docsify = {
262264- 类型:` Boolean `
263265- 默认:` true `
264266
265- 该选项将完全隐藏侧边栏,不会在侧边显示任何内容 。
267+ 该选项将完全隐藏侧边栏,不会在侧边栏显示任何内容 。
266268
267269``` js
268270window .$docsify = {
@@ -297,11 +299,11 @@ window.$docsify = {
297299
298300将组合键绑定到自定义回调函数。
299301
300- 键 ` bindings ` 定义为用 ` + ` 分隔的大小写不敏感的字符串值。 修改键值包括 ` alt ` 、` ctrl ` 、` meta ` 和 ` shift ` 。 非修饰符键值应与键盘事件的 [ key] ( https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key ) 或 [ code] ( https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code ) 值相匹配。
302+ 键 ` bindings ` 定义为用 ` + ` 分隔的大小写不敏感的字符串值。 修饰符键值包括 ` alt ` 、` ctrl ` 、` meta ` 和 ` shift ` 。 非修饰符键值应与键盘事件的 [ key] ( https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key ) 或 [ code] ( https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code ) 值相匹配。
301303
302304` callback ` 函数接收[ 按键事件] ( https://developer.mozilla.org/en-US/docs/Web/API/Element/keydown_event ) 作为参数。
303305
304- !> 让网站访问者知道你的自定义按键绑定功能可用 ! 如果绑定与 DOM 元素相关联,可考虑插入一个 ` <kbd> ` 元素作为视觉提示(如<kbd >alt</kbd >+<kbd >a</kbd >),或添加 [ title] ( https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title ) 和 [ aria-keyshortcuts] ( https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-keyshortcuts ) 属性作为悬停/焦点提示。
306+ > [ !IMPORTANT ] 让网站访问者知道你的自定义按键是可用的 ! 如果绑定与 DOM 元素相关联,可考虑插入一个 ` <kbd> ` 元素作为视觉提示(如<kbd >alt</kbd >+<kbd >a</kbd >),或添加 [ title] ( https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title ) 和 [ aria-keyshortcuts] ( https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-keyshortcuts ) 属性作为悬停/焦点提示。
305307
306308``` js
307309window .$docsify = {
@@ -376,7 +378,7 @@ window.$docsify = {
376378
377379在侧边栏显示的网站 Logo。 你可以使用 CSS 调整它的大小。
378380
379- !> 只有同时设置了 ` name ` ,Logo 才会可见。 请参阅 [ name] ( #name ) 配置。
381+ > [ !IMPORTANT ] 只有同时设置了 ` name ` ,Logo 才会可见。 请参阅 [ name] ( #name ) 配置。
380382
381383``` js
382384window .$docsify = {
@@ -415,7 +417,7 @@ window.$docsify = {
415417- 类型:` Number `
416418- 默认:` 6 `
417419
418- 最大表格内容级别 。
420+ 内容级别的最大值 。
419421
420422``` js
421423window .$docsify = {
@@ -448,11 +450,11 @@ window.$docsify = {
448450};
449451```
450452
451- 名称字段也可包含自定义 HTML,以方便定制 :
453+ name 项也可以包含自定义 HTML 代码来方便地定制 :
452454
453455``` js
454456window .$docsify = {
455- name: ' <0 >docsify</0 >'
457+ name: ' <span >docsify</span >'
456458};
457459```
458460
@@ -506,7 +508,7 @@ window.$docsify = {
506508 <img class =" emoji " src =" https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png " alt =" -1 " >
507509</output >
508510
509- ` false ` 时为原生字符的图像 :
511+ ` true ` 时为原生表情符号字符的图像 :
510512
511513<output data-lang =" output " >
512514 <span class =" emoji " >😄︎</span >
@@ -532,7 +534,7 @@ window.$docsify = {
532534
533535- 类型:` Array<string> `
534536
535- 有时我们不希望 docsify 处理我们的链接。 参考 [ #203 ] ( https://github.com/docsifyjs/docsify/issues/203 ) 。 我们可以通过指定字符串数组来跳过某些链接的编译。 每个字符串都会被转换成正则表达式 (` RegExp ` ),链接的 _ whole_ href 会与之匹配。
537+ 有时我们不希望 docsify 处理我们的链接: 参见 [ #203 ] ( https://github.com/docsifyjs/docsify/issues/203 ) 。 我们可以通过指定字符串数组来跳过某些链接的编译。 每个字符串都会被转换成正则表达式 (` RegExp ` ),链接的 _ whole_ href 会与之匹配。
536538
537539``` js
538540window .$docsify = {
@@ -584,31 +586,31 @@ window.$docsify = {
584586- 类型:` Boolean|String|Object `
585587- 默认:` false `
586588
587- 显示默认 " 404 - Not Found" 消息:
589+ 显示默认 " 404 - Not Found" 消息:
588590
589591``` js
590592window .$docsify = {
591593 notFoundPage: false ,
592594};
593595```
594596
595- 在找不到指定页面时加载 ` _404.md ` :
597+ 加载 ` _404.md ` 文件 :
596598
597599``` js
598600window .$docsify = {
599601 notFoundPage: true ,
600602};
601603```
602604
603- 加载自定义404页面 :
605+ 加载 404 页面的自定义路径 :
604606
605607``` js
606608window .$docsify = {
607609 notFoundPage: ' my404.md'
608610};
609611```
610612
611- 加载正确的本地化过的404页面 :
613+ 根据本地化情况加载正确的 404 页面 :
612614
613615``` js
614616window .$docsify = {
@@ -725,42 +727,16 @@ window.$docsify = {
725727};
726728```
727729
728- 对于静态部署的站点(如 在 GitHub 页面上)基于哈希的路由设置更简单。 对于可以重写 URL 的网站,基于历史记录的格式
729- 更好(特别是对于搜索引擎优化而言,基于哈希值的路由对搜索引擎并不
730- 那么友好)。
731- 732- 基于哈希值的路由选择意味着所有 URL 路径都将在
733- 地址栏中以 ` /#/ ` 作为前缀。 这是一种技巧,它允许网站加载 ` /index.html ` ,然后
734- 使用 ` # ` 后面的路径来决定加载哪些 markdown 文件。 例如,
735- 一个完整的基于哈希值的 URL 可以如下所示:
736- ` https://example.com/#/path/to/page ` 。 浏览器将实际加载
737- ` https://example.com ` (假设你的静态服务器默认提供
738- ` index.html ` ,大多数服务器都是这样做的),然后 Docsify JavaScript 代码将
739- 查看 ` /#/... ` ,并确定要加载和渲染的标记符文件。
740- 此外,点击链接时,Docsify 路由器会动态更改哈希值之后的
741- 内容。 无论如何,` location.pathname ` 的值仍将是
742- ` / ` 。 当在浏览器中访问这样的 URL 时,哈希路径的部分_不会_被发送到服务器。
743- 744- 另一方面,基于历史的路由意味着 Docsify JavaScript 将使用
745- [ History API] ( https://developer.mozilla.org/en-US/docs/Web/API/History_API )
746- 来动态更改 URL,而无需使用 ` # ` 。 这意味着,搜索引擎将把所有网址
747- 视为"真实"网址,在浏览器中访问网址时,完整路径将被发送到
748- 服务器。 例如,URL 可能看起来像
749- ` https://example.com/path/to/page ` 。 浏览器将尝试直接从服务器加载完整的 URL
750- ,而不仅仅是 ` https://example.com ` 。 这样做的好处是这些类型的 URL 对搜索引擎更友好,可以被索引(耶!)。 但缺点是,你的服务器或
751- 存放网站文件的地方必须能够处理这些 URL。 各种静态
752- 网站托管服务允许配置"重写规则",这样就可以配置
753- 服务器,使其无论访问
754- 的路径是什么,都始终发回 ` /index.html ` 。 ` location.pathname ` 的值将显示 ` /path/to/page ` ,因为
755- 实际上已经发送到服务器。
756- 757- 简要说明:从 ` hash ` 路由开始(默认)。 如果你有冒险精神,可以学习
758- 如何配置服务器,然后切换到 ` history ` 模式,以获得更好的体验
759- ,URL 中不含 ` # ` ,并进行搜索引擎优化。
760- 761- > ** 注意** 如果使用 ` routerMode: 'history' ` ,可能需要添加
762- > [ ` alias ` ] (#alias),以便无论访问哪个路径,都能
763- > 加载 ` _sidebar.md ` 和 ` _navbar.md ` 文件。
730+ 对于静态部署的站点(如 在 GitHub 页面上)基于 hash 的路由设置更简单。 对于可以重写 URL 的网站,基于历史记录的格式更好(特别是对于搜索引擎优化而言,基于哈希值的路由对搜索引擎并不那么友好)。
731+ 732+ 基于 hash 值的路由选择意味着所有 URL 路径都将在地址栏中以 ` /#/ ` 作为前缀。 这是一种技巧,它允许网站加载 ` /index.html ` ,然后使用 ` # ` 后面的路径来决定加载哪些 markdown 文件。 例如,一个完整的基于 hash 值的 URL 可以如下所示:` https://example.com/#/path/to/page ` 。 浏览器将实际加载 ` https://example.com ` (假设你的静态服务器默认提供` index.html ` ,大多数服务器都是这样做的),然后 Docsify JavaScript 代码将查看 ` /#/... ` ,并确定要加载和渲染的 markdown 文件。
733+ 此外,点击链接时,Docsify 路由器会动态更改 hash 值之后的内容。 无论如何,` location.pathname ` 的值仍将是 ` / ` 。 当在浏览器中访问这样的 URL 时,hash 路径的部分 _ 不会_ 被发送到服务器。
734+ 735+ 另一方面,基于历史的路由意味着 Docsify JavaScript 将使用 [ History API] ( https://developer.mozilla.org/en-US/docs/Web/API/History_API ) 来动态更改 URL,而无需使用 ` # ` 。 这意味着,搜索引擎将把所有网址视为"真实"网址,在浏览器中访问网址时,完整路径将被发送到服务器。 例如,URL 可能看起来像 ` https://example.com/path/to/page ` 。 浏览器将尝试直接从服务器加载完整的 URL,而不仅仅是 ` https://example.com ` 。 这样做的好处是这些类型的 URL 对搜索引擎更友好,可以被索引(耶!)。 但缺点是,你的服务器或存放网站文件的地方必须能够处理这些 URL。 各种静态网站托管服务允许配置"重写规则",这样就可以配置服务器,使其无论访问的路径是什么,都始终发回 ` /index.html ` 。 ` location.pathname ` 的值将显示 ` /path/to/page ` ,因为实际上已经发送到服务器。
736+ 737+ 太长不看版:优先使用 ` hash ` 路由(默认)。 如果你有冒险精神,可以学习如何配置服务器,然后切换到 ` history ` 模式,以获得更好的体验,URL 中不含 ` # ` ,并进行搜索引擎优化。
738+ 739+ > ** 注意** 如果使用 ` routerMode: 'history' ` ,可能需要添加[ ` alias ` ] ( #alias ) ,以便无论访问哪个路径,都能加载 ` _sidebar.md ` 和 ` _navbar.md ` 文件。
764740>
765741> ``` js
766742> window .$docsify = {
@@ -895,7 +871,7 @@ window.$docsify = {
895871- 类型:` Number `
896872- 默认:` 0 `
897873
898- 在自定义侧边栏中添加目录 ( TOC) 。
874+ 在自定义侧边栏中添加目录( TOC) 。
899875
900876``` js
901877window .$docsify = {
@@ -911,11 +887,11 @@ window.$docsify = {
911887 - [Another page](another.md)
912888```
913889
914- 详见 [ #1131 ] ( https://github.com/docsifyjs/docsify/issues/1131 ) 。
890+ 参见 [ #1131 ] ( https://github.com/docsifyjs/docsify/issues/1131 ) 。
915891
916- ## themeColor ⚠️
892+ ## themeColor ⚠️: id =themecolor
917893
918- !> 自 v5 起已弃用 。 使用 ` --theme-color ` [ 主题属性] ( zh-cn/themes#theme-properties ) [ 自定义] ( zh-cn/themes#customization ) 主题颜色。
894+ > [ !IMPORTANT ] 废弃于 v5 。 使用 ` --theme-color ` [ 主题属性] ( zh-cn/themes#theme-properties ) [ 自定义] ( zh-cn/themes#customization ) 主题颜色。
919895
920896- 类型:` String `
921897
@@ -927,14 +903,14 @@ window.$docsify = {
927903};
928904```
929905
930- ## topMargin ⚠️
906+ ## topMargin ⚠️: id =topmargin
931907
932- !> 自 v5 起已弃用 。 在使用粘性导航栏时,使用 ` --scroll-padding-top ` [ 主题属性] ( zh-cn/themes#theme-properties ) 指定滚动边距。
908+ > [ !IMPORTANT ] 废弃于 v5 。 在使用粘性导航栏时,使用 ` --scroll-padding-top ` [ 主题属性] ( zh-cn/themes#theme-properties ) 指定滚动边距。
933909
934910- 类型:` Number|String `
935911- 默认:` 0 `
936912
937- 在视口顶部添加滚动填充。 当你添加了一个粘性或"固定" 元素,并希望自动滚动与元素底部对齐时,该功能非常有用。
913+ 在视口顶部添加滚动填充。 当你添加了一个粘性或"固定" 元素,并希望自动滚动与元素底部对齐时,该功能非常有用。
938914
939915``` js
940916window .$docsify = {
@@ -953,9 +929,9 @@ window.$docsify = {
953929 vueComponents: {
954930 ' button-counter' : {
955931 template: `
956- <0 >
932+ <button @click="count += 1" >
957933 You clicked me {{ count }} times
958- </0 >
934+ </button >
959935 ` ,
960936 data () {
961937 return {
@@ -994,11 +970,11 @@ window.$docsify = {
994970```
995971
996972``` markdown
997- <0 >
998- <1 >-</1 >
973+ <p >
974+ <button @click="count -= 1" >-</button >
999975 {{ count }}
1000- <2 >+</2 >
1001- </0 >
976+ <button @click="count += 1" >+</button >
977+ </p >
1002978```
1003979
1004980<output data-lang =" output " >
@@ -1013,7 +989,7 @@ window.$docsify = {
1013989
1014990- 类型:` Object `
1015991
1016- 指定要挂载为 Vue 实例的 DOM 元素及其相关选项。 每次加载新页面时,Docsify 都会在主内容区域挂载第一个匹配元素。 挂载元素 ` data ` 是每个实例的唯一特性,不会在用户导航站点时持续存在。
992+ 指定要挂载为 Vue 实例的 DOM 元素及其相关选项。 挂载元素是使用 [ CSS 选择器 ] ( https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors ) 作为键,包含 Vue 选项的对象作为值来指定的。 每次加载新页面时,Docsify 都会在主内容区域挂载第一个匹配元素。 挂载元素 ` data ` 是每个实例的唯一特性,不会在用户导航站点时持续存在。
1017993
1018994``` js
1019995window .$docsify = {
0 commit comments