docs(markdown): update markdown config

This commit is contained in:
qingwei.li 2017-02-19 00:11:16 +08:00 committed by cinwell.li
parent 7b6a2ac404
commit a6d823b826
5 changed files with 40 additions and 9 deletions

View File

@ -111,7 +111,7 @@ Add TOC in custom sidebar.
```js
window.$docsify = {
subMaxLevel: 3
subMaxLevel: 2
}
```
@ -219,6 +219,17 @@ See [Markdown configuration](/markdown).
```js
window.$docsify = {
// object
markdown: {
smartypants: true,
renderer: {
link: function() {
// ...
}
}
},
// function
markdown: function (marked, renderer) {
// ...
return marked

View File

@ -1,12 +1,16 @@
# Markdown configuration
The Markdown parser is [marked](https://github.com/chjj/marked). You can customize how docsify renders your Markdown content to HTML.
The Markdown parser is [marked](https://github.com/chjj/marked). You can customize how docsify renders your Markdown content to HTML. Support customize `renderer`.
```js
window.$docsify = {
markdown: {
smartypants: true
// ...
smartypants: true,
renderer: {
link: function() {
// ...
}
}
}
}
```

View File

@ -113,7 +113,7 @@ window.$docsify = {
```js
window.$docsify = {
subMaxLevel: 3
subMaxLevel: 2
}
```
@ -212,12 +212,23 @@ window.$docsify = {
## markdown
- 类型: `Function`
- 类型: `Object|Function`
参考 [Markdown 配置](/zh-cn/markdown)。
```js
window.$docsify = {
// object
markdown: {
smartypants: true,
renderer: {
link: function() {
// ...
}
}
},
// function
markdown: function (marked, renderer) {
// ...
return marked

View File

@ -1,12 +1,16 @@
# Markdown 配置
内置的 Markdown 解析器是 [marked](https://github.com/chjj/marked),可以修改它的配置。
内置的 Markdown 解析器是 [marked](https://github.com/chjj/marked),可以修改它的配置。同时可以直接配置 `renderer`
```js
window.$docsify = {
markdown: {
smartypants: true
// ...
smartypants: true,
renderer: {
link: function() {
// ...
}
}
}
}
```

View File

@ -1,3 +1,4 @@
# 快速开始
推荐安装 `docsify-cli` 工具,可以方便创建及本地预览文档网站。