Skip to content

Instantly share code, notes, and snippets.

@Raikir-i-sh
Last active January 18, 2022 03:03
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Raikir-i-sh/d469d927a524dd07c3d7675970717277 to your computer and use it in GitHub Desktop.
Save Raikir-i-sh/d469d927a524dd07c3d7675970717277 to your computer and use it in GitHub Desktop.
[Markdown Cheat Sheet] #cheatsheet

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

The 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
}

A collapsible section with markdown

But doesn't work in Lepton tho.

Click to expand!

Inside the section

Two important rules:

  • Make sure you have an empty line after the closing tag, otherwise the markdown/code blocks won't show correctly.
  • Make sure you have an empty line after the closing tag if you have multiple collapsible sections.

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

Footnotes

  1. This is the footnote.

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