Use markdown on GitHub

Markdown for GitHub is the language of choice when creating issues, pull requests, using discussions, or editing your README file on GitHub.

You can even create markdown files (they have an .md extension) anywhere in your repo and GitHub will render them as readable, just like your README.md file

It is simple to use, human readable, and will take you about an hour or two to learn. Using it will enhance the look of your comments/discussions and people will appreciate it. So why not spend an hour to read up on markdown

You can also add code blocks in the form of reproducible examples in any of the above mentioned formats

Some additional resources

• Markdown cheat sheet
• GitHub flavored markdown