mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
173 lines
4.3 KiB
Markdown
173 lines
4.3 KiB
Markdown
# 插件列表
|
|
|
|
## 全文搜索 - Search
|
|
|
|
全文搜索插件会根据当前页面上的超链接获取文档内容，在 `localStorage` 内建立文档索引。默认过期时间为一天，当然我们可以自己指定需要缓存的文件列表或者配置过期时间。
|
|
|
|
|
|
```html
|
|
<script>
|
|
window.$docsify = {
|
|
search: 'auto', // 默认值
|
|
|
|
search : [
|
|
'/', // => /README.md
|
|
'/guide', // => /guide.md
|
|
'/get-started', // => /get-started.md
|
|
'/zh-cn/', // => /zh-cn/README.md
|
|
],
|
|
|
|
// 完整配置参数
|
|
search: {
|
|
maxAge: 86400000, // 过期时间，单位毫秒，默认一天
|
|
paths: [], // or 'auto'
|
|
placeholder: 'Type to search',
|
|
|
|
// 支持本地化
|
|
placeholder: {
|
|
'/zh-cn/': '搜索',
|
|
'/': 'Type to search'
|
|
},
|
|
|
|
noData: 'No Results!',
|
|
|
|
// 支持本地化
|
|
noData: {
|
|
'/zh-cn/': '找不到结果',
|
|
'/': 'No Results'
|
|
},
|
|
|
|
// 搜索标题的最大程级, 1 - 6
|
|
depth: 2
|
|
}
|
|
}
|
|
</script>
|
|
<script src="//unpkg.com/docsify"></script>
|
|
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
|
|
```
|
|
|
|
## 谷歌统计 - Google Analytics
|
|
|
|
需要配置 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>
|
|
```
|
|
|
|
也可以通过 `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>
|
|
```
|
|
|
|
## emoji
|
|
|
|
默认是提供 emoji 解析的，能将类似 `:100:` 解析成 :100:。但是它不是精准的，因为没有处理非 emoji 的字符串。如果你需要正确解析 emoji 字符串，你可以引入这个插件。
|
|
|
|
```html
|
|
<script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
|
|
```
|
|
|
|
## 外链脚本 - External Script
|
|
|
|
如果文档里的 script 是内联脚本，可以直接执行；而如果是外链脚本（即 js 文件内容由 `src` 属性引入），则需要使用此插件。
|
|
|
|
```html
|
|
<script src="//unpkg.com/docsify/lib/plugins/external-script.js"></script>
|
|
```
|
|
|
|
## 图片缩放 - Zoom image
|
|
|
|
Medium's 风格的图片缩放插件. 基于 [medium-zoom](https://github.com/francoischalifour/medium-zoom)。
|
|
|
|
```html
|
|
<script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
|
|
```
|
|
|
|
|
|
忽略某张图片
|
|
|
|
```markdown
|
|
|
|
```
|
|
|
|
|
|
|
|
## 在 Github 上编辑
|
|
|
|
在每一页上添加 `Edit on github` 按钮. 由第三方库提供, 查看 [document](https://github.com/njleonzhang/docsify-edit-on-github)
|
|
|
|
|
|
## Copy to Clipboard
|
|
|
|
Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs. Provided by [@jperasmus](https://github.com/jperasmus)
|
|
|
|
```html
|
|
<link rel="stylesheet" href="//unpkg.com/docsify-copy-code/styles.css">
|
|
<script src="//unpkg.com/docsify-copy-code/index.js"></script>
|
|
```
|
|
|
|
```javascript
|
|
window.$docsify = {
|
|
plugins: [
|
|
window.DocsifyCopyCodePlugin.init()
|
|
]
|
|
}
|
|
```
|
|
|
|
See [here](https://github.com/jperasmus/docsify-copy-code/blob/master/README.md) for more details.
|
|
|
|
|
|
|
|
## Disqus
|
|
|
|
Disqus comments. https://disqus.com/
|
|
|
|
```html
|
|
<script>
|
|
window.$docsify = {
|
|
disqus: 'shortname'
|
|
}
|
|
</script>
|
|
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
|
|
```
|
|
|
|
|
|
## Gitalk
|
|
|
|
[Gitalk](https://github.com/gitalk/gitalk) is a modern comment component based on Github Issue and Preact.
|
|
|
|
```html
|
|
<link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css">
|
|
|
|
<script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script>
|
|
<script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script>
|
|
<script>
|
|
const gitalk = new Gitalk({
|
|
clientID: 'Github Application Client ID',
|
|
clientSecret: 'Github Application Client Secret',
|
|
repo: 'Github repo',
|
|
owner: 'Github repo owner',
|
|
admin: ['Github repo collaborators, only these guys can initialize github issues'],
|
|
// facebook-like distraction free mode
|
|
distractionFreeMode: false
|
|
})
|
|
</script>
|
|
```
|
|
|
|
## Navigation
|
|
|
|
Pagination for docsify. By [@imyelo](https://github.com/imyelo)
|
|
|
|
```html
|
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
|
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
|
|
```
|