From c998fad98e049e69262c889af07eaea60f9584ba Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Thu, 12 Jan 2017 20:28:59 +0800 Subject: [PATCH] Add docs --- CHANGELOG.md | 5 +++++ docs/README.md | 33 ++++++++++++++++++++++++++++++++- docs/zh-cn.md | 30 ++++++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a282a05a..04e0c48d 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/docs/README.md b/docs/README.md index 487023d4..56cdff77 100644 --- a/docs/README.md +++ b/docs/README.md @@ -433,4 +433,35 @@ Generate cover page. window.$docsify = { coverpage: true } -``` \ No newline at end of file +``` + +### name + +Project name. It is displayed in the sidebar. + +```html + +``` + +```js +window.$docsify = { + name: 'docsify' +} +``` + +### nameLink + +Name link. The default value is `window.location.pathname`. + + +```html + +``` + +```js +window.$docsify = { + nameLink: '/' +} +``` + + diff --git a/docs/zh-cn.md b/docs/zh-cn.md index a9dd9b86..31a740b5 100644 --- a/docs/zh-cn.md +++ b/docs/zh-cn.md @@ -437,3 +437,33 @@ window.$docsify = { coverpage: true } ``` + + +### name + +项目名,将显示在侧边栏。 + +```html + +``` + +```js +window.$docsify = { + name: 'docsify' +} +``` + +### nameLink + +项目名链接,默认为 `window.location.pathname`。 + +```html + +``` + +```js +window.$docsify = { + nameLink: '/' +} +``` +