{"id":13753949,"url":"https://github.com/jontze/action-mdbook","last_synced_at":"2025-08-10T14:07:12.622Z","repository":{"id":36972510,"uuid":"378727032","full_name":"jontze/action-mdbook","owner":"jontze","description":"A GitHub Action that installs mdBook on a GitHub Runner and supports various plugins like linkcheck, mermaid, toc, open-on-gh, admonish, and katex for enhanced functionality.","archived":false,"fork":false,"pushed_at":"2025-05-06T06:18:25.000Z","size":3606,"stargazers_count":16,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-06T07:38:15.322Z","etag":null,"topics":["action","github-actions","marketplace","mdbook","mdbook-admonish","mdbook-katex","mdbook-linkcheck","mdbook-mermaid","mdbook-open-on-gh","mdbook-plugin","mdbook-plugins","mdbook-preprocessor","mdbook-toc","mermaid"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/mdbook-action-with-plugins","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jontze.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-06-20T19:43:30.000Z","updated_at":"2025-05-06T06:18:22.000Z","dependencies_parsed_at":"2023-02-19T05:46:15.668Z","dependency_job_id":"3f7cb73e-a98a-4e60-a5a2-0559a8bc56d6","html_url":"https://github.com/jontze/action-mdbook","commit_stats":{"total_commits":410,"total_committers":5,"mean_commits":82.0,"dds":0.2902439024390244,"last_synced_commit":"58e15d7dd06a321990bd1cccaa468810daecfbe3"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jontze%2Faction-mdbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jontze%2Faction-mdbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jontze%2Faction-mdbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jontze%2Faction-mdbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jontze","download_url":"https://codeload.github.com/jontze/action-mdbook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254030885,"owners_count":22002666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","github-actions","marketplace","mdbook","mdbook-admonish","mdbook-katex","mdbook-linkcheck","mdbook-mermaid","mdbook-open-on-gh","mdbook-plugin","mdbook-plugins","mdbook-preprocessor","mdbook-toc","mermaid"],"created_at":"2024-08-03T09:01:35.509Z","updated_at":"2025-05-13T21:30:58.261Z","avatar_url":"https://github.com/jontze.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","others"],"sub_categories":[],"readme":"# MdBook Github Action with Plugin Support\n\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_action-mdbook\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=UsingPython_action-mdbook) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_action-mdbook\u0026metric=security_rating)](https://sonarcloud.io/summary/new_code?id=UsingPython_action-mdbook) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_action-mdbook\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=UsingPython_action-mdbook) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_action-mdbook\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=UsingPython_action-mdbook)\n[![GitHub license](https://img.shields.io/github/license/jontze/action-mdbook)](https://github.com/jontze/action-mdbook/blob/master/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/jontze/action-mdbook)](https://github.com/jontze/action-mdbook/issues)\n\n## Introduction\n\nThis is an GitHub Action to set up the [rust-lang/mdBook](https://github.com/rust-lang/mdBook) with some [supported plugins](#supported-plugins).\n\nThis action runs only on linux and is well tested on GitHubs **latest ubuntu** runner and **compatible with Node v18 and v20**. Windows and MacOS are not supported.\n\n## Supported Plugins\n\n- [Michael-F-Bryan/mdbook-linkcheck](https://github.com/Michael-F-Bryan/mdbook-linkcheck)\n- [badboy/mdbook-mermaid](https://github.com/badboy/mdbook-mermaid)\n- [badboy/mdbook-toc](https://github.com/badboy/mdbook-toc)\n- [badboy/mdbook-open-on-gh](https://github.com/badboy/mdbook-open-on-gh)\n- [tommilligan/mdbook-admonish](https://github.com/tommilligan/mdbook-admonish)\n- [lzanini/mdbook-katex](https://github.com/lzanini/mdbook-katex)\n\n## Fast Setup\n\nThe following example installs mdbook with all currently supported plugins with the **latest version**. Keep in mind that this build **could break** if mdbook or one of the plugins release **new versions with breaking changes**. Therefore it is highly recommended to specify a version. See [\"Advanced Setup\"](#advanced-setup) for more information.\n\n```yaml\nname: Setup mdBook with plugins (latest)\non:\n  push:\n    branches:\n      - main\njobs:\n  run:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: jontze/action-mdbook@v3\n        with:\n          token: ${{secrets.GITHUB_TOKEN}}\n          # Optional Plugins have to be enabled\n          use-linkcheck: true\n          use-mermaid: true\n          use-toc: true\n          use-opengh: true\n          use-admonish: true\n          use-katex: true\n      - name: Show mdbook version\n        run: mdbook --version\n      - name: Show linkchecker version\n        run: mdbook-linkcheck --version\n      - name: Show mermaid version\n        run: mdbook-mermaid --version\n      - name: Show toc version\n        run: mdbook-toc --version\n      - name: Show open-on-gh version\n        run: mdbook-open-on-gh --version\n      - name: Show admonish version\n        run: mdbook-admonish --version\n      - name: Show katex version\n        run: mdbook-katex --version\n```\n\n## Advanced Setup\n\n```yaml\nname: Setup mdBook wth plugins (version)\non:\n  push:\n    branches:\n      - main\njobs:\n  run:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n      - uses: jontze/action-mdbook@v3\n        with:\n          token: ${{secrets.GITHUB_TOKEN}}\n          # Optional Plugins have to be enabled with a version\n          mdbook-version: \"~0.3.0\" # Use a semver compatible string\n          use-linkcheck: true\n          linkcheck-version: \"~0.7.0\"\n          use-mermaid: true\n          mermaid-version: \"~0.8.0\"\n          use-toc: true\n          toc-version: \"~0.7.0\"\n          use-opengh: true\n          opengh-version: \"~2.0.0\"\n          use-admonish: true\n          admonish-version: \"~1.8.0\"\n          use-katex: true\n          katex-version: \"~0.2.17\"\n      - name: Show mdbook version\n        run: mdbook --version\n      - name: Show linkchecker version\n        run: mdbook-linkcheck --version\n      - name: Show mermaid version\n        run: mdbook-mermaid --version\n      - name: Show toc version\n        run: mdbook-toc --version\n      - name: Show open-on-gh version\n        run: mdbook-open-on-gh --version\n      - name: Show admonish version\n        run: mdbook-admonish --version\n      - name: Show katex version\n        run: mdbook-katex --version\n```\n\n## Contributions\n\nContributions are welcomed. Please take a look at the [Pull Request Template](.github/pull_request_template.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjontze%2Faction-mdbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjontze%2Faction-mdbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjontze%2Faction-mdbook/lists"}