docs: update config
This commit is contained in:
qingwei.li
cinwell.li
parent
bf5d999296
commit
bd7ee84241
3 changed files with 302 additions and 302 deletions
|
|
@ -1,9 +1,8 @@
|
|||
# 配置项
|
||||
|
||||
docsify 有两种配置参数的方式。一种是配置在 `window.$docsify` 里，另一种是给 `script` 标签添加 `data-*` 属性。
|
||||
你可以配置在 `window.$docsify` 里。
|
||||
|
||||
```html
|
||||
<!-- 方法 1 -->
|
||||
<script>
|
||||
window.$docsify = {
|
||||
repo: 'QingWei-Li/docsify',
|
||||
|
|
@ -11,38 +10,25 @@ docsify 有两种配置参数的方式。一种是配置在 `window.$docsify`
|
|||
coverpage: true
|
||||
}
|
||||
</script>
|
||||
|
||||
<!-- 方法 2 -->
|
||||
<script
|
||||
src="//unpkg.com/docsify"
|
||||
data-repo="QingWei-Li/docsify"
|
||||
data-max-level="3"
|
||||
data-coverpage>
|
||||
</script>
|
||||
```
|
||||
|
||||
两种方式可以共存，推荐第一种做法——直接配置 `window.$docsify` 对象——这会让你的配置更加清晰，同时也可以方便的将配置单独写到另一个文件里。
|
||||
|
||||
!> 通过 `window.$docsify` 配置属性，需要将属性改成驼峰命名法。通过 `data-*` 属性配置，保持短横线的命名规则。
|
||||
|
||||
|
||||
## el
|
||||
|
||||
- 类型：`String`
|
||||
- 默认值：`#app`
|
||||
* 类型：`String`
|
||||
* 默认值：`#app`
|
||||
|
||||
docsify 初始化的挂载元素，可以是一个 CSS 选择器，默认为 `#app` 如果不存在就直接绑定在 `body` 上。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
el: '#app'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## repo
|
||||
|
||||
- 类型：`String`
|
||||
- 默认值: `null`
|
||||
* 类型：`String`
|
||||
* 默认值: `null`
|
||||
|
||||
配置仓库地址或者 `username/repo` 的字符串，会在页面右上角渲染一个 [GitHub Corner](http://tholman.com/github-corners/) 挂件。
|
||||
|
||||
|
|
@ -51,28 +37,39 @@ window.$docsify = {
|
|||
repo: 'QingWei-Li/docsify',
|
||||
// or
|
||||
repo: 'https://github.com/QingWei-Li/docsify/'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
## max-level
|
||||
|
||||
- 类型：`Number`
|
||||
- 默认值: `6`
|
||||
* 类型：`Number`
|
||||
* 默认值: `6`
|
||||
|
||||
默认情况下会抓取文档中所有标题渲染成目录，可配置最大支持渲染的标题层级。
|
||||
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
maxLevel: 4
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## load-navbar
|
||||
## maxLevel
|
||||
|
||||
- 类型：`Boolean|String`
|
||||
- 默认值: `false`
|
||||
* Type: `Number`
|
||||
* Default: `6`
|
||||
|
||||
Maximum Table of content level.
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
maxLevel: 4
|
||||
};
|
||||
```
|
||||
|
||||
## loadNavbar
|
||||
|
||||
* 类型：`Boolean|String`
|
||||
* 默认值: `false`
|
||||
|
||||
加载自定义导航栏，参考[定制导航栏](zh-cn/custom-navbar.md) 了解用法。设置为 `true` 后会加载 `_navbar.md` 文件，也可以自定义加载的文件名。
|
||||
|
||||
|
|
@ -83,13 +80,13 @@ window.$docsify = {
|
|||
|
||||
// 加载 nav.md
|
||||
loadNavbar: 'nav.md'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## load-sidebar
|
||||
## loadSidebar
|
||||
|
||||
- 类型：`Boolean|String`
|
||||
- 默认值: `false`
|
||||
* 类型：`Boolean|String`
|
||||
* 默认值: `false`
|
||||
|
||||
加载自定义侧边栏，参考[多页文档](zh-cn/more-pages.md)。设置为 `true` 后会加载 `_sidebar.md` 文件，也可以自定义加载的文件名。
|
||||
|
||||
|
|
@ -100,42 +97,39 @@ window.$docsify = {
|
|||
|
||||
// 加载 summary.md
|
||||
loadSidebar: 'summary.md'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## sub-max-level
|
||||
## subMaxLevel
|
||||
|
||||
- 类型：`Number`
|
||||
- 默认值: `0`
|
||||
* 类型：`Number`
|
||||
* 默认值: `0`
|
||||
|
||||
自定义侧边栏后默认不会再生成目录，你也可以通过设置生成目录的最大层级开启这个功能。
|
||||
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
subMaxLevel: 2
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
## auto2top
|
||||
|
||||
- 类型：`Boolean`
|
||||
- 默认值: `false`
|
||||
* 类型：`Boolean`
|
||||
* 默认值: `false`
|
||||
|
||||
切换页面后是否自动跳转到页面顶部。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
auto2top: true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
## homepage
|
||||
|
||||
- 类型：`String`
|
||||
- 默认值: `README.md`
|
||||
* 类型：`String`
|
||||
* 默认值: `README.md`
|
||||
|
||||
设置首页文件加载路径。适合不想将 `README.md` 作为入口文件渲染，或者是文档存放在其他位置的情况使用。
|
||||
|
||||
|
|
@ -145,13 +139,14 @@ window.$docsify = {
|
|||
homepage: 'home.md',
|
||||
|
||||
// 文档和仓库根目录下的 README.md 内容一致
|
||||
homepage: 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
|
||||
}
|
||||
homepage:
|
||||
'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
|
||||
};
|
||||
```
|
||||
|
||||
## base-path
|
||||
## basePath
|
||||
|
||||
- 类型：`String`
|
||||
* 类型：`String`
|
||||
|
||||
文档加载的根路径，可以是二级路径或者是其他域名的路径。
|
||||
|
||||
|
|
@ -163,15 +158,15 @@ window.$docsify = {
|
|||
basePath: 'https://docsify.js.org/',
|
||||
|
||||
// 甚至直接渲染其他仓库 readme
|
||||
basePath: 'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
|
||||
}
|
||||
basePath:
|
||||
'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
## coverpage
|
||||
|
||||
- 类型：`Boolean|String`
|
||||
- 默认值: `false`
|
||||
* 类型：`Boolean|String`
|
||||
* 默认值: `false`
|
||||
|
||||
启用[封面页](zh-cn/cover.md)。开启后是加载 `_coverpage.md` 文件，也可以自定义文件名。
|
||||
|
||||
|
|
@ -181,26 +176,25 @@ window.$docsify = {
|
|||
|
||||
// 自定义文件名
|
||||
coverpage: 'cover.md'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## name
|
||||
|
||||
- 类型：`String`
|
||||
|
||||
* 类型：`String`
|
||||
|
||||
文档标题，会显示在侧边栏顶部。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
name: 'docsify'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## name-link
|
||||
## nameLink
|
||||
|
||||
- 类型：`String`
|
||||
- 默认值：`window.location.pathname`
|
||||
* 类型：`String`
|
||||
* 默认值：`window.location.pathname`
|
||||
|
||||
点击文档标题后跳转的链接地址。
|
||||
|
||||
|
|
@ -213,12 +207,12 @@ window.$docsify = {
|
|||
'/zh-cn/': '/zh-cn/',
|
||||
'/': '/'
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## markdown
|
||||
|
||||
- 类型: `Object|Function`
|
||||
* 类型: `Object|Function`
|
||||
|
||||
参考 [Markdown 配置](zh-cn/markdown.md)。
|
||||
|
||||
|
|
@ -235,46 +229,46 @@ window.$docsify = {
|
|||
},
|
||||
|
||||
// function
|
||||
markdown: function (marked, renderer) {
|
||||
markdown: function(marked, renderer) {
|
||||
// ...
|
||||
return marked
|
||||
return marked;
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## theme-color
|
||||
## themeColor
|
||||
|
||||
- 类型：`String`
|
||||
* 类型：`String`
|
||||
|
||||
替换主题色。利用 [CSS3 支持变量](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)的特性，对于老的浏览器有 polyfill 处理。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
themeColor: '#3F51B5'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## alias
|
||||
|
||||
- 类型：`Object`
|
||||
* 类型：`Object`
|
||||
|
||||
定义路由别名，可以更自由的定义路由规则。 支持正则。
|
||||
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
alias: {
|
||||
'/foo/(+*)': '/bar/$1', // supports regexp
|
||||
'/zh-cn/changelog': '/changelog',
|
||||
'/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG',
|
||||
'/changelog':
|
||||
'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG',
|
||||
'/.*/_sidebar.md': '/_sidebar.md' // See #301
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## auto-header
|
||||
## autoHeader
|
||||
|
||||
- 类型：`Boolean`
|
||||
* 类型：`Boolean`
|
||||
|
||||
同时设置 `loadSidebar` 和 `autoHeader` 后，可以根据 `_sidebar.md` 的内容自动为每个页面增加标题。[#78](https://github.com/QingWei-Li/docsify/issues/78)
|
||||
|
||||
|
|
@ -282,19 +276,19 @@ window.$docsify = {
|
|||
window.$docsify = {
|
||||
loadSidebar: true,
|
||||
autoHeader: true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## execute-script
|
||||
## executeScript
|
||||
|
||||
- 类型：`Boolean`
|
||||
* 类型：`Boolean`
|
||||
|
||||
执行文档里的 script 标签里的脚本，只执行第一个 script ([demo](zh-cn/themes.md))。 如果 Vue 存在，则自动开启。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
executeScript: true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
```markdown
|
||||
|
|
@ -303,71 +297,84 @@ window.$docsify = {
|
|||
<script>
|
||||
console.log(2333)
|
||||
</script>
|
||||
|
||||
```
|
||||
|
||||
注意如果执行的是一个外链脚本，比如 jsfiddle 的内嵌 demo，请确保引入 [external-script](plugins.md?id=外链脚本-external-script) 插件。
|
||||
|
||||
## no-emoji
|
||||
## noEmoji
|
||||
|
||||
* type: `Boolean`
|
||||
|
||||
禁用 emoji 解析。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
noEmoji: true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## merge-navbar
|
||||
## mergeNavbar
|
||||
|
||||
* type: `Boolean`
|
||||
|
||||
小屏设备下合并导航栏到侧边栏。
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
mergeNavbar: true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## format-updated
|
||||
## formatUpdated
|
||||
|
||||
* type: `String|Function`
|
||||
|
||||
我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`。参考 https://github.com/lukeed/tinydate#patterns
|
||||
|
||||
我们可以显示文档更新日期通过 **{docsify-updated<span>}</span>** 变量. 并且格式化日期通过 `formatUpdated`。
|
||||
参考 https://github.com/lukeed/tinydate#patterns
|
||||
```js
|
||||
window.$docsify = {
|
||||
formatUpdated: '{MM}/{DD} {HH}:{mm}',
|
||||
|
||||
formatUpdated: function (time) {
|
||||
formatUpdated: function(time) {
|
||||
// ...
|
||||
|
||||
return time
|
||||
return time;
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## external-link-target
|
||||
## externalLinkTarget
|
||||
|
||||
当前默认为 _blank, 配置一下就可以：
|
||||
* type: `String`
|
||||
* default: `_blank`
|
||||
|
||||
当前默认为 \_blank, 配置一下就可以：
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
externalLinkTarget: '_self' // default: '_blank'
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## routerMode
|
||||
|
||||
## noCompileLinks
|
||||
|
||||
- 类型: `Array`
|
||||
|
||||
|
||||
有时我们不希望 docsify 处理我们的链接。 参考 [#203](https://github.com/QingWei-Li/docsify/issues/203)
|
||||
|
||||
* type: `String`
|
||||
* default: `history`
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
noCompileLinks: [
|
||||
'/foo',
|
||||
'/bar/.*'
|
||||
]
|
||||
}
|
||||
routerMode: 'history' // default: 'hash'
|
||||
};
|
||||
```
|
||||
|
||||
## noCompileLinks
|
||||
|
||||
* 类型: `Array`
|
||||
|
||||
有时我们不希望 docsify 处理我们的链接。 参考 [#203](https://github.com/QingWei-Li/docsify/issues/203)
|
||||
|
||||
```js
|
||||
window.$docsify = {
|
||||
noCompileLinks: ['/foo', '/bar/.*']
|
||||
};
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue