name: mdbook
binary: mdbook
aliases: []
category:
- docs
lang:
- markdown
summary: Build books and documentation sites from Markdown.
homepage: https://github.com/rust-lang/mdBook
docs: https://rust-lang.github.io/mdBook/
detect:
version_args:
- --version
local:
files:
- book.toml
dirs: []
package_json:
package_manager_prefixes: []
use_when:
- Build or serve mdBook documentation
avoid_when:
- The documentation site uses another generator
risk:
level: medium
effects:
- execute_code
- write_files
requires_auth: false
destructive: false
confirmation_required_for:
- publishing generated docs
guardrails:
- Check book.toml before generating or publishing docs.