Skip to content

Commit c108645

Browse files
committed
docs: add autoHeader
1 parent b7768b1 commit c108645

File tree

3 files changed

+26
-2
lines changed

3 files changed

+26
-2
lines changed

docs/configuration.md

+13
Original file line numberDiff line numberDiff line change
@@ -254,3 +254,16 @@ window.$docsify = {
254254
}
255255
}
256256
```
257+
258+
## auto-header
259+
260+
- type: `Boolean`
261+
262+
If `loadSidebar` and `autoHeader` are both enabled, for each link in _sidebar.md, prepend a header to the page before converting it to html. [#78](https://github.com/QingWei-Li/docsify/issues/78)
263+
264+
```js
265+
window.$docsify = {
266+
loadSidebar: true,
267+
autoHeader: true
268+
}
269+
```

docs/zh-cn/configuration.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ window.$docsify = {
229229

230230
- 类型:`String`
231231

232-
替换主题色。利用 [CSS3 支持变量]((https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)的特性,对于老的浏览器有 polyfill 处理。
232+
替换主题色。利用 [CSS3 支持变量](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)的特性,对于老的浏览器有 polyfill 处理。
233233

234234
```js
235235
window.$docsify = {
@@ -253,3 +253,15 @@ window.$docsify = {
253253
}
254254
```
255255

256+
## auto-header
257+
258+
- 类型:`Boolean`
259+
260+
同时设置 `loadSidebar``autoHeader` 后,可以根据 `_sidebar.md` 的内容自动为每个页面增加标题。[#78](https://github.com/QingWei-Li/docsify/issues/78)
261+
262+
```js
263+
window.$docsify = {
264+
loadSidebar: true,
265+
autoHeader: true
266+
}
267+
```

docs/zh-cn/quickstart.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# 快速开始
21

32
推荐安装 `docsify-cli` 工具,可以方便创建及本地预览文档网站。
43

0 commit comments

Comments
 (0)