https://github.com/yakima-teng/gitbook-plugin-folding-chapters
🌱 To make your gitbook with folding chapters
https://github.com/yakima-teng/gitbook-plugin-folding-chapters
chapter gitbook gitbook-plugin
Last synced: 3 months ago
JSON representation
🌱 To make your gitbook with folding chapters
- Host: GitHub
- URL: https://github.com/yakima-teng/gitbook-plugin-folding-chapters
- Owner: Yakima-Teng
- License: apache-2.0
- Created: 2018-05-03T07:11:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-02T13:17:33.000Z (about 7 years ago)
- Last Synced: 2025-06-28T18:45:41.100Z (3 months ago)
- Topics: chapter, gitbook, gitbook-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/gitbook-plugin-folding-chapters
- Size: 114 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Equip your GitBook with folding chapters
> This plugin will make chapters of your GitBook collapsible.
**This GitBook plugin won't work with the official GitBook default theme, because there are some bugs in that official theme. It's strongly recommended to use the GitBook theme [gitbook-plugin-theme-code](https://www.npmjs.com/package/gitbook-plugin-theme-code) instead of the default theme.**
An example snapshot (GitBook theme used: [gitbook-plugin-theme-code](https://www.npmjs.com/package/gitbook-plugin-theme-code)):
### How to use it?
Add it to your `book.json` configuration:
```
{
"plugins": ["folding-chapters"]
}
```
Install your plugins using:
```
$ gitbook install
```
### Configuration
There is no configuration needed at the moment, can be left empty.
```
{
"pluginsConfig": {
"folding-chapters":{}
}
}
```
Actually, it's okay for you to ignore the above code -- you do not need to type them.
### Thanks
This plugin is built on base of [gitbook-plugin-expandable-chapters](https://github.com/DomainDrivenArchitecture/gitbook-plugin-expandable-chapters): It seems that plugin didn't fit GitBook default theme since version 3.0.0, at least I found that plugin not available in my gitbook, so I create this plugin you are seeing now on base of that plugin.