前言
关于 docsify 文档构建,大概两三年前就有弄过了。
那个时候开发了一个很粗糙的 three.js 库,因为当时做外包。
所以我就把自己的小库文档用 docsify 框架搭建好了,虽然现在回想起来做得很一般(:з」∠)(全部是 es5)
后来在华强也继续沿用了 docsify 框架搭建内部 Python 流程的文档。
当时 docsify 本身无法实现收缩左侧菜单的 tab , 我当时还用 JQuery 进行了一定程度的 优化。
然后文档生成的方式则是通过 PySide 写了个图形界面,通过 re 正则表达式去截取源代码相关的 doc string 。
自动生成文档 md 文件 以及 目录文件
当时不知道 Python 有你只的 pydoc 库,所以这个文档生成工具也是命名为 PyDod 了~
直到最近和 师兄 交流,还是会觉得博客记录的只是一些开发的坑和心得。
并没有能够实现知识的系统归纳,所以还是觉得有必要搭建一个系统性 wiki 文档,只是框架类似于 cgwiki 网站一样。
搭建好的文档链接 wiki.l0v0.com
wiki 文档搭建
虽然之前已经踩过一些坑了,但是还是太久没有搞过了,还是打算正儿八经看着文档去构建。
然后我发现 docsify 可谓是更加完善了,这次脚手架工具都已经搭建好了。
但是使用脚手架之后感觉还是不太方便,感觉太简陋了,啥东西都没有。
于是还是将线上的 docsify clone 下来进行魔改。
接入插件
官方的文档上提供了很多插件。
于是我就将一些有用的插件接入到我的 wiki 上,这个花了不少时间。
陆陆续续将下面的插件接入了
- docsify-themeable
- docsify-glossary
- docsify-tabs
- docsify-valine
- docsify-pagination
- docsify-count
多层嵌套
我以前写 markdown 没有 header 顺序的概念。
特别是 glossary 术语插件要求要用 5个 #####
但是这样左侧的侧边栏就失去了 层级的概念,也就是无论是 4个# 或是 还是 5个#
侧边栏的东西都是平级的。
后来我查了 docsify 的 issue 里面有个做佛经科判的大佬,做了个支持 108 层级的效果。
虽然 108 层级也是基于其他插件实现的,但是整体扩展效果还是很牛逼的~
后来我发现只要有层级顺序 # 构建 header 就可以让侧边栏有层级了,所以我在科判上花费了大量无谓的时间,最后还是什么东西都没有了~
线上编辑 & 文字字数
线上剪辑 和 文字字数 没有合并到一起的插件。
于是我稍微魔改了这个插件,将两个功能合并到一起。
pagination & addtoany
后来构建 pagination 打算将 addtoany 分享合并到一起。
于是将 pagination 的仓库 clone 下来。
进行了自己的魔改和测试。
总结
这次写得东西都比较简单了~
因为这些修改都不是太难。
后续文档要完善的东西还有很多,比如我想做一些文章翻译、还有自己知识体系的整理~