A Markdown reference is a structured collection of Markdown syntax and formatting rules that you can quickly consult while writing. Instead of learning Markdown from start to finish, a reference lets you jump directly to the element you need, whether that's a heading, table, link, image, or code block.

Unlike a beginner's tutorial, a reference is designed for quick lookups. It focuses on showing the correct syntax, explaining its purpose, and helping you find more detailed documentation when needed.

On MDConvertHub, this reference combines core Markdown syntax with commonly used extensions, making it useful for developers, technical writers, students, and anyone who regularly works with Markdown.

This guide is organised into logical sections so you can quickly find the syntax you're looking for.

Core Markdown#

The foundation of Markdown used across most editors and platforms: headings, paragraphs, lists, links, images, blockquotes, code blocks, horizontal rules, and line breaks.

Extended Markdown#

Features supported by many modern Markdown implementations: tables, task lists, footnotes, emojis, inline HTML, escaping characters, and mathematical expressions.

Platform-Specific Features#

Some Markdown applications extend the standard syntax with additional capabilities, including GitHub Flavored Markdown (GFM), Obsidian Markdown, and Mermaid diagrams.

Where a feature depends on a specific platform or parser, we'll clearly identify it so you know when it can be used.

You don't need to read this page from top to bottom. Instead:

1. Find the Markdown element you want to use.
2. Copy the syntax if you already know how it works.
3. Read the short explanation if you need a quick reminder.
4. Follow the linked guide for detailed examples, best practices, and common mistakes.

This approach keeps the reference fast to navigate while giving you access to in-depth documentation whenever you need it.

Headings organise your document into logical sections, making it easier to read and navigate. Create them with one to six # characters.

Syntax#

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Live Preview#

Best for documentation, READMEs, articles, and notes.

Learn More → Markdown Headings

Paragraphs are created by separating blocks of text with a blank line. Keep paragraphs concise and focused on a single idea to improve readability.

Syntax#

This is the first paragraph.

This is the second paragraph.

Live Preview#

Learn More → Markdown Paragraphs

Markdown supports simple formatting for emphasising important content. Use emphasis sparingly so important information stands out.

Live Preview#

Strikethrough requires GitHub Flavored Markdown (GFM) or another extended implementation.

Learn More → Markdown Syntax — Text Formatting

Lists make information easier to scan and are widely used in documentation and technical writing.

Unordered List#

- Apple
- Orange
- Banana

Ordered List#

1. Install
2. Configure
3. Deploy

Nested List#

- Frontend
  - React
  - Vue
- Backend
  - Node.js
  - Go

Live Preview#

Best for feature lists, step-by-step instructions, documentation, and checklists.

Learn More → Markdown Lists

Links connect your Markdown document to websites, files, or other resources. Use descriptive link text instead of generic phrases such as "click here."

Syntax#

