usebruno
collection docs as markdown
I have checked the following:
- [X] I've searched existing issues and found nothing related to my issue.
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
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.
Hi All - I know this ticket has been open for quite some time, but Bruno does support markdown in documentation, and stores it as such in your collection.bru file. Additionally, we do pull in a .readme, but in our GitUI component.
I know this doesn't solve your exact ask, but wanted to provide additional context here.
+1 Another great feature to be considered, is the ability to create link between Collections/Requests (allowing UI navigation), in my case i have a bunch of default possible query params for any routes, by having this link ability, the docs are more organized and easy navigable between topics.
It would be great if you could reference a separate .md file to have it appear in the Bruno app - vs cloning it into collection.bru.
Right now we've got both docs in collection.bru and README.md so you can view documentation from both IDE & Bruno formatted.
@rreyn-bruno I saw your comment about it being markdown already. I apologize I made the original message implying it was not, I meant that it was not in a .md file. Have updated the original message.
I'd also like to see this feature. Given one goal of this project is to be human-readable/editable, adopting some familiar conventions would be nice.
I came here to open a similar issue but found this one already exists.
