Skip to content

Instantly share code, notes, and snippets.

@shreewatsa
Created July 15, 2023 09:59
Show Gist options
  • Save shreewatsa/b9d477570b2803d36442dbbbe64f92cd to your computer and use it in GitHub Desktop.
Save shreewatsa/b9d477570b2803d36442dbbbe64f92cd to your computer and use it in GitHub Desktop.
Markdown Cheatsheet

Markdown Cheat Sheet

Reference The Markdown Guide.

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.

Basic Syntax

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Heading

H1

H2

H3

Bold

bold text

Italic

italicized text

Blockquote

blockquote

Ordered List

  1. First item
  2. Second item
  3. Third item

Unordered List

  • First item
  • Second item
  • Third item

Code

code

Horizontal Rule


Link

Markdown Guide

Image

alt text

Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table

Syntax Description
Header Title
Paragraph Text

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Footnote

Here's a sentence with a footnote. 1

Heading ID

My Great Heading {#custom-id}

Definition List

term : definition

Strikethrough

The world is flat.

Task List

  • Write the press release
  • Update the website
  • Contact the media

Emoji

That is so funny! 😂

(See also Copying and Pasting Emoji)

Highlight

I need to highlight these ==very important words==.

Subscript

H2O

Superscript

X^2^

Footnotes

  1. This is the footnote.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment