No. Pre-built binaries are available for macOS, Linux, and Windows. Just run the install script.
guidebook update
By default, guidebook build outputs to _book/. You can change this with -o:
guidebook build -o dist
guidebook serve -p 3000
The search index is not regenerated on hot reload to improve performance. Restart guidebook serve to update the search index.
Yes, guidebook is a drop-in replacement. Just run guidebook build instead of npx honkit build.
No, guidebook uses built-in Rust implementations. Most common plugins (collapsible chapters, back-to-top, mermaid) are supported natively.
Not currently. guidebook focuses on web output.
Add the install directory to your PATH:
export PATH="$PATH:$HOME/.local/bin"
Add this line to your ~/.zshrc or ~/.bashrc.
Make sure you're running guidebook build in the directory containing SUMMARY.md.
Check that image paths are relative to the markdown file:
