Markdown Guide

What is Markdown?

Markdown is a lightweight markup language for creating formatted text using a plain-text editor. Created by John Gruber in 2004, it's now the standard for documentation, README files, static blogs, and AI/LLM training data.

Headings

Use # for H1, ## for H2, ### for H3, up to ###### for H6. Headings create document structure and are essential for accessibility.

# Main Title
## Section
### Subsection

Text Formatting

Bold uses **double asterisks**, italic uses *single asterisks*, and ~~strikethrough~~ uses double tildes.

**bold** *italic* ~~strikethrough~~

Lists

Unordered lists use -, *, or +. Ordered lists use numbers. Nest lists by indenting with 2 or 4 spaces.

- Item one
- Item two
  1. Sub-item
  2. Sub-item

Links and Images

Links: [text](URL). Images: . Reference-style links use [text][ref] with [ref]: URL at the bottom.

[DocsToMarkdown](https://docstomarkdown.com)
![Logo](https://example.com/logo.png)

Code

Inline code uses `backticks`. Code blocks use triple backticks with optional language annotation.

```javascript
const x = 1;
```

Tables

GFM tables use pipes and dashes. Add colons to control alignment.

| Left | Center | Right |
| :--- | :----: | ----: |
| a    | b      | c     |

Blockquotes

Use > for blockquotes. Nest blockquotes with >>. Combine with other Markdown elements.

> This is a blockquote
>
> - With a list
> - Inside it

Horizontal Rules

Three or more dashes, asterisks, or underscores create a horizontal rule.

---
***
___