A gitbook plugin for merge git submodule summary.md.
book.json
{
"plugins": [
"submodule-summary"
]
}
and
gitbook install
Host Repo(HR): origin gitbook repo. Submodule Repo(SR): git submodule gitbook repo.
- HR add a git submodule from SR.
- Edit HR
SUMMARY.md
. - Enjoy it!
git submodule add [email protected]/yourname/repo.git path/to/submodule
Edit the HR SUMMARY.md
, replace specific location with the placeholder string <!-- SUBMODULE-SUMMARY path/to/submodule/SUMMARY.md -->
Now you can build the gitbook, the HR SUMMARY.md
contain pre-step string will replace with path/to/submodule/SUMMARY.md
content.
npm test
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
MIT