Skip to content
book

GitHub Action

Build and Publish GitBook

v1.0.3 Latest version

Build and Publish GitBook

book

Build and Publish GitBook

Build GitBook static site files and deploy to GitHub Pages

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Build and Publish GitBook

              
  uses: onejar99/gitbook-build-publish-action@v1.0.3
Learn more about this action in onejar99/gitbook-build-publish-action

Choose a version

GitHub Action for Gitbook Build and Publish

Introduction

The GitHub Action is used to build GitBook static site files and deploy to GitHub Pages via gh-pages branch.

How to Use

It's very easy to use it. Add a workflow like shown:

name: Build and Publish My GitBook

on:
  workflow_dispatch:
  push:
    branches:
      - master

jobs:
  build-and-deploy:
    name: Build and deploy
    runs-on: ubuntu-latest
    env:
      MY_SECRET   : ${{secrets.GH_ACCESS_TOKEN}}
      USER_NAME   : <Your Git username>
      USER_EMAIL  : <Your Git email>
      BOOK_DIR    : your_book_sources_folder_name

    steps:
    - name: Checkout 🛎️
      uses: actions/checkout@v2.3.1

    - name: Build and Deploy 🚀
      uses: onejar99/gitbook-build-publish-action@v1.0.3