https://github.com/onejar99/gitbook-build-publish-action

A GitHub Action to build and publish GitBook.
https://github.com/onejar99/gitbook-build-publish-action

Last synced: about 2 months ago
JSON representation

A GitHub Action to build and publish GitBook.

• Host: GitHub
• URL: https://github.com/onejar99/gitbook-build-publish-action
• Owner: onejar99
• Created: 2020-08-22T17:09:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-03T15:03:32.000Z (over 1 year ago)
• Last Synced: 2024-04-24T21:01:50.272Z (9 months ago)
• Language: Shell
• Size: 8.79 KB
• Stars: 17
• Watchers: 1
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• jimsghstars - onejar99/gitbook-build-publish-action - A GitHub Action to build and publish GitBook. (Shell)

README

        
# 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:

```yaml

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   : 

      USER_EMAIL  : 

      BOOK_DIR    : your_book_sources_folder_name

    steps:

    - name: Checkout 🛎️

      uses: actions/[email protected]

    - name: Build and Deploy 🚀

      uses: onejar99/[email protected]

```