目录结构

在clone git仓库后和在构建文档前，文档根目录下会产生多个系统档案文件，下面是对于档案文件的介绍。

• SUMMARY.md

  定义文档的目录结构，其架构大致如下

    将文档整理于此，提供线上快速查询
    * [第一层目录](first.md)
      * [第二层目录](second.md)
        * [第三层目录](third.md)
    * [第一层目录](first1.md)
  

  注意 文档目录的设计应该不要太复杂，所以设计上尽量采用两层目录结构。

• README.md

  定义文档的简介

    该指南是对文档编写的规范定义
  

  内容会出现在指南介绍的章节中

• book.json

  定义文档的属性，包含需使用哪些插件，其文档结构如下

    {
        // 文档metadata
        "title": "",
        "discription": "",
  
        // 插件列表,如果包含"-name"代表插件移除
        "plugins": [],
  
        // 插件配置
        "pluginsConfig": {},
  
        // 模板参数
        "variables": {},
  
        // 模板link，定义点击标题和分享按钮(null: default, false: remove, string: new value)
        "links": {
            // 自定义顶部菜单
            "sidebar": {
                "Custom link name": "http://www.dfzq.com.cn"
            },
  
            // 分享按钮
            "sharing": {
                "google": null,
                "facebook": false,
                "twitter": false,
                "weibo": null,
                "all": null
            }
        }
    }