{"repo":"peaceiris/actions-mdbook","free":true,"listed":false,"github":"https://github.com/peaceiris/actions-mdbook","clone":"git clone https://github.com/peaceiris/actions-mdbook.git","description":"GitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.","language":"TypeScript","stars":329,"topics":["mdbook","rust","actions","github-actions"],"license":"MIT","category":"workflow-automation","readme_excerpt":"GitHub Actions for mdBook [rust-lang/mdBook] Setup Action. [rust-lang/mdBook]: https://github.com/rust-lang/mdBook We can run mdBook on a virtual machine of GitHub Actions by this mdBook action. Linux, macOS, and Windows are supported. OS (runs-on) ubuntu-20.04, ubuntu-22.04 macos-latest windows-2019 --- :---: :---: :---: Support ✅️ ✅️ ✅️ Table of Contents - Getting Started - ⭐️ Create your workflow - Options - ⭐️ Use the latest version of mdBook - Tips - ⭐️ Read mdBook version from file - CHANGELOG - License - About Maintainer - Maintainer Notes Getting Started ⭐️ Create your workflow An example workflow .github/workflows/gh-pages.yml with [GitHub Actions for GitHub Pages]. For the first deployment, we have to do this operation: First Deployment with GITHUB TOKEN - peaceiris/actions-gh-pages [GitHub Actions for GitHub Pages]: https://github.com/peaceiris/actions-gh-pages Back to TOC ☝️ Options ⭐️ Use the latest version of mdBook Set mdbook-version: 'latest' to use the latest version of mdBook. This action fetches the latest version of mdBook by mdbook — Homebrew Formulae Back to TOC ☝️ Tips ⭐️ Read mdBook version from file How to sync a mdBook version between a Docker Compose and a GitHub Actions workflow via .env file. Write a MDBOOK VERSION to the .env file like the following and push it to a remote branch. Next, add a step to read a mdBook version from the .env file. Here is a docker-compose.yml example. The alpine base mdBook Docker image is provided on the following rep","default_branch":null,"files":null,"tree":[],"storefront":"/r/peaceiris","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/peaceiris/actions-mdbook/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}