bruno-to-html
v0.1.3
Published
Generate static HTML documentation from a Bruno collection directory
Maintainers
Readme
bruno-to-html
An independent Node.js CLI package that converts a Bruno collection directory into a static HTML documentation site.
Installation
npm install -g bruno-to-htmlUsage
bruno-to-html ./bruno ./docThis command writes the generated documentation to ./doc/index.html.
Features
- Independent implementation with no dependency on Bruno project source code
- Supports both Bruno collection roots (
bruno.json) and OpenCollection roots (opencollection.yml) - Reads
bruno.json,collection.bru,folder.bru, request.bru, andopencollection.ymldirectly - Generates a single HTML file that loads OpenCollection docs assets from the CDN
- Supports collection docs, folder docs, request docs, headers, params, auth, body, tests, and scripts
Scope
This package is designed for documentation generation first. It is not a full Bruno parser yet, so very advanced .bru syntax may require additional support later.
