This commit is contained in:
qingwei.li 2017-01-10 23:32:25 +08:00
parent ef53a07f49
commit 510ae37a04
3 changed files with 39 additions and 1 deletions

View File

@ -1,7 +1,7 @@
## 1.6.0
### Features
- Improve sidebar performance. The active item is automatically scrolled in the visible view.
- New markdown grammar: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
- New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
## 1.5.2
### Bug fixes

View File

@ -157,6 +157,26 @@ window.$docsify = {
}
```
### Doc Helpers
#### p.tip
'! ' add your content will rendered as `<p class="tip">content</p>`
```markdown
! Important **information**
```
It will be rendered
```html
<p class="tip">Important <strong>information</strong></p>
```
e.g.
! Important **information**
## Options
You can add configurations in the script tag attributes or with `window.$docsify`.

View File

@ -163,6 +163,24 @@ window.$docsify = {
}
```
### 文档助手
#### 内置「提示」语法
感叹号加空格,后面接内容,会渲染成带 tip 类名的段落。
```markdown
! 提示信息,**支持其他 markdown 语法**
```
将被渲染成
```html
<p class="tip">提示信息<strong>支持其他 markdown 语法</strong></p>
```
效果
! 适合显示醒目的内容
## 配置参数