Skip to main content
Generate a standalone HTML documentation file from your collection in a few clicks.

​
Before you generate

A couple of minutes of prep decides what ends up in the file, so it is worth checking these first:
  • Write your docs. The generated site pulls descriptions from the markdown you have written at the collection, folder, and request levels. Requests with no docs still appear, they just lack any additional info.
  • Decide which environments readers need. You pick these in the generate modal. Anything you leave out is not embedded in the file.
  • Tag your requests if you plan to filter. Tag filtering is how you keep work in progress or internal endpoints out of published docs. If nothing is tagged yet, it is recommended to add them.
  • Set a collection version (optional). Collections without one show Not Set in the generate modal and in the generated site.
  • Whether to enable collaboration via Git. The option to include the repository URL only shows up for Git backed collections.

​
Generate Documentation

  1. Navigate to the Collection Settings and click on the Generate Docs under Documentation section
Click Generate Docs
  1. Under Environments to include, select the environments you want embedded in the documentation. Use Select All to include every one of them.
  2. Expand Advanced if you want to filter requests or remove the Git repository link.
Click Generate Button
  1. Click Generate. Bruno writes a documentation file for your collection to your file system, named collection-name-documentation.html
Generated HTML Documentation

​
Advanced options

The Advanced section holds two independent controls. You can use either one on its own, or both together.

​
Filter requests by tags

Requests to include starts on All requests. Switch it to Filter by Tags to publish a subset of the collection.
  • Include tags: only requests carrying a matching tag are published. For example, Production ready.
  • Exclude tags: requests carrying a matching tag are dropped. For example, Work in progress.
You can fill in one field or both. If a request matches an include tag and an exclude tag at the same time, the exclusion wins and the request is left out. Filtered requests are genuinely absent from the generated file, not hidden in the page. They do not appear in the navigation, in search results, or in the collection data embedded in the HTML, so a reader cannot dig them out of the source.
Because the filters are set per run, you can publish more than one variant from the same collection. Generate once with Production ready for the public file, then generate again with no filters for the internal copy.
Tags live in the collection files (on requests and on folders), so they travel with the collection through Git and stay consistent with the tag filters used by the collection runner.

​
Include Git repo URL

For Git backed collections, Bruno embeds the repository URL by default so readers can clone the collection through Open in Bruno. Turn the toggle off if you would rather not ship a repository URL, which matters most when the repo is private and the documentation is published somewhere public.

​
Generate from the CLI

You can produce the same file from the command line, which is the better option when documentation lives in Git or gets published by a pipeline:
The CLI and the app share one implementation, so the same collection and the same options give you the same documentation. See bru docs for the workflow and bru docs options for every flag.

​
Next steps