插件功能定制,参数详解

本插件支持以下参数的配置:这里展示的配置都是默认配置

  1. {
  2. "showLevel": true,
  3. "associatedWithSummary": true,
  4. "printLog": false,
  5. "multipleH1": true,
  6. "mode": "float",
  7. "showGoTop":true,
  8. "float": {
  9. "floatIcon": "fa fa-navicon",
  10. "showLevelIcon": false,
  11. "level1Icon": "fa fa-hand-o-right",
  12. "level2Icon": "fa fa-hand-o-right",
  13. "level3Icon": "fa fa-hand-o-right"
  14. },
  15. "pageTop": {
  16. "showLevelIcon": false,
  17. "level1Icon": "fa fa-hand-o-right",
  18. "level2Icon": "fa fa-hand-o-right",
  19. "level3Icon": "fa fa-hand-o-right"
  20. }
  21. }

showLevel : TYPE:boolean。

  1. 标题是否显示层级序号.页面标题和导航中的标题都会加上层级显示。(控制页面标题是否被重写)
  1. ---- xx.md ---
  2. # h1
  3. ## h2
  4. ### h3
  5. 显示层级后的页面效果如下:
  6. 1. h1
  7. 1.1. h2
  8. 1.1.1 h3

associatedWithSummary : TYPE:boolean

  1. 页面内的序号是否与 summary.md 中官方默认主题生成的序号相关联。
  1. 如果你打开了官网默认主题中的层级显示:
  2. "pluginsConfig": {
  3. "anchor-navigation-ex": {
  4. "associatedWithSummary":true
  5. },
  6. "theme-default": {
  7. "showLevel": true
  8. }
  9. }
  10. 那么这样写:
  11. ----- SUMMARY.md ------
  12. # Summary
  13. * [安装](chapter/install.md)
  14. * [命令](chapter/command.md)
  15. * [配置](chapter/bookjson.md)
  16. * [插件](chapter/plugin.md)
  17. * [prismjs 代码高亮](chapter/plugin/prismjs.md)
  18. * [ace 代码高亮编辑](chapter/plugin/ace.md)
  19. * [navigator 页面导航](chapter/plugin/navigator.md)
  20. ----- chapter/redis/cluster.md ------
  21. # redis集群的准备
  22. ## zlib
  23. 1. 安装redis-cluster依赖:redis-cluster的依赖库在使用时有兼容问题,在reshard时会遇到各种错误,请按指定版本安装.
  24. 2. 确保系统安装zlib,否则gem install会报(no such file to load -- zlib)
  25. ...

那么最终效果如下: image

printLog : TYPE:boolean (V1.0.6+)

是否打印处理日志,在排查生成book失败的时候很有用,能知道是哪一个文件出的错 如下图:使用了别的插件,但是只打印了出错的信息,不知道是哪一个文件。开启该选项,就能知道了 image

multipleH1 : TYPE:boolean (V1.0.6+)

是否是多h1模式?一般正常的书籍一个章节只有一个h1标签,也就是一个md文件一个标签。如果您的书籍是这种正常模式,请关闭该选项=false 最大的区别如下

  1. ---- multipleH1=true----
  2. # 多H1标题1
  3. ## 子标题
  4. # 多H1标题2
  5. ## 子标题
  6. ## 子标题
  7. 生成的标题如下:
  8. 1. H1标题1
  9. 1.1. 子标题
  10. 2. H1标题2
  11. 2.1. 子标题
  12. 2.2. 子标题
  13. ---- multipleH1=false----
  14. # 多H1标题1
  15. ## 子标题
  16. # 多H1标题2
  17. ## 子标题
  18. ## 子标题
  19. 生成的标题如下:
  20. H1标题1
  21. 1. 子标题
  22. H1标题2
  23. 1. 子标题
  24. 2. 子标题
  25. 看出区别了么?正常书籍模式,也就是只有一个h1的情况下,这个展示的排序序号更符合我们的需求。

mode

导航模式:分为三种

  1. float :浮动导航
  2. pageTop :页面内部顶部导航
  3. ‘’ : 不显示导航

float

mode = float的时候以下配置生效

  1. float: { //浮动导航设置
  2. "floatIcon": "fa fa-navicon", // 配置导航图标,如果你喜欢原先的 锚 图标可以配置为 fa-anchor
  3. "showLevelIcon": false, //是否显示层级图标
  4. "level1Icon": "fa fa-hand-o-right", //层级的图标css
  5. "level2Icon": "fa fa-hand-o-right",
  6. "level3Icon": "fa fa-hand-o-right"
  7. }

图标使用官网默认主题引入的css http://fontawesome.dashgame.com/

pageTop

mode = pageTop的时候以下配置生效

  1. pageTop: {
  2. showLevelIcon: false,
  3. level1Icon: "fa fa-hand-o-right",
  4. level2Icon: "fa fa-hand-o-right",
  5. level3Icon: "fa fa-hand-o-right"
  6. }

showGoTop : TYPE:boolean (V1.0.11+)

把返回顶部按钮独立出来了,为true的时候显示返回顶部按钮

额外功能支持

  • 在页面中增加<extoc></extoc>标签,会在此处生成TOC目录。
  • 在页面中增加<!-- ex_nonav -->标识,会让此页面不生成悬浮导航

    在首页、介绍页等地方可以使用该功能,能屏蔽一些代码,因为这些地方不能加载css