auto-summary's Introduction

gitbook auto summary

介绍

自动生成summary文件的插件比较多，这边维护目的是自动生成SUMMARY同时将1 2 级标题展示到SUMMARY文件

使用

java AutoSummary {bookpath}

SUMMARY.md自动生成规则

README.md 文件优先展示排序
文件列表按文件名称排序
1_名字格式文件在SUMMARY文件里面只展示名称，序号仅排序用
md文件里面1 2 级标题将自动生成目录到SUMMARY文件

样例

   .
   ├── 1_概述.md
   ├── 2_接口协议.md
   ├── 3_数据类型.md
   ├── 4_接口定义
   │   └── 英文服务名.md
   ├── 5_附录.md
   ├── README.md
   └── book.json

生成的文件SUMMARY.md

# Summary
* [修订记录](README.md#修订记录)
* [文档概述](1_概述.md#文档概述)
  * [缩略语与术语](1_概述.md#缩略语与术语)
  * [适用范围](1_概述.md#适用范围)
* [访问路径](2_接口协议.md#访问路径)
  * [报文格式](2_接口协议.md#报文格式)
    * [请求参数](2_接口协议.md#请求参数)
    * [响应参数](2_接口协议.md#响应参数)
* [基本类型](3_数据类型.md#基本类型)
  * [复合类型](3_数据类型.md#复合类型)
    * [XXX信息](3_数据类型.md#xxx信息)
* [接口定义](4_接口定义/.DS_Store#接口定义)
  * [XXX模块](4_接口定义/英文服务名.md#XXX模块)
      * [XXX接口xxx](4_接口定义/英文服务名.md#xxx接口xxx)
* [公共返回码](5_附录.md#公共返回码)
  * [枚举值定义](5_附录.md#枚举值定义)
    * [XX类型](5_附录.md#xx类型)
    * [XX编码](5_附录.md#xx编码)