插件列表

全文搜索 - Search

全文搜索插件会根据当前页面上的超链接获取文档内容，在 localStorage 内建立文档索引。默认过期时间为一天，当然我们可以自己指定需要缓存的文件列表或者配置过期时间。

  1. <script>
  2.   window.$docsify = {
  3.     search: 'auto', // 默认值
  5.     search : [
  6.       '/',            // => /README.md
  7.       '/guide',       // => /guide.md
  8.       '/get-started', // => /get-started.md
  9.       '/zh-cn/',      // => /zh-cn/README.md
  10.     ],
  12.     // 完整配置参数
  13.     search: {
  14.       maxAge: 86400000, // 过期时间，单位毫秒，默认一天
  15.       paths: [], // or 'auto'
  16.       placeholder: 'Type to search',
  18.       // 支持本地化
  19.       placeholder: {
  20.         '/zh-cn/': '搜索',
  21.         '/': 'Type to search'
  22.       },
  24.       noData: 'No Results!',
  26.       // 支持本地化
  27.       noData: {
  28.         '/zh-cn/': '找不到结果',
  29.         '/': 'No Results'
  30.       },
  32.       // 搜索标题的最大程级, 1 - 6
  33.       depth: 2
  34.     }
  35.   }
  36. </script>
  37. <script src="//unpkg.com/docsify"></script>
  38. <script src="//unpkg.com/docsify/lib/plugins/search.js"></script>

谷歌统计 - Google Analytics

需要配置 track id 才能使用。

  1. <script>
  2.   window.$docsify = {
  3.     ga: 'UA-XXXXX-Y'
  4.   }
  5. </script>
  6. <script src="//unpkg.com/docsify"></script>
  7. <script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>

也可以通过 data-ga 配置 id。

  1. <script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
  2. <script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>

emoji

默认是提供 emoji 解析的，能将类似 :100: 解析成 :100:。但是它不是精准的，因为没有处理非 emoji 的字符串。如果你需要正确解析 emoji 字符串，你可以引入这个插件。

  1. <script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>

外链脚本 - External Script

如果文档里的 script 是内联脚本，可以直接执行；而如果是外链脚本（即 js 文件内容由 src 属性引入），则需要使用此插件。

  1. <script src="//unpkg.com/docsify/lib/plugins/external-script.js"></script>

图片缩放 - Zoom image

Medium’s 风格的图片缩放插件. 基于 medium-zoom。

  1. <script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>

忽略某张图片

  1. ![](image.png ':no-zoom')

在 Github 上编辑

在每一页上添加 Edit on github 按钮. 由第三方库提供, 查看 document