TOC 目录

文章目录

  • TOC 目录
    • 1. page-treeview 插件
    • 2. page-treeview-simple 插件
    • 3. simple-page-toc 插件
    • 4. page-toc 插件

1. page-treeview 插件

page-treeview 插件是生成页内目录

不需要插入标签,能支持到6级目录,安装可用

安装

npm i gitbook-plugin-simple-page-toc

book.json配置:

{"plugins": ["page-treeview"]
}

非必要配置:

"pluginsConfig": {"page-treeview": {"copyright": "Copyright © aleen42","minHeaderCount": "2","minHeaderDeep": "2"}
}

这个插件生成目录以后,下面有一行关于版权的文字。如果想去掉的话,找到插件目录下的index.js文件:***/node_modules/gitbook-plugin-page-treeview/lib/index.js 找到如下这段代码

2. page-treeview-simple 插件

page-treeview 功能相同,在其基础之上修改了以下内容:

  • 去除 copyRight 的提示内容与占用的空白高
  • 取消章节的折叠效果,默认展开显示完整章节

效果图

3. simple-page-toc 插件

simple-page-toc 插件生成本页目录 需要在文章中插入标签,支持1-3级目录 页面顶端生成。另外 GitBook 在处理重复的标题时有些问题,所以尽量不适用重复的标题。

安装

npm i gitbook-plugin-simple-page-toc

book.json配置:

{"plugins" : ["simple-page-toc"],"pluginsConfig": {"simple-page-toc": {"maxDepth": 3,"skipFirstH1": true}}
}
参数 说明
“maxDepth”: 3 使用深度最多为maxdepth的标题。
“skipFirstH1”: true 排除文件中的第一个h1级标题。

使用方法: 在需要生成目录的地方用下面的标签括起来,全文都生成的话就在首尾添加

效果图:

4. page-toc 插件

page-toc 插件在你的 Gitbook 的每个页面上添加了一个目录 (TOC)。您可以设置目录是否默认显示在所有页面上,您可以启用或禁用个别页面上的目录以覆盖默认值。
安装

npm i gitbook-plugin-page-toc-af

book.json配置:

{"plugins": [ "page-toc" ],"pluginsConfig": {"page-toc": {"selector": ".markdown-section h1, .markdown-section h2, .markdown-section h3, .markdown-section h4","position": "before-first","showByDefault": true}}
}

gitbook 插件 文章 TOC 目录相关推荐

  1. Gitbook 插件安装 - 导航目录折叠 chapter-fold

    chapter-fold 支持多层目录,点击导航栏的标题名就可以实现折叠扩展. How to use it? Add it to your book.json configuration: {plug ...

  2. GitBook插件整理

    介绍一下gitbook中book.json的一些实用配置和插件(book.json找不到可以在SUMMARY.md同级目录下新建一个) 1. 配置概况 1.1. 全局配置 title 设置书本的标题 ...

  3. GitBook插件整理 - book.json配置

    目录 1. 配置概况 1.1. 全局配置 1.2. 插件列表 plugins 1.3. 插件属性配置pluginsConfig 2. 一些实用插件 2.1. back-to-top-button 回到 ...

  4. GitBook插件整理 - book.json

    文章目录 1. 配置内容 1.1. 全局配置 1.2. 插件列表 plugins 1.3. 插件属性配置pluginsConfig 2. 一些实用插件 2.1. back-to-top-button ...

  5. gitbook 插件:Emoji 表情

    gitbook 插件:Emoji 表情 文章目录 gitbook 插件:Emoji 表情 1. advanced-emoji 插件 1.1 安装 1.2 配置 1.3 效果 1. advanced-e ...

  6. gitbook 插件 主题

    Gitbook 插件 主题 文章目录 Gitbook 插件 主题 1. theme-default 插件 1.1 安装 1.2 配置 1.3 效果 2. theme-comscore 插件 2.1 安 ...

  7. gitbook 插件 图标与LOGO

    gitbook 插件:图标与LOGO 文章目录 gitbook 插件:图标与LOGO 1. custom-favicon 插件 1.2 安装 1.3 配置 1.4 效果 2. favicon 插件 2 ...

  8. gitbook 插件 赞赏

    gitbook 插件 赞赏 文章目录 gitbook 插件 赞赏 1. donate 打赏插件 1.1 安装 1.2 配置 1.3 效果 1. donate 打赏插件 如果喜欢,请打赏 1.1 安装 ...

  9. gitbook 插件 pdf

    gitbook 插件 pdf 文章目录 gitbook 插件 pdf 1. pdf 插件 1.1 安装 1.2 导出 pdf 2. pdf-multi-link 插件 2.1 安装 2.2 配置 2. ...

最新文章

  1. ANSYS2020R2 Workbench汉化及高分屏适配
  2. XSS中JavaScript加密以及Filter bypass
  3. MySQL条件运算符的使用
  4. 2019-03-18-算法-进化(反转链表)
  5. Windows IIS 日志分析研究(Log Parser Log Parser Lizard Log Parser Studio) update...
  6. Centos 6.5部署nginx+uwsgi+django
  7. 科园贸易:帆软助力其推动数据应用落地,打造自主可控数据平台
  8. es集群节点数和分片数关系_ES数据插入和查询流程是怎么样的?
  9. 聚合maven+spring-boot打包可执行jar
  10. 综合网上解决mysql 5.7保存emoji 失败问题
  11. 【程序的流程】—— 顺序 / 分支 / 循环
  12. 昨天申请了这个blog,也就是半个多小时之前,eh,这是我的第几个blog了?
  13. 如何查看jdkApi在线帮助文档(下载)
  14. Axure-图表元件库
  15. 解决github下载及访问不稳定问题
  16. 活动报名 | 保护儿童,保护未来!智源发布《面向儿童的人工智能北京共识》
  17. 程序员的十楼层,看看自己在第几层
  18. 通达OA工作流程-使用方法
  19. 电脑无鼠标修复计算机怎么办,电脑屏幕只有鼠标箭头怎么解决_电脑开机后只显示鼠标修复方法...
  20. 什么是网桥?何为网桥?防火墙的端口防护是指什么?

热门文章

  1. 如何修改MySQL监听IP地址
  2. 入驻爱采购选择苏州本地服务商@江苏一网推
  3. 企业管理决策之金字塔思维
  4. 想要彻底掌握placement各种技巧,这个一定可以如你所愿
  5. 超全总线控制方式总结
  6. 怎样保护个人信息安全建议?
  7. linux锁屏自动登录,Linux系列:Ubuntu/fedora实用小技巧—禁止自动锁屏、设置免密码自动登录、免密码执行sudo操作...
  8. 转《论兔子怎么打败狼》
  9. Photoshop入门与进阶实例:3.3 乳胶漆纹理效果
  10. bootstrap导航窗格响应式二级菜单