The Ultimate Markdown Cheat Sheet

Write an awesome README

Photo by Christopher Gower on Unsplash

What is Markdown? Markdown is a way of writing rich-text (formatted text) content using plain text formatting syntax. It is also a tool that converts the plain text formatting to HTML. In 2004, John Gruber developed Markdown.

From this post, you’ll learn all of Markdown’s major commands that will help you create an awesome GitHub README. I’ll talk about the 14 most commonly used markdown topics. I’ve also mentioned different ways, such as using HTML tags to style your README. If you’re interested, you can have a look at the HTML whitelists on GitHub.

You can download everything I’ve discussed in this post from my GitHub repository. Below, I have a table of contents so that you can easily navigate this post.

· Headings
· Text styles
· Syntax Highlighting
· Alignments
· Tables
· Links
∘ Inline:
∘ Reference:
∘ Footnote:
∘ Relative:
∘ Auto:
∘ Section:
∘ Hover:
· Enclosed
· Highlight words and link it to a URL
· Images
∘ Theme
· Badges
· Lists
· Buttons (6 January 2023)
· Collapsible items (28 July 2023)
· Horizontal Rule
· Diagrams (19 July 2022)
· Mathematical expressions (19 July 2022)
· Alerts (8 January 2024)
· Mention people and teams
· Reference issues and pull requests
· Color models (17 February 2024)
· View Code (13 May 2024)
· Code in titles
· Reference…