points icon indicating copy to clipboard operation
points copied to clipboard

Show markdown reference for the description block

Open arielj opened this issue 4 years ago • 0 comments

https://ombulabs.atlassian.net/browse/DT-264

Branch/Commit:

Main branch.

Describe the feature:

As a <role name> I want to see a quick reference of some markdown syntax So I don't have to look for that in other places

I imagine a small (?) element next to the description that, on hover, shows a quick cheat-sheet of the basic for formatting and code blocks.

Problem:

Currently, if you need some syntax reference, you have to google for it or remember it. Also, for example, 4-space indentation looks better than tripple backtick for code blocks, maybe we can suggest to use the former instead in that cheat-sheet.

Resources:

Here in github, we have this legend below the description block, clicking it takes you to a documentation page, we could also do that, linking to this same documtation maybe if we don't want a custom cheat-sheet.

image

I will abide by the code of conduct

arielj avatar Oct 07 '21 19:10 arielj