目录结构

1.目录结构

  • Gitbook 初次初始化后会在当前目录下生成两个文件: SUMMARY.md、README.md
  • 其中 SUMMARY.md 主要是管理目录结构的
  • README.md则是默认的首页
  • book.json 需自己创建, 配置文件

1.1.目录

  • SUMMARY.md 控制左边的菜单目录
  • 他通过 Markdown的列表语法表示菜单目录间的层级关系
  • 紧凑型
# Summary
* [Introduction](README.md)
* [Part I](part1/README.md)
    * [Writing is nice](part1/writing.md)
    * [GitBook is nice](part1/gitbook.md)
* [Part II](part2/README.md)
    * [We love feedback](part2/feedback_please.md)
    * [Better tools for authors](part2/better_tools.md)
  • 分散型
# Summary

### Part I

* [Part I](part1/README.md)
    * [Writing is nice](part1/README.md#writing)
    * [GitBook is nice](part1/README.md#gitbook)
* [Part II](part2/README.md)
    * [We love feedback](part2/README.md#feedback)
    * [Better tools for authors](part2/README.md#tools)

### Part II

* [feedback](part2/feedback.md)
* [tools](part2/tools.md)

----

* [Last part](part3/last.md)
  • 但维护这个目录页确是很麻烦,所有也有插件可以自动生成菜单目录, 也推荐使用插件来自动生成 菜单目录
  • 自动生成目录的插件有两个: gitbook-plugin-summary, gitbook-plugin-aotu-summary, 个人推荐前者。

1.2.首页

  • README.md 文件是默认页, 因此该页面比较简单

1.2.配置文件

  • 没有 book.json 也可以正常使用, 但如果需要个人化添加一些功能或者插件, 就需要在该文件中配置
  • 简单示例:
{
    "title": "Hello world",   // 书的标题
    "language":"en",          // 语言
    "plugins": [              // 插件
        "code",               // 添加了一个插件
        "-search"             // 去掉了一个插件
    ],
    "pluginsConfig": {        // 插件的配置
        "code": {             // code 插件配置了一个参数
            "copyButtons": true
        }
    }
}
Copyright by SKYNE all right reserved,powered by Gitbook 2022-01-06

results matching ""

    No results matching ""