> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usebruno.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Auto Generate Documentation

Bruno allows you to automatically generate a standalone HTML documentation file from your collection. This creates a shareable, interactive API documentation page that you can deploy anywhere or share with your team.

## Generate Documentation

1. Navigate to the Collection Settings and click on the **Generate Docs** under Documentation section

<img src="https://mintcdn.com/bruno-a6972042/bKrHa_JvyAqCslj1/images/screenshots/send-request/api-docs/opencollection/1-click-generate-docs.webp?fit=max&auto=format&n=bKrHa_JvyAqCslj1&q=85&s=b6afb1c7967207de503f402ed9531467" alt="Click Generate Docs" width="2610" height="1348" data-path="images/screenshots/send-request/api-docs/opencollection/1-click-generate-docs.webp" />

2. Select **Environment** to include in the documentation and click the **Generate** button to create the HTML documentation

<img src="https://mintcdn.com/bruno-a6972042/5Lfx5Y84o3IdcSG8/images/screenshots/v4/collection-docs/select-environment-export.webp?fit=max&auto=format&n=5Lfx5Y84o3IdcSG8&q=85&s=0f602cb12fcac18a583db802cbaadea4" alt="Click Generate Button" width="2604" height="1426" data-path="images/screenshots/v4/collection-docs/select-environment-export.webp" />

<Tip>
  **Optional:** You can set a collection version before generating docs. Collections without a version show "Not set".
</Tip>

3. Bruno will generate a documentation file for your collection in your file system with name `collection-name-documentation.html`

<img src="https://mintcdn.com/bruno-a6972042/5Lfx5Y84o3IdcSG8/images/screenshots/v4/collection-docs/interface-overview.webp?fit=max&auto=format&n=5Lfx5Y84o3IdcSG8&q=85&s=fa4873eeff7dbddb14d0d7c2ed5270ff" alt="Generated HTML Documentation" width="2618" height="1554" data-path="images/screenshots/v4/collection-docs/interface-overview.webp" />

## Key Features

### Environment Support

Use the topbar environment switcher to pick an active environment, and turn on **Show vars** to resolve `{{var}}` placeholders across URLs, headers, body, and code snippets.

* Resolves collection and global variables against the active environment
* Switch environments without reloading the page
* Secret variables stay masked even when Show variables is on
* Environment and toggle preferences persist for that docs file across refreshes

<img src="https://mintcdn.com/bruno-a6972042/5Lfx5Y84o3IdcSG8/images/screenshots/v4/collection-docs/environment-support.webp?fit=max&auto=format&n=5Lfx5Y84o3IdcSG8&q=85&s=3cd848f28f6249e9f16c9405825d81b0" alt="environment support" width="2562" height="1138" data-path="images/screenshots/v4/collection-docs/environment-support.webp" />

### Search Capability

Click the search bar in the header or press **`⌘K`** / **`Ctrl+K`** to open the search palette. Press **`Escape`** or the close button to dismiss it.

* **Searches across** request name, URL, params, and description
* **Results show** HTTP method badge, request name, folder breadcrumb, and resolved URL
* **Filter by method** using GET / POST / PUT / DEL chips
* **Filter by folder** to narrow results to a specific part of the collection
* **Clear all** resets both the query and all active filters
* Selecting a result navigates directly to that request's page

<img src="https://mintcdn.com/bruno-a6972042/5Lfx5Y84o3IdcSG8/images/screenshots/v4/collection-docs/search-panel.webp?fit=max&auto=format&n=5Lfx5Y84o3IdcSG8&q=85&s=143dff658c5ea60ce472e999e6ce655f" alt="Search Panel" width="2604" height="1318" data-path="images/screenshots/v4/collection-docs/search-panel.webp" />

### Interactive Playground

Click on **Try** button at request level to get interactive playground that allows users to:

* Edit request parameters, headers, and body
* Modify and test scripts in real-time
* Execute requests live directly from the documentation
* View responses immediately

<img src="https://mintcdn.com/bruno-a6972042/5Lfx5Y84o3IdcSG8/images/screenshots/v4/collection-docs/play-ground.webp?fit=max&auto=format&n=5Lfx5Y84o3IdcSG8&q=85&s=7c80d329378043adc9c3d1dd15c1fec8" alt="Try It Out Playground" width="2618" height="1318" data-path="images/screenshots/v4/collection-docs/play-ground.webp" />

### Code Samples

The documentation automatically generates code snippets for each request in multiple languages:

* cURL
* Python (requests)
* JavaScript

### Tests and Scripts Display

Interactive playground supports to:

* Show **pre and post request scripts** inline for each request
* Display **Params**, **Variables**, **Body**, **Headers**, **Auth** and test logic
* View **Tests and Assertions** directly in the documentation

## Deployment Options

Once generated, you can:

1. **Open locally**: View the HTML file in any browser
2. **Static hosting**: Deploy to GitHub Pages, Netlify, Vercel, or any static host
3. **Share directly**: Send the HTML file to team members or API consumers
4. **Documentation portal**: Add to your developer portal or docs site
