gitbook 自动生成summary文件

为什么80%的码农都做不了架构师？>>>   

gitbook安装参考官方文档：

https://toolchain.gitbook.com/setup.html

方案1，julianxhokaxhiu/gitbook-plugin-summary

Google基本上用的是 gitbook-plugin-summary

https://github.com/julianxhokaxhiu/gitbook-plugin-summary#readme

安装

npm i gitbook-plugin-summary --save

配置book.json

{
  "plugins": [
    "summary"
  ]
}

但是我本地mac环境老提示

yugj-mac-book:gitbook2 yugj$ npm i gitbook-plugin-summary --save npm WARN yugj@1.0.0 No description npm WARN yugj@1.0.0 No repository field.

不太了解npm，最后没有处理，后面使用了方案2

方案2，imfly/gitbook-summary

github地址：https://github.com/imfly/gitbook-summary

安装

npm install -g gitbook-summary

简单使用：

cd /path/to/your/book/
book sm

demo：

tree .
.
├── ORDER
│   ├── 0-README.md
│   └── 1-orderInfo.md
├── README.md
├── SUMMARY.md
└── USER
    ├── 0-README.md
    └── 1-userInfo.md

result:

cat SUMMARY.md
# Your Book Title

- ORDER
  * [0 README](ORDER/0-README.md)
  * [1 Order Info](ORDER/1-orderInfo.md)
- USER
  * [0 README](USER/0-README.md)
  * [1 User Info](USER/1-userInfo.md)

总结，能使用方案1，感觉会更优雅一些，插件化形式，但对于基本使用而已，能用即可，后面需要改良或者扩展再看了

转载于:https://my.oschina.net/yugj/blog/3031020