内置 Wiki 的简单说明

内置 Wiki 的一个 Demo 网站: https://help.metion.app/wiki

“内置Wiki”有什么特色

未经整理的知识,或许算不上知识了。这是我们自己在是使用这个功能时由衷的一个感触。
知识或许不应该是树状的,也不是思维导图形式的,而是相互交错的网状;特别新知识的受众,一个经过思考而重新梳理的知识结点网,会有效地提高知识的到达率。

在 FarBox 2.0 中,每个网站都内置了 Wiki、Album 的子站,Wiki 的设置相对复杂一些,但它在访问界面的保持着简洁。

内置的 Wiki 功能,它有下面这些功能:

  • 全文检索引擎
  • 可按文件夹分类
  • 根据文件路径形成的线索导航
  • 有 Tag
  • 有 TOC
  • 文章内引用其它文档有摘要性的预览
  • 有双向链接
  • 可以评论以及邮件通知
  • 支持 Wiki Link 的语法,我们还略微扩展了这个语法
  • 有3D 视觉化的节点图,包含了 Tag 和双向链接的关系
  • 3D Force Graph 不只支持全站的,每个文件夹都有自己的 Graph

一些设置项和说明

  • 网站设置中可以设定 Posts Root,Wiki 设置中可以设定 Wiki Root,建议让数据分离,比如根目录下分别有 Blog、Wiki 两个目录。
  • 在 Wiki 的设置中,要先自定义 Custom Items of Homepage (自定义主页项目),Path 对应了 Wiki Root 下的一个目录名称,另外再选择图标,需要排序直接拖动即可。
  • Wiki 的题图设置是在网站的 背景图与头像 中处理。
  • 默认开启了 Wiki Nodes 的功能,也就是整个 Wiki 的可视化,它基于文档的引用、双向连接、Tag 这些数据;未经整理、或者文章之间的关联性不够,会让 Wiki Nodes 的视觉“惨不忍睹”,换句话说,知识是需要整理的。
  • 网站的搜索引擎有索引预热的过程,网站文章更新后第一次关键词可能会无法命中,第二次就可以了。
  • 如果网站的模板没有处理好自动导航,可以自行进入文件管理器 编辑 nav.json 就可以了, Wiki 的路径为 /wiki,网站主页的路径为 /,Wiki Notes 的路径为 /wiki_nodes 。

Wiki Link 语法

默认会使用 [name](link) 这样 Markdown 超级链接的语法构建文档之间的引用关系,FarBox 也支持 Wiki Link 方式的语法。

语法参考如下:

[[一篇文档.md | 显示的标题 # hash_id]]
|和 # 后面的并不是必须的,文档路径应该以 / 开头表示相对当前工作目录的,反之则表示同样位于当前文档所在的父目录。

[[#一个标签 | 显示的标题]]
如果关联的文档路径以 # 开头,则表示它是一种特殊的 Tag 申明。

## 一个二级标题 #id
Header 语法后增加 #的形式会形成对应 URL 的 hash,不支持中文,仅有英文和数字组成。对应上面 Wiki Link 语法中的 hash_id

MarkEditor 和 Markdown.app 的小贴士

  1. “启用文档引用自动补全” 功能;
  2. 使用快捷键 Shift+Command+L,可以插入链接,然后输入名称,就会自动匹配对应的文档并插入;
  3. 点击文档性质的链接,可以跳转打开对应的文档;再右键点击正文区域,可以返回原先的文档。
Comments
Write a Comment