gitbook 自動生成summary文件

gitbook安裝參考官方文檔:html

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

方案1,julianxhokaxhiu/gitbook-plugin-summary

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

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

安裝json

npm i gitbook-plugin-summary --save

配置book.json插件

{
  "plugins": [
    "summary"
  ]
}

可是我本地mac環境老提示code

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.htm

不太瞭解npm,最後沒有處理,後面使用了方案2ip

方案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,感受會更優雅一些,插件化形式,但對於基本使用而已,能用便可,後面須要改良或者擴展再看了

相關文章
相關標籤/搜索