Skip to content

Markdown — Complete Guide

In this tutorial, you will learn about Markdown. We cover key concepts, practical examples, and best practices to help you master this topic.

Markdown is a lightweight markup language that converts plain text into structured HTML using simple, readable syntax. Master documentation writing with hands-on tutorials.

1. What Is Markdown?
Origins, philosophy, and use cases
2. Headings
Six levels of headings and document structure
3. Lists
Ordered, unordered, and nested lists
4. Text Formatting
Bold, italic, strikethrough, and inline code
5. Links
Inline, reference-style, and auto-links
6. Images
Embedding images with alt text
7. Tables
Creating and aligning tables
8. Code Blocks
Inline code, fenced blocks, syntax highlighting
9. Blockquotes
Quoting text and nested blockquotes
10. Horizontal Rules & Breaks
Separators, line breaks, and hard wraps
11. GitHub Flavored Markdown
GFM extensions and platform specifics
12. Footnotes
Adding references and citations
13. Task Lists
Checkboxes and progress tracking
14. Math Expressions
LaTeX math in Markdown
15. HTML in Markdown
Embedding raw HTML for extended control
16. Pandoc Conversions
Converting Markdown to PDF, EPUB, DOCX
17. Docs-as-Code Workflows
Version-controlled documentation pipelines
18. Hugo & Hextra Shortcodes
Static site generation with Markdown
19. MkDocs
Project documentation with Material theme
20. Obsidian & Knowledge Management
Personal knowledge bases with Markdown

Published Topics

What Is Markdown?

Markdown is a lightweight markup language with plain-text formatting syntax designed for easy reading and writing.

✓ Live

Headings and Structure — Complete Guide

Markdown headings use # symbols to create a hierarchical document structure with six levels of headings.

✓ Live

Paragraphs and Line Breaks — Complete Guide

Markdown paragraphs are separated by blank lines, with line breaks inserted by ending a line with two spaces.

✓ Live

Italic, Bold, and Strikethrough — Complete Guide

Markdown emphasis uses single asterisks for italic, double asterisks for bold, and double tildes for strikethrough.

✓ Live

Ordered and Unordered Lists — Complete Guide

Markdown lists use asterisks or dashes for unordered and numbers for ordered lists, with sublists created by indentation.

✓ Live

Links and URLs — Complete Guide

Markdown links use [text](url) syntax with support for reference-style links that improve readability of raw Markdown.

✓ Live

Images — Complete Guide

Markdown images use ![alt text](url) syntax with alt text for accessibility and optional title attributes.

✓ Live

Code and Syntax Highlighting — Complete Guide

Markdown code uses backticks for inline code and triple backticks for fenced code blocks with optional language highlighting.

✓ Live

Blockquotes — Complete Guide

Markdown blockquotes use > characters to indicate quoted content, supporting nesting and other Markdown elements inside.

✓ Live

Horizontal Rules — Complete Guide

Markdown horizontal rules use three or more dashes, asterisks, or underscores to create thematic breaks.

✓ Live

Tables — Complete Guide

Markdown tables use pipes and dashes to create tabular data with optional alignment control via colons.

✓ Live

Task Lists — Complete Guide

GitHub-Flavored Markdown task lists use - [] and - [x] for unchecked and checked items in issues and pull requests.

✓ Live

Footnotes — Complete Guide

Markdown footnotes use [^ref] syntax for references that link to definitions at the bottom of the document.

✓ Live

Using HTML in Markdown — Complete Guide

Markdown allows raw HTML for elements that Markdown syntax does not cover, with inline HTML working naturally.

✓ Live

Extended Markdown Syntax — Complete Guide

Extended syntax in different implementations adds tables, fenced code blocks, definition lists, and auto-links.

✓ Live

Markdown vs Other Formats — Complete Guide

Markdown balances simplicity, readability, and power compared to LaTeX, reStructuredText, AsciiDoc, and HTML.

✓ Live

Markdown Tools and Editors — Complete Guide

Markdown editors range from simple text editors with preview to dedicated tools like Typora, Obsidian, and VS Code.

✓ Live

Character Escaping — Complete Guide

Markdown backslash escaping prevents special characters like * and [] from being interpreted as formatting.

✓ Live

Markdown Best Practices

Consistent Markdown practices include one space after list markers, blank lines around blocks, and semantic headings.

✓ Live

Real-World Projects — Complete Guide

Build comprehensive documentation including README files, wikis, technical documentation, and note-taking systems using Markdown.

✓ Live

All 20 topics in Markdown — Complete Guide are published.