一些 Wiki 工具的尝试

我的核心需求:侧边栏导航(最好不需要手动设置),自动为文章生成固定的目录(不随滚动条移动消失),全文搜索。

我对侧边栏很执着,浏览的时候可以随时切换而不需要 back to top 再切换,有效率!

最好有目录,原因同上。

全文搜索也得有,方便查询...


一开始是因为自己阅读时的标注,看文档时摘抄等,一直放在硬盘,利用率很低...本来之前是放博客上的,想了想这些东西对我还算有点价值,但对别人来说确实没啥用...所以还是别放博客了...

也想也许把信息的组织方式折腾下,自己应该就会利用起来了。(这 flag 立的...

现在能很方便地查阅啦...希望能把资料用起来...


尝试过几个不需要服务器端支持的 wiki/docs,如下。

TL;DR;#

TiddlyWiki:要充分利用,最好遵循它的设计哲学,使用官方提供的文档语法。对Markdown 支持不友好,全文搜索只能提示标题,看不到搜索的关键词在哪段内容出现。

我做了一些配置:hqweay/my-tiddlywiki

但是现在没用它。

用 mkdocs!!就是本站,太香了...

试用#

TiddlyWiki#

这个是我感觉最酷的一个,因为用法很特别。

但是要达到最佳的使用效果,最好遵循它的设计哲学——将你的信息划分为最小的单位(tiddler),然后通过组织这些 tiddler 形成其它的条目。

我在用的时候发现如果我想留一篇安装教程,那我就最好把安装的步骤都划分为 tiddler。

把步骤划分为 tiddler 有许多好处,比如 TiddlyWiki 不支持为 .md 条目直接生成 toc 目录,我就可以通过手动组织 tiddler 的方式列出一个目录。

这太麻烦了。我有好些东西想弄上来呢,光折腾这些多花时间啊...

其实核心问题就是对 Markdown 的支持不友好,比如代码块的渲染还得使用第三方渲染插件(好在有已经有插件了),不能为 .md 条目直接生成目录(但它官方支持的 .tid 格式条目就能用宏做到)。

我寻思要充分发挥 TiddlyWiki 的能力,不仅得遵循它的哲学,还得最后使用它提供的语法...太麻烦了。(主要是把我之前 .md 格式的信息转换一次太麻烦了...)

其次,全文搜索只能提示标题,看不到搜索的关键词在哪段内容出现。

以及,TiddlyWiki 的条目(tiddler)名是全局的,也就是每个条目的名称不能重复。

不过 TiddlyWiki 不会污染你导入的 .md 文件,它在后台会生成一个 .meta 文件记录 .md 文件的索引(文件名),以及其它 TiddlyWiki 会用到的信息。

VuePress#

我觉得它很强大,但没有做到开箱即用...

比如它不能自动遍历目录下的文件生成路由——要做到也很简单,可以自己写个方法遍历生成。但我觉得这种功能应该提供个插件出来啊...

额,对,我没搜索过,不知道有没有插件...

这不是关键,我手动配置链接也行。关键在还没有全文搜索,需要的话得配置个在线工具...

官方似乎觉得还没有一个静态站全文搜索的好的实现,但我就自己用,不需要考虑性能啥的...

Hexo Wiki 主题#

找到两个 Hexo Wiki 主题,不大适合自己...

没有侧边栏的实现...

mkdocs#

这个好,啥都有了。而且手机端也支持侧边栏与目录,还支持配置字体啥的,太强了...好好好...

就是全文搜索需要特殊配置一下。