Skip to content

Deploy MDBook

Actions
Easily build and deploy your mdbook projects onto github pages
v1
Latest
Star (30)

📘 deploy-mdbook

The deploy-mdbook action allows you to easily build and deploy your mdBook project to GitHub Pages. See action.yml for configuration options.

Example

name: Deploy mdBook
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: XAMPPRocky/deploy-mdbook@v1.1
        with:
            token: ${{ secrets.GITHUB_TOKEN }}

Development

The action is written in NodeJS 12, and you can install the dependencies with:

npm install

Running

npm start

GitHub Actions requires all the dependencies to be committed, so before creating a commit you need to run:

npm run build

The command will bundle everything in dist/index.js. That file will need to be committed.

Deploy MDBook is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Easily build and deploy your mdbook projects onto github pages
v1
Latest

Deploy MDBook is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.