gitbook SUMMARY.md

简介: gitbook SUMMARY.md

Gitbook SUMMARY.md

文章目录

1. 简介

GitBook默认使用SUMMARY.md文件实现目录结构的设定,在该文件中,可以通过缩进实现多级目录的效果,如:

# Summary
* [第一章](section1/README.md)
    * [第一节](section1/example1.md)
    * [第二节](section1/example2.md)
* [第二章](section2/README.md)
    * [第一节](section2/example1.md)

但是有个问题:gitbook默认只支持两层的导航栏,在遇到内容比较多需要章节层次比较深时,很不方便。

好在后来gitbook终于提供了多级导航栏的支持。

2. 多级目录实现

bui# Summary
 * [介绍](introduction/index.md)
    * [mercury 信息](introduction/information.md)
        * [Google Dapper](dapper/index.md)
 * [mercury实现](implementation/index.md)

要实现一个多级的导入栏很简单,就改动两个地方:

  • 第一行从 “# Summary” 修改为 “bui# Summary”
  • 章节的层次结构按照原来的格式要求继续缩进

3. 标题和水平线

也可以通过使用标题或者水平线标识将GitBook目录分为几个不同的部分:

# Summary
### Part I
* [Introduction](README.md)
* [Writing is nice](part1/writing.md)
* [GitBook is nice](part1/gitbook.md)
### Part II
* [We love feedback](part2/feedback_please.md)
* [Better tools for authors](part2/better_tools.md)
----
* [Last part without title](part3/title.md)

4. grunt

为了方便发布到github,我选择了使用grunt。

同样为了支持多层导航栏,grunt相关的插件也需要使用新版本。

具体需要修改package.js中的以下内容,目前最新的版本是这样:

"devDependencies": {
    "grunt": "~0.4.5",
    "grunt-gitbook": "~1.5.0",
    "grunt-gh-pages": "~0.10.0",
    "grunt-contrib-clean": "~0.6.0",
    "grunt-http-server": "~1.4.0"
},
"peerDependencies": {
    "grunt": "~0.4.5"
}

对于旧有项目,为了更新插件版本,可以先删除原来已经安装的插件后重新安装:

rm -rf node_modules/*
npm install
相关文章
|
2月前
|
算法 数据安全/隐私保护 C++
超级好用的C++实用库之MD5信息摘要算法
超级好用的C++实用库之MD5信息摘要算法
59 0
|
3月前
|
应用服务中间件 nginx
Docsify——部署后显示404且无法访问README.md
Docsify——部署后显示404且无法访问README.md
30 0
|
数据安全/隐私保护
s3cmd安装及使用
s3cmd安装及使用
|
缓存 PHP
Composer报错: Failed to execute (9) unzip -qq -o “D:\Code/vendor/composer/tmp-d44ec330d383e320b9a78bfc
Composer报错: Failed to execute (9) unzip -qq -o “D:\Code/vendor/composer/tmp-d44ec330d383e320b9a78bfc
210 0
Composer报错: Failed to execute (9) unzip -qq -o “D:\Code/vendor/composer/tmp-d44ec330d383e320b9a78bfc
|
算法 JavaScript
怎么给文件生成MD5
怎么给文件生成MD5
4803 0
|
小程序 开发者
app.json: [“subpackages“][0][“root“] 字段需为 目录
app.json: [“subpackages“][0][“root“] 字段需为 目录
399 0
app.json: [“subpackages“][0][“root“] 字段需为 目录
github—如何在README.md文件中添加图片
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_34173549/article/details/80551021 1、在github上的仓库建立一个存放图片的文件夹,文件夹名字随意。
10440 1
|
存储 开发工具 git
GitBook-auto-summary 根据markdown 标题生成目录文件SUMMARY.md
GitBook-auto-summary 根据markdown 标题生成目录文件SUMMARY.md