DelineaXPM / delinea-platform

https://www.delinea.com
MIT License
12 stars 8 forks source link

docs: adjust markdown formatting #8

Closed sheldonhull closed 1 year ago

sheldonhull commented 1 year ago

Using a shell prefix isn't typical in markdown, so removed. Using a prefix breaks the ability to copy the command directly without issues. Fixed missing linebreak as well. To support the most typical rendering you normally have to have an empty line between the start of a code block. Some renders manage to handle it without, but not all.

FYI, the trunk config in other repos run auto-formatting to fix this with the markdownlint config file, which auto formats and alerts on any issue it can fix. Be glad to send that your way if useful. Otherwise, cheers!