Markdown Cheatsheet

Wikipedia

Markdown is a lightweight markup language for creating formatted text using a plain-text editor.

Introducing Markdown was published by John Gruber in 2004 as a markup language that is easier to read in its source code form. It is widely used for blogging, instant messaging, online forums, collaborative software, documentation pages, and readme files.

The initial description in Introducing Markdown contained ambiguities which were eventually addressed in 2014 by CommonMark, specification and test suite.

Frequently used

# Heading level 1
## Heading level 2

###### Heading level 6

Heading level 1
===============

Heading level 2
---------------

Text Emphasis: ***bold and italic*** then **bold** and finally *italic* text

> Block quote
>
> New paragraph in the block quote

> Block quote
>
>> Nested paragraph in the block quote

1. First item
2. Second item
    1. Indented first item
    2. Indented second item
3. Third item

- First item
- Second item
    - Indented first item
    - Indented second item
- Third item

My favorite search engine is [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy")
My favorite local page is [Favourites](./favourites.md "Only the very best")

<https://www.markdownguide.org>
<sjfke.pool.shark@gmail.com>

![Tux, the Linux mascot](/assets/images/tux.png)

```json
{
  "firstName": "Fred",
  "lastName": "Flintstone",
  "age": 30
}
```

Markdown Language

Basics

• Markdown-Guide is a free and open-source reference guide

• Markdown-Guide Cheat-Sheet a quick reference to the Markdown syntax

• Basic Syntax the Markdown elements outlined in the original design document.

• Extended Syntax advanced features that build on the basic Markdown syntax.

Syntax Highlighting

• Markdown Supported Languages a full list of supported languages

• Markdown Syntax highlighting for mdBook a command line tool

• Bitbucket - MarkdownDemo supported Bitbucket Markdown

Tables

• Markdown Tables Generator

• AnyWayData - Data Table Editor & Generator

Miscellaneous

• Markdown-Guide Hacks

• Mermaid charting tool that uses Markdown-inspired text definitions

• Create TOC

Editors and Linters

• Visual Studio Code, and the VS Code - Extension Marketplace

  • GitHub Markdown Preview

  • Markdown Preview GitHub Styling

  • markdownlint

• JetBrains Developer Tools, and the Jetbrains Markdown plugin

• Eclipse, and the Eclipse Markdown Text Editor

• MarkdownPad is a full-featured Markdown editor for Windows

• GitHub markdownlint

• MacOS Markdown Text Editors, and MacOS Markdown (brew)

Browser plugins such as

• Markdown Viewer , to configure watch the Setup Video

• Markdown Here