Bruno Docs 📝

The official Bruno Documentation repository, built with Mintlify.

Contributing

Note

Ensure that Node.js (version 19 or higher) is installed before proceeding.

1. Clone the repository.

git clone https://github.com/usebruno/bruno-docs.git
cd bruno-docs

2. Install Mintlify CLI globally (if not already installed)

npm install -g mint

3. Start development server

mint dev

This will start a local server, and you can view the site by visiting http://localhost:3000 in your browser.

Project Structure

• docs.json - Mintlify configuration file (navigation, versions, theme settings)
• *.mdx - Documentation pages written in MDX format
• images/ - Screenshots and assets used in documentation
• snippets/ - Custom React components used in documentation

Documentation Format

• Documentation pages use .mdx format (Markdown with JSX)
• Custom components are available in the snippets/ directory
• Images should be placed in images/screenshots/ with appropriate subdirectories
• Use Mintlify components like <Info>, <Warning>, <Tip>, <Tabs>, etc.

Learn more about Mintlify