https://github.com/morlay/gitbook-plugin-auto-summary
https://github.com/morlay/gitbook-plugin-auto-summary
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/morlay/gitbook-plugin-auto-summary
- Owner: morlay
- Created: 2017-12-24T16:17:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-24T16:18:00.000Z (over 8 years ago)
- Last Synced: 2025-02-25T22:15:54.698Z (over 1 year ago)
- Language: JavaScript
- Size: 1.95 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## gitbook-plugin-auto-summary
Plugin for gitbook to automate generate SUMMARY.md
### Rules
* Sorted by filename
* Ignore files which are with prefix `_`
* Pick first heading text as title
* Parts can be defined in `book.json`
### How to use
```json
{
"plugins": ["auto-summary"],
"pluginsConfig": {
"auto-summary": {
"parts": {
"README.md": "Part I",
"parts_2/**/*.md": "Part II"
}
}
}
}
```
will be
```md
* [others](others/README.md)
## Part I
* [xxx](README.md)
## Part II
* [parts_2](parts_2/README.md)
```