README in a Github repo

I really don’t understand the README section of GitHub and how does it look so perfect for some of the repo. Like, do they use HTML to edit the README section or just plain text or what!!!

Really confused.

They use Markdown.

I use Markdown files intensively every day.
The best solution to take code related notes IMHO.
You can use HTML too sometimes.

Some useful ones:

  • kbd : define keyboard shorcuts.
    • Ctrl+A
    • <kbd>Ctrl</kbd>+<kbd>A</kbd>
  • abbr : for abbreviations. Hovering displays a tooltip
    • GL
    • <abbr title="Good Luck">GL</abbr>


1 Like