Skip to content
play

GitHub Action

Setup mdBook

v1 Latest version

Setup mdBook

play

Setup mdBook

Install mdBook. Create a book from markdown files

Installation

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

              

- name: Setup mdBook

uses: extractions/setup-mdbook@v1

Learn more about this action in extractions/setup-mdbook

Choose a version

No longer maintained

Use setup-crate instead. For example:

- uses: extractions/setup-crate@v1
  with:
    owner: rust-lang
    name: mdBook

setup-mdbook action

build

This GitHub Action will install the latest release of mdBook for you.

Usage

Inputs

Name Required Description Type Default
mdbook-version no A valid NPM-style semver specification. string *

The semver specification is passed directly to NPM's semver package. This GitHub Action will install the latest matching release. Examples include

  • mdbook-version: '*' latest version (default).
  • mdbook-version: '0.4' equivalent to >=0.4.0 <0.5.0.
  • mdbook-version: '0.4.x' equivalent to >=0.4.0 <0.5.0.
  • mdbook-version: '0.4.6' equivalent to =0.4.6.
  • mdbook-version: '^0.4.6' equivalent to >=0.4.6 <0.5.0.

Basic example

Add the following to your workflow.

- uses: extractions/setup-mdbook@v1
  with:
    mdbook-version: 0.4
  env:
    # this is not required but add it if you get any rate limiting issues
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

License

Licensed under either of

at your option.