Add docs

CHANGELOG.md

@@ -1,7 +1,12 @@
+## 1.7.0
+
 ### Bug fixes
 - Fixed custom cover background, fixed #52
 - Fixed sticky sidebar
 
+## Features
+- Add `name` and `nameLink`
+
 ## 1.6.1
 ### Bug fixes
 - Fixed sidebar bug when the coverpage exist

docs/README.md

@@ -433,4 +433,35 @@ Generate cover page.
 window.$docsify = {
   coverpage: true
 }
-```
+```
+
+### name
+
+Project name. It is displayed in the sidebar.
+
+```html
+<script src="/lib/docsify.js" data-name="docsify"></script>
+```
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+### nameLink
+
+Name link. The default value is `window.location.pathname`.
+
+
+```html
+<script src="/lib/docsify.js" data-name-link="/"></script>
+```
+
+```js
+window.$docsify = {
+  nameLink: '/'
+}
+```
+
+

docs/zh-cn.md

@@ -437,3 +437,33 @@ window.$docsify = {
   coverpage: true
 }
 ```
+
+
+### name
+
+项目名，将显示在侧边栏。
+
+```html
+<script src="/lib/docsify.js" data-name="docsify"></script>
+```
+
+```js
+window.$docsify = {
+  name: 'docsify'
+}
+```
+
+### nameLink
+
+项目名链接，默认为 `window.location.pathname`。
+
+```html
+<script src="/lib/docsify.js" data-name-link="/"></script>
+```
+
+```js
+window.$docsify = {
+  nameLink: '/'
+}
+```
+