Skip to main content
Library

Markdown Snippet Library

25+ ready-to-use markdown blocks. Copy and paste into any editor.

Build Passing Badge
Standard CI/CD build status badge
Badges
![Build](https://img.shields.io/badge/build-passing-brightgreen)
MIT License Badge
License badge for MIT
Badges
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
npm Version Badge
Live npm package version badge
Badges
[![npm version](https://img.shields.io/npm/v/your-package.svg)](https://www.npmjs.com/package/your-package)
Made with Badge
Technology stack badge
Badges
![Made with TypeScript](https://img.shields.io/badge/Made%20with-TypeScript-blue?logo=typescript)
Centered Project Header
Centered title with description and badges
Headers & Dividers
<div align="center">

# Project Name

A brief description of what this project does.

[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Stars](https://img.shields.io/github/stars/username/repo)](https://github.com/username/repo)

[Demo](https://example.com) · [Docs](https://docs.example.com) · [Report Bug](https://github.com/username/repo/issues)

</div>
Section Divider
A thematic break between sections
Headers & Dividers

---
Table of Contents
Manual table of contents with anchors
Headers & Dividers
## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#license)
Note Callout
Informational note block
Callouts & Alerts
> **Note**
> This is an important note about the feature.
Warning Callout
Warning block for important caveats
Callouts & Alerts
> **Warning**
> Be careful with this configuration. It may cause data loss.
Tip Callout
Helpful tip block
Callouts & Alerts
> **Tip**
> Use keyboard shortcut `Ctrl+K` to quickly insert a link.
GitHub Alert: Note
GitHub's official alert syntax (renders colored blocks on GitHub)
Callouts & Alerts
> [!NOTE]
> Useful information that users should know.
GitHub Alert: Warning
GitHub warning alert with yellow highlight
Callouts & Alerts
> [!WARNING]
> Critical content requiring user attention.
Bash Code Block
Shell/terminal commands
Code Blocks
```bash
npm install
npm run dev
```
TypeScript Code Block
TypeScript code with syntax highlighting
Code Blocks
```typescript
interface User {
  id: string;
  name: string;
  email: string;
}

const getUser = async (id: string): Promise<User> => {
  const response = await fetch(`/api/users/${id}`);
  return response.json();
};
```
Inline Code
Inline code formatting
Code Blocks
Use the `console.log()` function to debug your code.
Diff Block
Show code changes with + and - markers
Code Blocks
```diff
- const old = "value";
+ const updated = "new value";
```
Basic Table
Simple markdown table with headers
Tables
| Column 1 | Column 2 | Column 3 |
|---|---|---|
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
| Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
Aligned Table
Table with left, center, and right alignment
Tables
| Left | Center | Right |
|:---|:---:|---:|
| Cell | Cell | Cell |
| Data | Data | Data |
API Parameters Table
Common format for documenting API parameters
Tables
| Parameter | Type | Required | Description |
|---|---|---|---|
| `id` | `string` | Yes | Unique identifier |
| `name` | `string` | No | Display name |
| `limit` | `number` | No | Max results (default: 10) |
Contributing Section
Standard contributing blurb for README
GitHub Specific
## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Installation Section
Standard installation instructions
GitHub Specific
## Installation

```bash
# Clone the repo
git clone https://github.com/username/repo.git

# Navigate to directory
cd repo

# Install dependencies
npm install

# Start development server
npm run dev
```
Task List / Checklist
GitHub task list with checkboxes
GitHub Specific
- [x] Initial setup
- [x] Core features
- [ ] Documentation
- [ ] Tests
- [ ] CI/CD pipeline
Collapsible Section
HTML details/summary for collapsible content
Miscellaneous
<details>
<summary>Click to expand</summary>

This content is hidden by default and shown when clicked.

</details>
Footnote
Markdown footnote reference
Miscellaneous
This is a sentence with a footnote.[^1]

[^1]: This is the footnote content.
Keyboard Key
Show keyboard shortcuts with HTML kbd tag
Miscellaneous
Press <kbd>Ctrl</kbd> + <kbd>C</kbd> to copy.

Want to format more complex markdown?

Use the Table Generator or Badge Generator for visual formatting tools.