自定义插件

docsify 提供了一套插件机制,其中提供的钩子(hook)支持处理异步逻辑,可以很方便的扩展功能。

完整功能

  1. window.$docsify = {
  2. plugins: [
  3. function (hook, vm) {
  4. hook.init(function() {
  5. // 初始化时调用,只调用一次,没有参数。
  6. })
  7. hook.beforeEach(function(content) {
  8. // 每次开始解析 Markdown 内容时调用
  9. // ...
  10. return content
  11. })
  12. hook.afterEach(function(html, next) {
  13. // 解析成 html 后调用。beforeEach 和 afterEach 支持处理异步逻辑
  14. // ...
  15. // 异步处理完成后调用 next(html) 返回结果
  16. next(html)
  17. })
  18. hook.doneEach(function() {
  19. // 每次路由切换时数据全部加载完成后调用,没有参数。
  20. // ...
  21. })
  22. hook.mounted(function() {
  23. // 初始化完成后调用 ,只调用一次,没有参数。
  24. })
  25. hook.ready(function() {
  26. // 初始化并第一次加完成数据后调用,没有参数。
  27. })
  28. }
  29. ]
  30. }

!> 如果需要用 docsify 的内部方法,可以通过 window.Docsify 获取,通过 vm 获取当前实例。

例子

给每个页面的末尾加上 footer

  1. window.$docsify = {
  2. plugins: [
  3. function (hook) {
  4. var footer = [
  5. '<hr/>',
  6. '<footer>',
  7. '<span><a href="https://github.com/QingWei-Li">cinwell</a> &copy;2017.</span>',
  8. '<span>Proudly published with <a href="https://github.com/QingWei-Li/docsify" target="_blank">docsify</a>.</span>',
  9. '</footer>'
  10. ].join('')
  11. hook.afterEach(function (html) {
  12. return html + footer
  13. })
  14. }
  15. ]
  16. }

Edit Button

  1. window.$docsify = {
  2. plugins: [
  3. function(hook, vm) {
  4. hook.beforeEach(function (html) {
  5. var url = 'https://github.com/QingWei-Li/docsify/blob/master/docs' + vm.route.file
  6. var editHtml = '[? EDIT DOCUMENT](' + url + ')\n'
  7. return editHtml
  8. + html
  9. + '\n----\n'
  10. + 'Last modified {docsify-updated} '
  11. + editHtml
  12. })
  13. }
  14. ]
  15. }