[MDConvertHub](https://mdconverthub.com)

Live Preview#

Learn More → Markdown Links

Try Tool → Markdown Link Generator

Images help explain concepts visually and improve documentation. Always provide meaningful alternative text to improve accessibility.

Syntax#

![Project Screenshot](screenshot.png)

Learn More → Markdown Images

Code blocks preserve formatting and support syntax highlighting in many Markdown editors. Specify the language whenever possible for better readability.

Syntax#

```javascript
function greet() {
  console.log("Hello, Markdown!");
}
```

Live Preview#

function greet() {
  console.log("Hello, Markdown!");
}

Learn More → Markdown Code Blocks

Try Tool → Markdown Editor

Blockquotes highlight quotations, notes, warnings, or important information. They're commonly used in documentation, tutorials, and knowledge bases.

Syntax#

> Markdown makes documentation easier to write and maintain.

Live Preview#

Learn More → Markdown Blockquotes

Horizontal rules create a clear visual separation between major sections. Use them to divide long documents without adding unnecessary headings.

Syntax#

---

Live Preview#

Learn More → Markdown Horizontal Rules

A line break starts a new line without creating a new paragraph. Support for HTML tags depends on the Markdown implementation being used.

Syntax#

First line.  
Second line.

Alternatively, many Markdown implementations also support:

First line.<br>
Second line.

Learn More → Markdown Line Breaks

Many modern Markdown editors support features beyond the original Markdown syntax. These extensions make it easier to create rich documentation, technical content, and project management files without writing HTML.

While these features are widely supported, they may not work in every Markdown parser. If you're sharing documents across multiple platforms, always verify which extensions are supported.

Note: Support for extended syntax depends on the Markdown parser or platform. GitHub, Obsidian, and documentation tools may support different features.

Tables organise structured information into rows and columns, making comparisons and datasets easier to read.

Syntax#

| Name | Role | Experience |
|------|------|-----------|
| Sarah | Developer | 5 Years |
| James | Designer | 3 Years |

Live Preview#

Best for feature comparisons, product documentation, API references, pricing tables, and reports. Keep column headings concise, align similar data types together, and avoid overly wide tables on small screens.

Learn More → Markdown Tables

Try Tool → Markdown Table Generator

Task lists display interactive checkboxes in supported Markdown applications. They're especially useful for tracking progress during development or planning documentation.

Syntax#

- [x] Create project
- [x] Write documentation
- [ ] Publish website

Live Preview#

Best for project planning, issue tracking, TODO lists, and documentation checklists.

Learn More → Markdown Task Lists

Try Tool → Markdown Task List Generator

Footnotes let you add references or additional information without interrupting the main content. Use them when extra context is useful but doesn't belong in the main paragraph.

Syntax#

Markdown supports footnotes.[^1]

[^1]: This is a footnote.

Best for technical documentation, academic writing, research notes, and long-form articles.

Learn More → Markdown Footnotes

Many Markdown platforms support emoji shortcodes, which are automatically converted into emojis on supported platforms. Keep emoji usage purposeful rather than decorative, especially in technical documentation.

Syntax#

:rocket:
:warning:
:white_check_mark:

Best for GitHub READMEs, project status, and documentation highlights.

Learn More → Markdown Emojis

Markdown allows HTML where additional formatting is needed. Inline HTML is useful when Markdown alone cannot achieve the desired layout or behaviour — keep it minimal to preserve portability across Markdown implementations.

Syntax#

<details>
<summary>Show More</summary>

Hidden content goes here.

</details>

Learn More → Markdown HTML

If you want Markdown to display formatting characters instead of interpreting them, escape them with a backslash. This is particularly useful when writing tutorials or documentation about Markdown itself.

Syntax#

\*Not Italic\*

\# Not a Heading

Live Preview#

Learn More → Markdown Escaping Characters

Some Markdown implementations support mathematical notation using LaTeX-style syntax. Math support depends on the Markdown editor or documentation platform you're using.

Inline Example#

$E = mc^2$

Block Example#

$$
a^2+b^2=c^2
$$

Best for scientific documentation, engineering notes, academic papers, and educational content.

Learn More → Markdown Math

Different Markdown elements serve different purposes. Choosing the right one improves readability and keeps documents consistent.

Instead of relying on one formatting style throughout a document, combine Markdown elements to create clear, well-structured content that is easy to read and maintain.

Markdown has evolved beyond its original specification. Today, many applications support additional features that make writing documentation, notes, and technical content more powerful. Understanding which Markdown implementation you're using helps avoid compatibility issues when moving documents between platforms.

GitHub renders Markdown across README files, Issues, Pull Requests, and Discussions using its own flavor built on top of standard Markdown. If you're documenting a repository, this is the implementation you'll use most often.

Best for GitHub repositories, project READMEs, issue tracking, and wikis.

Learn More → GitHub Markdown

GitHub Flavored Markdown builds on the CommonMark specification by introducing features designed for software development and collaborative documentation, including tables, task lists, strikethrough, automatic URL linking, footnotes, and GitHub-supported alerts.

Best for GitHub repositories, project READMEs, open-source documentation, issue tracking, and wikis.

Learn More → GitHub Flavored Markdown

Related Guides → GitHub Markdown · GitHub README Guide

Try Tool → README Generator

Obsidian extends standard Markdown with features designed for personal knowledge management and interconnected notes, including wikilinks, callouts, embedded notes, graph view, tags, and canvas support. Many of these extensions are specific to Obsidian and may not render correctly in other Markdown applications.

Syntax#

[[Daily Notes]]

# Meeting Notes

- Review project

Best for personal notes, knowledge bases, research, and second-brain workflows.

Learn More → Obsidian Markdown

Mermaid allows you to create diagrams using text-based syntax directly inside Markdown documents, including flowcharts, sequence diagrams, class diagrams, entity relationship diagrams, Gantt charts, pie charts, and mind maps. Support depends on the platform you're using — GitHub, many documentation frameworks, and several Markdown editors include Mermaid support.

Best for software architecture, technical documentation, process diagrams, and system design.

Learn More → Mermaid Diagrams

Visual Studio Code includes built-in Markdown support, making it one of the most popular editors for technical writing — with live preview, syntax highlighting, keyboard shortcuts, an extension marketplace, Git integration, and Mermaid support through extensions.

Best for software development, documentation, README files, and technical writing.

Learn More → VS Code Markdown

The best choice depends on where your Markdown will be published.

There's no single implementation that's best for every situation. The most important consideration is choosing one that's compatible with the tools and platforms used in your workflow.

Learn More → CommonMark Guide

Following a few simple practices will help your Markdown remain clean, readable, and compatible across different editors.

Use Standard Markdown Whenever Possible#

Core Markdown syntax works across nearly every implementation and provides the greatest portability.

Add Extensions Only When Needed#

Features such as tables, task lists, Mermaid diagrams, and callouts are useful, but they may not be supported everywhere. Before using an extension, confirm that your target platform supports it.

Keep Documents Well Structured#

Organise content with clear headings, descriptive link text, meaningful image alt text, and consistent formatting. A well-structured document is easier to read, maintain, and navigate.

Preview Before Publishing#

Always preview your Markdown in the application where it will ultimately be published. Small rendering differences are easier to fix before publication than afterwards.

Learn More → Markdown Best Practices · Markdown Style Guide