The Complete Markdown Guide

Markdown makes formatting text simple and portable

📋 Table of Contents

1. Introduction
2. Basic Syntax
3. Extended Features
4. Advanced Usage
5. Best Practices
6. Resources

Introduction

Markdown is a lightweight markup language that allows you to format text using simple syntax. Created in 2004 by John Gruber, it's now widely used for:

• Documentation
• Readme files
• Blog posts
• Forum discussions
• Note taking

Key Benefits: ✅ Easy to learn ✅ Portable across platforms ✅ Readable even as plain text ✅ Supports HTML when needed

Basic Syntax

Headings

Text Formatting

Italic or Italic Bold or Bold Bold & Italic Strikethrough ==Highlighted== Inline code

Lists

Unordered

• Item 1
  • Sub-item 1
    • Sub-sub-item 1

Ordered

1. First item
2. Second item
   1. Nested item

Mixed

• Item A

1. Item B

• Item C

Task Lists

• Completed task
• Pending task

Links & Anchors

Basic Links

Anchor Links

Go to Introduction Jump to Resources Jump to other page

Use relative paths for internal links to ensure portability. For example, [Link Text](docs/other-page.md) will link to other-page.md in the docs directory. Internal links also display a tooltip with the title and description of the target page.

Between Documents

Original Video Example

YouTube video as linked image:

Originally videos are not supported in Markdown, but you can link to them using images or embed HTML.

Images

Basic image syntax:

With formatting options:

Blockquotes

This is a blockquote Spanning multiple lines

Horizontal Rules

---

Extended Features

Tables

Code Blocks

Inline

Use console.log() for debugging

Syntax Highlighting

Footnotes

Here's a footnote reference¹

Advanced Usage

Mermaid Diagrams

HTML Integration

Emojis

:rocket: :sparkles: :books:

Best Practices

1. Consistency Matters

   • Stick to one style for headings, lists, etc.

2. Readability First

   • Keep lines under 80 characters
   • Use blank lines between sections

3. Accessibility

   • Always use descriptive alt text for images
   • Use meaningful link text

4. Document Structure

Resources

• Official Markdown Guide
• Interactive Tutorial
• GitHub Flavored Markdown
• Cheat Sheet PDF

Happy writing! ✍️

Footnotes

1. This is the footnote content ↩