docs: add autoHeader

docsifyjs · Feb 19, 2017 · c108645 · c108645
1 parent b7768b1
commit c108645
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -254,3 +254,16 @@ window.$docsify = {
   }
 }
 ```
+
+## auto-header
+
+- type: `Boolean`
+
+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)
+
+```js
+window.$docsify = {
+  loadSidebar: true,
+  autoHeader: true
+}
+```
diff --git a/docs/zh-cn/configuration.md b/docs/zh-cn/configuration.md
@@ -229,7 +229,7 @@ window.$docsify = {
 
 - 类型：`String`
 
-替换主题色。利用 [CSS3 支持变量]((https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)的特性，对于老的浏览器有 polyfill 处理。
+替换主题色。利用 [CSS3 支持变量](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables)的特性，对于老的浏览器有 polyfill 处理。
 
 ```js
 window.$docsify = {
@@ -253,3 +253,15 @@ window.$docsify = {
 }
 ```
 
+## auto-header
+
+- 类型：`Boolean`
+
+同时设置 `loadSidebar` 和 `autoHeader` 后，可以根据 `_sidebar.md` 的内容自动为每个页面增加标题。[#78](https://github.com/QingWei-Li/docsify/issues/78)
+
+```js
+window.$docsify = {
+  loadSidebar: true,
+  autoHeader: true
+}
+```
diff --git a/docs/zh-cn/quickstart.md b/docs/zh-cn/quickstart.md
@@ -1,4 +1,3 @@
-# 快速开始
 
 推荐安装 `docsify-cli` 工具，可以方便创建及本地预览文档网站。