docsify/docs/zh-cn/plugins.md

74 lines
1.8 KiB
Markdown
Raw Normal View History

2017-02-22 21:29:26 +08:00
# 插件列表
2017-02-12 15:51:26 +08:00
2017-02-22 21:29:26 +08:00
## 全文搜索 - Search
2017-02-12 15:51:26 +08:00
2017-02-15 20:00:56 +08:00
全文搜索插件会根据当前页面上的超链接获取文档内容,在 `localStorage` 内建立文档索引。默认过期时间为一天,当然我们可以自己指定需要缓存的文件列表或者配置过期时间。
2017-02-12 15:51:26 +08:00
```html
<script>
window.$docsify = {
2017-02-13 22:43:58 +08:00
search: 'auto', // 默认值
2017-02-12 15:51:26 +08:00
search : [
'/', // => /README.md
'/guide', // => /guide.md
'/get-started', // => /get-started.md
'/zh-cn/', // => /zh-cn/README.md
],
// 完整配置参数
search: {
maxAge: 86400000, // 过期时间,单位毫秒,默认一天
paths: [], // or 'auto'
2017-02-19 11:22:34 +08:00
placeholder: 'Type to search',
// 支持本地化
placeholder: {
'/zh-cn/': '搜索',
'/': 'Type to search'
},
noData: 'No Results!',
// 支持本地化
noData: {
'/zh-cn/': '找不到结果',
'/': 'No Results'
2017-02-19 11:22:34 +08:00
}
2017-02-12 15:51:26 +08:00
}
}
</script>
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
```
2017-02-22 21:29:26 +08:00
## 谷歌统计 - Google Analytics
2017-02-12 15:51:26 +08:00
需要配置 track id 才能使用。
```html
<script>
window.$docsify = {
ga: 'UA-XXXXX-Y'
}
</script>
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
```
2017-02-12 20:12:36 +08:00
也可以通过 `data-ga` 配置 id。
```html
<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
```
2017-02-22 21:29:26 +08:00
## emoji
2017-02-12 20:12:36 +08:00
2017-02-22 21:29:26 +08:00
默认是提供 emoji 解析的,能将类似 `:100:` 解析成 :100:。但是它不是精准的,因为没有处理非 emoji 的字符串。如果你需要正确解析 emoji 字符串,你可以引入这个插件。
2017-02-12 15:51:26 +08:00
2017-02-22 21:29:26 +08:00
```html
<script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
2017-02-12 15:51:26 +08:00
```