Skip to content

Markdown Cheat Sheet

Thanks for visiting 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

Markdown Guide

Image

alt text

You can use table for this. It works fine.

space-1.jpg
Space

Smiley face

Videos

Embedded videos won’t natively render in Markdown, but you can use this Markdown extension.

Vidéo Arte

https://m.youtube.com/watch?v=U-t4l89ekgI https://www.youtube.com/embed/U-t4l89ekgI

https://m.youtube.com/watch?v=R8VhnEtPDeE https://www.youtube.com/embed/R8VhnEtPDeE

Autre vidéo

https://github.com/Snailedlt/Markdown-Videos

Headers break on their own

Note that headers don't need line continuation characters as they are block elements and automatically break. Only text lines require the double spaces for single line breaks. Headers break on their own

Emojis

Sometimes you want to 🐒 around a bit and add some 🌟 to your 💬. Well we have a gift for you:

⚡ You can use emoji anywhere GitLab Flavored Markdown is supported. ✌

You can use it to point out a 🐛 or warn about 🙊 patches. And if someone improves your really 🐌 code, send them some 🎂. People ❤ you for that.

If you're new to this, don't be 😨. You can join the emoji 👪. Just look up one of the supported codes.

Consult the Emoji Cheat Sheet for a list of all supported emoji codes. 👍

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]

[^1]: This is the footnote.

Heading ID

My Great Heading

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

X2

Note blocks

You can choose from these types of note blocks to draw attention to specific content:

[!NOTE] [!TIP] [!IMPORTANT] [!CAUTION] [!WARNING] [!ADMINISTRATION] [!AVAILABILITY] [!PREREQUISITES] [!ERROR] [!ADMINISTRATION] [!INFO] [!SUCCESS]

In general, note blocks should be used sparingly because they can be disruptive. Although they also support code blocks, images, lists, and links, try to keep your note blocks simple and straightforward.

[!NOTE]

This is a standard NOTE block. [!TIP]

This is a standard TIP. [!IMPORTANT]

This is an IMPORTANT note.