Markdown

# Markdown Guide

Markdown is a lightweight markup language that allows you to write formatted documents using plain text. It is widely used in documentation, technical writing, blogging, and note-taking because it is easy to read and easy to convert into HTML.

* * *

## 📌 What You Will Learn

*   Basic Markdown syntax
    
*   Headings, text styles, lists
    
*   Images, links, tables
    
*   Code blocks and inline code
    
*   Blockquotes and horizontal rules
    
*   Extended syntax (diagrams, task lists, footnotes, etc.)

* * *

# 1\. Headings

Use `#` symbols to create headings.

```markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
```

* * *

# 2\. Text Formatting

### **Bold**

```markdown
**bold text**
```

### _Italic_

```markdown
*italic text*
```

### Strikethrough

```markdown
~~strikethrough~~
```

### `Inline Code`

```markdown
`inline code`
```

### Paragraphs & Line Breaks

A blank line creates a new paragraph.  
Add two spaces at the end of a line for a line break.

* * *

# 3\. Lists

## Unordered List

```markdown
- Item A
- Item B
  - Subitem B1
```

## Ordered List

```markdown
1. First
2. Second
3. Third
```

## Task List

```markdown
- [ ] Incomplete task
- [x] Completed task
```

* * *

# 4\. Links & Images

## Hyperlinks

```markdown
[OpenAI](https://openai.com)
```

## Images

```markdown
![Alt text](https://example.com/image.png)
```

* * *

# 5\. Blockquotes

Use `>` for a blockquote.

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

* * *

# 6\. Code Blocks

Use triple backticks:

### Example

Specify a language to enable syntax highlighting.

* * *

# 7\. Horizontal Rule

```markdown
---
```

* * *

# 8\. Tables

```markdown
| Name    | Age | Role     |
|---------|-----|----------|
| Alice   | 24  | Engineer |
| Bob     | 30  | Designer |
```

* * *

# 9\. Extended Markdown (Common Extensions)

Not all platforms support all features, but many modern editors (including yours) do.

* * *

## Mermaid Diagrams

```markdown
  ```mermaid
  flowchart TD
      A[Start] --> B{Is Markdown easy?}
      B -- Yes --> C[Great!]
      B -- No --> D[Practice more]
  ```
```

````
---

## Footnotes

```markdown
Markdown is simple to learn.[^1]

[^1]: This is a footnote example.
````

* * *

## Definition Lists

```markdown
Term 1
:   Definition 1

Term 2
:   Definition 2
```

* * *

# 10\. Best Practices

*   Use headings to structure sections
    
*   Keep paragraphs short for readability
    
*   Use tables for structured data
    
*   Use code blocks for programming examples
    
*   Use relative links for documents in the same project

* * *