search

usebruno / bruno

Opensource IDE For Exploring and Testing Api's (lightweight alternative to postman/insomnia)
https://www.usebruno.com/
MIT License
26.76k stars 1.23k forks source link

collection docs as markdown #2861

Open MazrimT opened 2 months ago

MazrimT commented 2 months ago

I have checked the following:

Describe the feature you want to add

Today the "docs" part of a collection is just text stored in collection.bru file. It would be amazing if instead it was propper markdown and stored separately to a README.md file instead.

This would allow for easier better/easier documentation and editing in external tools.

calling it README.md would also allow automatically to show up if browsing it in some git-website gui.

Mockups or Images of the feature

image

ohbus commented 2 months ago

I would love to see this feature for sure!

jd-santos commented 1 month ago

This is the only link or reference I can find to this Docs feature, including within Bruno's own docs. I'm disappointed to learn it only holds text, I was hoping for something more like OP's suggestion. At the very least, we could maybe use a snippet in the docs to explain what this feature currently does.