CUAV Chapters on GitBook

使用方法

添加下面的内容到 book.json 文件的对应位置，之后执行 gitbook install:

{
  "plugins": ["cuav-chapters"]
}

配置

{
  "pluginsConfig": {
    "cuav-chapters": {
      "chaptersUrl": "/xxx.json",
      "summaryMaxSize": 20,
      "useLimitExpanded": false
    }
  }
}

chaptersUrl

chaptersUrl 为动态目录的 url，格式为 json 格式：

[
  {
    "name": "一级目录名，没有二级目录",
    "url": "跳转的 url；如果不想跳转，请设置为'javascript:;'"
  },
  {
    "name": "一级目录名，拥有二级目录",
    "links": [
      {
        "name": "二级目录",
        "url": "跳转的 url；如果不想跳转，请设置为'javascript:;'"
      }
    ]
  }
]

最多只能到 2 级目录。

summaryMaxSize

自动展开目录最大个数，如配置 20，则目录小于 20 的话，将以展开的形式表示；反之，将收起目录。

useLimitExpanded

配置是否应用 summaryMaxSize；如果设置为 false，则 summaryMaxSize 失效，无论目录数多少，都收起目录。

更新内容

1.0.3

• Change: 修改 const 为 var，增强浏览器的兼容性

1.0.2

• Fix: 目录的 url 是 javascript:; 或 # 时，点击目录不显示下级菜单。
• Add: 设置 ajax 不缓存 chaptersUrl 获取的 json 文件。
• Change: 移除各文件开头的 License。

1.0.1

• Add: .npmignore 文件，使其能正常工作。

License

使用 BDS 3-clause license 进行许可