Markdown Guide

Written By :

Joel

Category :

knowledge

Posted On :

January 31, 2025

Share This :

Markdown Guide

Introduction

Markdown is a lightweight markup language designed to format text easily and efficiently. It allows you to create rich text elements like headings, lists, links, and more without the need for complex HTML tags.

Table of Contents

  1. Introduction
  2. Basic Syntax
  3. Advanced Features
  4. Rendering and Compatibility
  5. Practical Examples
  6. Conclusion

Basic Syntax

Headings

Markdown lets you create headings using the # symbol. The number of # characters defines the heading level.

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

Rendered output:

Level 1 Heading

Level 2 Heading

Level 3 Heading

Bold and Italic Text

  • Bold: Use ** or __ around the text.
  • Italic: Use * or _ around the text.
  • Bold and Italic: Use a combination of ***.

Example:

**Bold text**  
*Italic text*  
***Bold and Italic text***

Rendered output:
Bold text
Italic text
Bold and Italic text

Lists

Bullet Lists

Use -, *, or + to create a bullet list.

- Item 1  
- Item 2  
  - Sub-item  
* Item 3

Rendered output:

  • Item 1
  • Item 2
    • Sub-item
  • Item 3

Numbered Lists

Use numbers followed by a period to create a numbered list.

1. Item 1  
2. Item 2  
   1. Sub-item  
3. Item 3

Rendered output:

  1. Item 1
  2. Item 2
    1. Sub-item
  3. Item 3

Use the following syntax to create a link:

[Link text](URL)

Example:

[Visit OpenAI](https://www.openai.com)

Rendered output: Visit OpenAI

Images

Add ! before the link syntax to embed an image.

![Alt text](Image_URL)

Example:

![Markdown Logo](https://markdown-here.com/img/icon256.png)

Rendered output:
Markdown Logo

Blockquotes

Use > at the beginning of a line to create a blockquote.

> This is a quote.  
> It can span multiple lines.

Rendered output:

This is a quote.
It can span multiple lines.

Code

Inline Code

Wrap text with backticks (`) to create inline code.

Here is an example of `inline code`.

Rendered output: Here is an example of inline code.

Code Blocks

Use triple backticks (“`) to create a code block.

print("Hello, world!")

Rendered output:

print("Hello, world!")

Advanced Features

Tables

Create tables using vertical bars (|) and hyphens (-).

| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
| Row 1    | Data 1   | Data 2   |
| Row 2    | Data 3   | Data 4   |

Rendered output:

Column 1 Column 2 Column 3
Row 1 Data 1 Data 2
Row 2 Data 3 Data 4

Multiline Code Blocks

To display multiline code, use triple backticks or tildes.

def hello_world(): print("Hello, world!")

Rendered output:

def hello_world():
    print("Hello, world!")

Anchors

Headings automatically generate anchors for internal links. For example, a heading like:

## Advanced Features

can be referenced with an internal link:

[Go to the Advanced Features section](#advanced-features)

Rendering and Compatibility

Markdown is supported on many platforms, each with its own extensions or variations (e.g., GitHub Flavored Markdown). Popular tools include:

  • Visual Studio Code (with built-in preview)
  • GitHub (for documentation)
  • Markdown Here (browser extension)

Practical Examples

Here are a few examples of practical documents created with Markdown:

  1. Simple Document: A summary or article.
  2. Technical Document: Documentation with code, tables, and lists.
  3. Task List (checklist):
- [x] Finish the Markdown guide  
- [ ] Proofread and fix errors  
- [ ] Publish the document

Rendered output:

  • [x] Finish the Markdown guide
  • [ ] Proofread and fix errors
  • [ ] Publish the document

Conclusion

Markdown is a powerful yet simple tool for creating formatted text. Its lightweight syntax enhances readability and simplifies document management. Whether you're a developer, blogger, or writer, Markdown can help you quickly produce elegant documents.

That's the complete Markdown guide for learning and mastering its usage! 😊