Gitbook 的插件,自动生成SUMMARY.md
使用目录树的结构,插件配置到book.json中
原作者不维护了,自己也不用了。就拿来改改,改成自己顺手的了。
这里推荐大家的文件名可以通过 在文件名前,加上数字的形式,来使文件有顺序。生成目录也会按这个顺序来生成目录。
没有push到npm库中,可以 clone 到 node_modules 目录中。
然后在 book.json 中添加插件
{
"plugins": [
"summary"
]
}
然后就可以愉快的玩耍了。
$ gitbook serve
# title
)
加了几个属性配置:
"pluginsConfig": {
"summary" : {
"excludeDir":["assets","styles"], //需要排除的文件夹,排除的文件夹不会自动生成目录
"readme":"0-README.md" , //目录对应的文件, 默认是 0-README.md
"summary":"SUMMARY.md" , // 指定summary文件 , 默认是 SUMMARY.md
"introduction":{ // introduction 目录替换 .
"title":"introduction", //系统默认是 introduction , 可以自己更改
"file":"README.md" //系统默认是指向 根目录下的 README.md , 可以更改为自己的指定文件
}
}
}
[ 'node_modules/**', '_book', '_layouts', '**/img' ]
$ tree .
.
├── First-Dir
├── Second-Dir
│ ├── 0-README.md
│ ├── 1-TEST.md
│ ├── Second-SubDir-one
│ └── Second-SubDir-two
│ ├── 0-README.md
│ └── 1-TEST.md
├── Third-Dir
│ └── 0-README.md
├── README.md
└── SUMMARY.md
生成的 SUMMARY.md 就是这样子的:
your SUMMARY.md file will look like this:
## First Dir
- [Second Dir](Second-Dir/0-README.md)
- [TEST](Second-Dir/1-TEST.md)
- [Second SubDir One]()
- [Second SubDir Two](Second-Dir/Second-SubDir-two/0-README.md)
- [TEST](Second-Dir/Second-SubDir-two/1-TEST.md)
- [Third Dir](Third-Dir/0-README.md)
这里再解释一下:
这里有个注意点:Second-Dir 这个root目录,由于有了0-README.md这个文件存在,就不再是root目录了,而是一个普通的导航链接了。 就是降级了,和它的子文件1-TEST.md是同级文件了。所以Second Dir和Test是同级的。 Second-SubDir-one:不是root目录,同时也没有子文件,那么就做为一个label存在,(禁用的链接) Second-SubDir-two:不是root目录,有子文件,【那么就会产生目录层级了】。
Code span (with the back ticks) won't be recognize. So better avoid until someone find it important enough to fix that :P
If it seems like it's not rerendering, save again. Changes are taken into account on the second server restart.
unexpected token function
: This is caused by the only async-await in the code. 2 ways of fixing
it. First, install Node 7.6+. Second, pull request it. It's only a 2-3 lines change :)
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。