matter-labs/Deploy mdbook docs
GitHub Action to automatically build, test and deploy a versioned mdBook project to GitHub Pages.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Mar 27, 2026
- License
- Apache 2.0
Pinned Snippet
uses: matter-labs/deploy-mdbooks@c72ae3825faeb7d20cbf3e67714f7253dd0ee7cb # v1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | GitHub token for deployment. | yes | — |
| version | Version of the documentation to deploy | no | latest |
| docs-dir | Directory containing the mdbook documentation | no | docs |
| mdbook-version | Version of mdbook to use | no | latest |
| enable-tests | Disable mdbook tests | no | true |
| publish-branch | Branch to publish the documentation | no | gh-pages |
| project | Name of the project to deploy | no | "" |
| deploy | Enable or disable the deployment | no | true |
| create-latest-symlink | Create a symlink to the latest version | no | false |
| additional-paths | Additional source=destination mappings to copy into the publish branch | no | "" |
Outputs
no outputs