The best way to use Asciibook is used on CI/CD system. Any CI/CD service that supports docker can use Asciibook.
This chapter shows how to configure different CI/CD systems.
GitHub Actions is the official CI/CD service on GitHub. It’s free for open source project and charge by running time for private project.
.github/workflows/asciibook.yml in your repo with this content:
It means when push or pull request on this repo, create a job to run
asciibook build mybook.adoc, and upload the
build directory to workflow artifact, then you can download the build tarball from workflow status page.
If you want to pubilsh HTML result to GitHub pages, add the following content under
It means when push to master branch, create a job to push HTML result to
GitHub pages needs to be triggered manually in first time, go to settings page of project, select source from gh-pages branch, and select a theme to trigger publish.
Then push something to master branch to trigger GitHub Actions build, your pages will be publish later.
This book is a live sample for GitHub Actions with Asciibook, checkout source code for details: https://github.com/asciibook/docs .