Gitbook Publish Action
This action publishes a GitBook to GitHub pages.
The source branch is master
, and the target branch is gh-pages
. If gh-pages
does not exist, it will be created automatically.
How to Use
- Copy this project to a new repo.
- Change
README.md
to the first page for the book. - Change
SUMMARY.md
to the table of contents for the book. - Update project url in [
book.json
]. - Render GitBook and publish to branch
gh-pages
by running [bin/publish.sh
]. - After running
publish.sh
the first time, pushing changed tomaster
will trigger a new build of the GitBook
Creating access token
- This action requires a personal access token (PAT). The value of the PAT must be used to create a GitHub secret with the key name of
PERSONAL_TOKEN
.
Caveat
Repo must be public to generate the GitBook