featured image

Markdown Cheat Sheet

A quick guide on using the Markdown syntax that is used throughout our site and documentation.

Tech by Design Tech by Design Mon Sep 23 2024 00:00:00 GMT+0000 (Coordinated Universal Time) 1 min read

Introduction

This blog post is adapted from the cheat sheet in Markdown Guide written by Matt Cone.

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

Extended Syntax

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

Table

SyntaxDescription
HeaderTitle
ParagraphText

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

Footnotes

  1. This is the footnote.

Prev
How to Get Help for 1115 Waiver Project