feat: Add `mdbook` action
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- ci-cd, documentation, tooling
Research direction
Review the existing sparse-checkout-aggregate and symlink-map actions, then inspect the docs aggregation workflow and its book.toml usage. Define the action entry point around the listed command and input behavior, including plugin installation and caching. Done means build, test, and serve work with the documented inputs and mdbook remains pre-installed.
Written by the indexing model from the issue text.
Description
Summary
Create a reusable GitHub Action to run mdbook commands with plugin support.
Use Case
Build and test mdbook documentation projects. Expects mdbook to be pre-installed but handles plugin installation.
Specification
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
command |
Yes | — | build, test, or serve |
book_dir |
No | . |
Directory containing book.toml |
plugins |
No | — | Comma-separated list of plugins to install |
dest_dir |
No | — | Override output directory |
Example Usage
- uses: arustydev/gha/mdbook@v1
with:
command: build
plugins: mermaid, toc, admonish
- uses: arustydev/gha/mdbook@v1
with:
command: test
Implementation Notes
Plugin Handling
- Plugins installed via
cargo install mdbook-{plugin} - Common plugins:
mermaid,toc,admonish,linkcheck,katex - Cache plugin binaries for faster subsequent runs
Pre-requisites
- Expects
mdbookbinary to be available in PATH - Expects
cargoto be available for plugin installation - Workflow should install mdbook before this action runs
Commands
# Build
mdbook build "$book_dir" --dest-dir "$dest_dir"
# Test
mdbook test "$book_dir"
# Serve (primarily for local dev, less useful in CI)
mdbook serve "$book_dir"
Related
- Part of docs aggregation workflow extraction
- Used after
sparse-checkout-aggregateandsymlink-mapactions
- Dominant language
- Shell
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aRustyDev/gh
-
dependencies github-actions
Difficulty 1/5 Under an hour Newbie friendliness 10/100
-
dependencies github-actions
Difficulty 1/5 Under an hour Newbie friendliness 15/100
-
dependencies github-actions
Difficulty 1/5 Under an hour Newbie friendliness 50/100
-
dependencies github-actions
Difficulty 2/5 1-3 hours Newbie friendliness 20/100
-
dependencies github-actions
Difficulty 2/5 1-3 hours Newbie friendliness 10/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
community-scripts/ProxmoxVE#17425 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·