docs/INSTALLATION.md
This guide explains how to set up and build the Wazuh technical documentation locally.
The following specific versions are required for compatibility with the global documentation build system:
| Tool | Required Version |
|---|---|
mdbook | 0.5.2 |
mdbook-mermaid | 0.17.0 |
# Install mdbook 0.5.2
cargo install mdbook --version 0.5.2
# Install mdbook-mermaid 0.17.0
cargo install mdbook-mermaid --version 0.17.0
Download the appropriate binaries for your platform:
After installation, verify the versions:
mdbook --version
# Expected output: mdbook v0.5.2
mdbook-mermaid --version
# Expected output: mdbook-mermaid 0.17.0
To serve the documentation locally with live reload:
cd docs
mdbook serve
The documentation will be available at http://127.0.0.1:3000
To build the documentation as static HTML:
cd docs
mdbook build
The output will be generated in the docs/book directory.
If you encounter build errors, ensure you have the exact versions specified above:
# Check your installed versions
mdbook --version
mdbook-mermaid --version
If Mermaid diagrams are not rendering:
mdbook-mermaid is installed correctlymermaid.min.js and mermaid-init.js are present in the docs/js/ directorybook.toml preprocessor configuration is correctIf you encounter parse errors in book.toml, ensure:
multilingual = false are present