From 9c0dbd7c882e0175749eda490de12c99818d28c9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 3 Aug 2026 05:09:36 +0000 Subject: [PATCH] docs: note WYSIWYG docs editor and variable sort/DnD --- api-docs/overview.mdx | 9 +++++++++ api-docs/request-docs.mdx | 8 +++++++- variables/overview.mdx | 9 +++++++++ 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/api-docs/overview.mdx b/api-docs/overview.mdx index 4cb7daf0..bb4e1ef0 100644 --- a/api-docs/overview.mdx +++ b/api-docs/overview.mdx @@ -7,6 +7,15 @@ Bruno allows you to create API documentation at four distinct levels: **Workspac 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. +## Rich Text and Markdown Editing + +The Docs tab includes a WYSIWYG (rich text) editor built on top of Markdown. You can: + +- Format text visually using a toolbar (headings, bold, italic, lists, task lists, tables, links, images, code blocks, undo/redo). +- Toggle between **Rich Text** and **Markdown** modes at any time using the mode switch — content stays synchronized because Markdown remains the underlying source of truth. + +This lets non-technical teammates author documentation without writing raw Markdown, while power users can still edit Markdown directly. + 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. diff --git a/api-docs/request-docs.mdx b/api-docs/request-docs.mdx index 7da9402d..bf23bd7d 100644 --- a/api-docs/request-docs.mdx +++ b/api-docs/request-docs.mdx @@ -12,10 +12,16 @@ In Bruno, you can create Request-level documentation to provide specific details ![request-level-edit-docs](/images/screenshots/send-request/api-docs/req-docs-tab.webp) 2. Click the **Edit** button. -3. Enter your API details in the provided textarea. +3. Enter your API details in the editor. ![request-level-edit-docs](/images/screenshots/send-request/api-docs/request-level-edit-docs.webp) 4. Click the **Preview** button to see the formatted output. ![request-level-preview-docs](/images/screenshots/send-request/api-docs/request-level-preview-docs.webp) + +## Rich Text and Markdown Editing + +The request Docs editor supports both **Rich Text (WYSIWYG)** and **Markdown** modes. Use the mode switch in the toolbar to toggle between them at any time — content stays in sync because Markdown remains the underlying source of truth. + +In Rich Text mode you can use the toolbar to add headings, bold and italic text, lists, task lists, tables, links, images, and code blocks, and to undo or redo changes without writing raw Markdown. diff --git a/variables/overview.mdx b/variables/overview.mdx index 5ceb2b0e..25e9497e 100644 --- a/variables/overview.mdx +++ b/variables/overview.mdx @@ -151,6 +151,15 @@ In the Vars tab you can select the type of each variable using the type dropdown **Backward compatibility:** Existing `.bru` files and environments that use plain string values continue to work without any changes or migration. The `@type(...)` annotation is only written when a non-string type is used. +### Sorting and Reordering Variables + +You can control the order in which variables appear in the Vars tab across all scopes (collection, folder, request, and environment). + +- **Alphabetical sort:** Use the sort control in the Vars tab to sort variables **A–Z** or **Z–A**. Sort preference persists across sessions. +- **Drag-and-drop reordering:** In **Manual** mode, use the drag handle on each row to reorder variables. The saved order is written back to the underlying file after you save. + +Sorting and reordering preserve variable group boundaries (for example, secret and non-secret groups) and keep newly added rows in place. + ### Environment Color Coding