Initial commit of mdbook #5
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Run mdbook on deploy | |
on: | |
pull_request: | |
branches: ["main"] | |
push: | |
branches: | |
- main | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: jontze/action-mdbook@v3 | |
with: | |
token: ${{secrets.GITHUB_TOKEN}} | |
# Optional Plugins have to be enabled | |
use-linkcheck: true | |
use-mermaid: false | |
use-toc: true | |
use-opengh: true | |
use-admonish: true | |
use-katex: false | |
- name: Show mdbook version | |
run: mdbook --version | |
- name: Show linkchecker version | |
run: mdbook-linkcheck --version | |
# - name: Show mermaid version | |
# run: mdbook-mermaid --version | |
- name: Show toc version | |
run: mdbook-toc --version | |
- name: Show open-on-gh version | |
run: mdbook-open-on-gh --version | |
- name: Show admonish version | |
run: mdbook-admonish --version | |
- name: Deploy GitHub Pages | |
run: | | |
# This assumes your book is in the root of your repository. | |
# Just add a `cd` here if you need to change to another directory. | |
cd docs | |
mdbook build | |
git worktree add gh-pages | |
git config user.name "Deploy from CI" | |
git config user.email "" | |
cd gh-pages | |
# Delete the ref to avoid keeping history. | |
git update-ref -d refs/heads/gh-pages | |
rm -rf * | |
mv ../book/* . | |
git add . | |
git commit -m "Deploy $GITHUB_SHA to gh-pages" | |
git push --force --set-upstream origin gh-pages |