Markdown

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

bold text or __bold text__ *italic text* or _italic text_ ~~strikethrough~~ bold and _italic_ combined

> Blockquote > Can span multiple lines

Horizontal rule: ---

Line break: end a line with two spaces or use a blank line for a new paragraph. ```

<!-- Unordered list -->
- Item one
- Item two
  - Nested item (2-space indent)
  - Another nested
- Item three

1. First step 2. Second step 1. Sub-step 2. Another sub-step 3. Third step

• [x] Completed task
• [ ] Pending task
• [ ] Another item

| Feature | MySQL | PostgreSQL | SQLite | |-------------|--------|------------|--------| | JSON Support| Partial| Native JSONB| Basic | | Full-text | Yes | Yes (tsvector) | Yes | | Extensions | Limited| Rich ecosystem | No | | ACID | Yes | Yes | Yes | ```

<!-- Links -->
[Display text](https://example.com)
[Link with title](https://example.com "Hover tooltip")
[Reference link][ref-id]
[ref-id]: https://example.com "Optional title"

  [](https://example.com)

Use const x = 5 for inline code.

``javascript function hello(name) { return Hello, ${name}!; } ``

def hello(name):
    return f"Hello, {name}!"

<!-- Syntax highlighting in code blocks -->
```bash
npm install
npm run build

Hidden content here. Supports Markdown inside!

This is a fact.[^1]

[^1]: Source: Important Paper, 2024.

> [!NOTE] > Useful information that users should know.

> [!WARNING] > Critical content demanding immediate user attention.

> [!TIP] > Optional information to help a user be more successful.

``mermaid graph TD; A[User Request] --> B{Authenticated?}; B -- Yes --> C[Process Request]; B -- No --> D[Return 401]; ` ``

A well-crafted README is the front door of your project. Structure it to answer:

What is it? One-paragraph description, what problem it solves.

Badges (build status, coverage, npm version, license): ``markdown ![Build Status](https://github.com/user/repo/workflows/CI/badge.svg) ![npm version](https://img.shields.io/npm/v/package.svg) ![License](https://img.shields.io/badge/license-MIT-blue.svg) ``

Quick Start get a user running in < 5 minutes: ``markdown ## Installation `bash npm install my-package ``

## Usage ``javascript const pkg = require('my-package'); pkg.doSomething({ key: 'value' }); ` ``

Other key sections: Configuration, API Reference, Contributing, Changelog, License

Tips: Keep it current (outdated docs are worse than none), use screenshots/GIFs for visual tools, link to full docs for complex projects.

Types of Documentation
• README: project overview and quick start
• API Reference: auto-generated from code (JSDoc, Sphinx, godoc)
• Tutorials: step-by-step guides for common tasks
• How-to guides: specific recipes for specific problems
• Explanations: conceptual deep-dives (the why)
• Changelogs: CHANGELOG.md with Semantic Versioning (MAJOR.MINOR.PATCH)

Tools Built on Markdown
• GitHub/GitLab wikis and issues
• Docusaurus, VuePress, MkDocs: static documentation sites
• Obsidian, Notion: knowledge management
• Jupyter notebooks: .ipynb files use Markdown cells
• Slides: Reveal.js, Marp

MDX (Markdown + JSX): embed React components in Markdown for interactive documentation used by Docusaurus, Nextra, and many modern doc sites.

Linting: markdownlint enforces consistent style. Vale checks prose quality. Both integrate into CI pipelines.