用ztree给gitlab添加目录导航

目录

给gitlab的wiki和markdown页面生成目录导航(TOC:Table of Contents),方便长篇Wiki内容的翻阅。

给gitlab wiki添加TOC

外部加载方式

通过jquery加载外部JS,达到给Wiki和markdown页面添加目录导航目的,测试在Firefox、Chrome、Safari中工作正常。

因在浏览器用js实现,不需要具有服务器管理权限、修改服务端模板,在gitlab服务器、gitlab.com均可使用该方法。

使用方法

zTreeToc Bookmark

说明

  1. 因资源加载和内容解析受网速影响,显示目录约需要2-3秒时间;
  2. 第一次使用可能因没有缓存而失败(如:空白的目录),再点一次书签即可成功加载;
  3. 点击左上角的"HideToc"可隐藏/显示目录;
  4. 自动检测当前页面是wiki或markdown页面,才会生成导航,否则不会加载。

效果截图

zTreeToc ScreenShot

其它

添加到模板

对于自己的gitlab服务器,可以将上面的ldztree.js添加到gitlabb模板中来实现自动加载目录导航。

Ztree及ztree_toc