Skip to main content
Bruno has two distinct documentation features, and it helps to know which one you’re looking for:

Write Docs in Bruno

Author markdown documentation alongside your requests — at the workspace, collection, folder, and request level — rendered inside the Bruno app.

Generate HTML Docs

Have Bruno build a standalone, interactive HTML documentation site from a collection — with a live playground, search, and code samples — that you can deploy anywhere.
Writing docs is an authoring feature: you write the content yourself in markdown, and it lives with your collection for anyone working in Bruno to read. Generating docs is a publishing feature: Bruno produces a shareable HTML file from what’s already in your collection, for consumers of your API who may never open Bruno at all.
The two features connect in one direction: the markdown docs you write at each level are included in the generated HTML site as the descriptions for your collection, folders, and requests. Write once in Bruno, publish everywhere.

​
Write Docs in Bruno

Bruno allows you to create API documentation at four distinct levels: Workspace, Collection, Folder, and Request. With full Markdown support you can write clear, concise, and well-structured documentation at each level supplemented with any relevant screenshots, gifs, or other elements to ensure your users have a seamless onboarding experience.
  1. Document a workspace
  2. Document a collection
  3. Document a folder
  4. Document a request
Bruno sanitizes all HTML in documentation blocks before rendering. This prevents cross-site scripting (XSS) attacks when previewing markdown that contains embedded HTML. Elements like script tags and inline event handlers are automatically removed.

​
Generate HTML Docs

Bruno can automatically generate a standalone HTML documentation file for your entire collection — an interactive site with an environment switcher, full-text search, a try-it playground, and auto-generated code samples. Learn about generated HTML docs