Skip to content

fix(docs): matches Bruno app's markdown rendering (BRU-4228) - #85

Merged
arpit-bruno merged 5 commits into
usebruno:release/v0.4.0from
adwait-bruno:fix/collection-docs-markdown-parity
Sep 28, 2026
Merged

arpit-bruno merged 5 commits into
usebruno:release/v0.4.0from
adwait-bruno:fix/collection-docs-markdown-parity

Conversation

@adwait-bruno

@adwait-bruno adwait-bruno commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Jira: BRU-4228

Docs written in Bruno app don't look the same in Api docs.

  • Headings all render at the same size, so the structure is lost
  • Line breaks show up as the text <br/>
  • Checkboxes render as [ ] and [x] instead of actual boxes
  • Code blocks have the wrong background and no way to copy them
  • Code colours don't match the app

What this fixes

  • Each heading level now has its own size, same as the app
  • Line breaks actually break the line
  • Checkboxes render as real boxes, ticked where you ticked them
  • Code blocks use the app's background and have a Copy button
  • Code colours match ,markdown now uses highlight.js like the app does, instead of Prism

Screenshots

Before After
Bruno app

@changeset-bot

changeset-bot Bot commented Sep 19, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: f4f7cbf

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@usebruno/api-docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Comment thread packages/bruno-api-docs/src/styles/index.css Outdated
Comment thread packages/bruno-api-docs/src/hooks/useMarkdownRenderer.ts Outdated
Comment thread packages/bruno-api-docs/src/hooks/useMarkdownRenderer.ts Outdated
Comment thread packages/bruno-api-docs/src/hooks/useMarkdownRenderer.ts
Comment thread packages/bruno-api-docs/src/styles/index.css
Comment thread packages/bruno-api-docs/src/hooks/useMarkdownRenderer.ts Outdated
Comment thread packages/bruno-api-docs/src/hooks/useMarkdownRenderer.ts Outdated
Comment thread packages/bruno-api-docs/src/hooks/useMarkdownRenderer.ts Outdated
@sachin-bruno

sachin-bruno commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

html: false is the right call for untrusted docs on a public page, but the app recognises twelve inline tags via DOMPurify.

We only handle <br>, so <kbd>Ctrl</kbd> renders formatted in Bruno and as escaped text here.

Can we decide now whether to close that gap with a DOMPurify allowlist?

@adwait-bruno

Copy link
Copy Markdown
Contributor Author

html: false is the right call for untrusted docs on a public page, but the app recognises twelve inline tags via DOMPurify. We only handle , so Ctrl renders formatted in Bruno and as escaped text here. Can we decide now whether to close that gap with a DOMPurify allowlist?

html: false was already there before this change and has a documented reason behind it.Can be taken up in a different ticket as this ticket is related to mostly ui fixes. kbd and sup are the only two of the twelve that the editor actually writes to the file as raw HTML. The rest (bold, italic, strikethrough, inline code, links) serialize as markdown, so anything authored with the toolbar already renders fine here.

arpit-bruno and others added 2 commits September 28, 2026 13:17
Fixes the documentation to match the markdown rendering of the Bruno app.
@arpit-bruno
arpit-bruno merged commit e7b1beb into usebruno:release/v0.4.0 Sep 28, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants