Templates
Markdown Examples and Templates
Real-world Markdown templates for the most common use cases. Click any template to open it directly in the editor.
README Template
A professional README for an open-source project or personal repository. Covers project description, installation, usage, contributing, and licence.
markdown
# Project Name
Short description of what this project does and who it is for.
## Features
- Feature one
- Feature two
- Feature three
## Installation
```bash
npm install your-project-name
```
## Usage
```javascript
const project = require('your-project-name');
project.doSomething();
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Licence
[MIT](https://choosealicence.com/licenses/mit/)Blog Post Template
A structured blog post format with introduction, body sections, code examples, and a conclusion. Works with Jekyll, Hugo, Ghost, and most Markdown-based blogging platforms.
markdown
# Post Title **Published:** 2025-09-04 | **Reading time:** 5 min ## Introduction Write a brief introduction that hooks the reader and states what the article covers. ## Section One Body content for your first major point. Keep paragraphs short and focused. ### Subsection Additional detail, code example, or supporting evidence. ```javascript // Code example const result = doSomething(input); console.log(result); ``` ## Section Two Continue building your argument or explanation here. | Comparison | Option A | Option B | |------------|----------|----------| | Speed | Fast | Slow | | Cost | Free | Paid | ## Conclusion Summarise the key points and include a clear call to action. --- *Found this useful? Share it with your team.*
Technical Documentation Template
A documentation template for software libraries, tools, or internal processes. Includes overview, prerequisites, usage, configuration, and troubleshooting sections.
markdown
# Component / Tool Name
> One-line description of what this does.
## Overview
Explain the purpose of this component or tool in 2–3 sentences.
## Prerequisites
- Node.js 18+
- npm or yarn
- Access to the internal network
## Installation
```bash
npm install @company/component-name
```
## Configuration
| Parameter | Type | Default | Description |
|-----------|--------|---------|----------------------|
| `apiUrl` | string | — | Base URL for the API |
| `timeout` | number | 5000 | Request timeout (ms) |
| `debug` | boolean| false | Enable debug logging |
## Usage
```typescript
import { Component } from '@company/component-name';
const client = new Component({
apiUrl: 'https://api.example.com',
timeout: 3000,
});
const result = await client.fetchData('resource-id');
```
## Troubleshooting
**Error: Connection refused**
Check that the `apiUrl` is correct and the service is reachable from your network.
**Error: Timeout**
Increase the `timeout` value or check network latency.
## Changelog
| Version | Date | Changes |
|---------|------------|-------------------|
| 1.2.0 | 2025-09-04 | Added retry logic |
| 1.1.0 | 2025-08-01 | TypeScript types |Meeting Notes Template
A clean meeting notes format for recording decisions, action items, and attendees. Easy to share via email or commit to a documentation repository.
markdown
# Meeting: [Topic] — 2025-09-04 **Attendees:** Alice, Bob, Carol **Facilitator:** Alice **Note-taker:** Bob --- ## Agenda 1. Review progress from last sprint 2. Discuss Q4 roadmap 3. Any other business --- ## Discussion ### 1. Sprint Review Summary of what was covered in this agenda item. ### 2. Q4 Roadmap Key points discussed and decisions reached. --- ## Decisions - Decision one agreed by the team - Decision two — owner: Alice, deadline: 2025-09-15 ## Action Items - [ ] Alice — Send updated roadmap to stakeholders by 2025-09-10 - [ ] Bob — Schedule follow-up meeting for Q4 kick-off - [ ] Carol — Review open tickets and prioritise for next sprint --- **Next meeting:** 2025-09-18 at 10:00
API Reference Template
A clear format for documenting REST API endpoints. Covers method, parameters, request body, and response examples.
markdown
# API Reference
Base URL: `https://api.example.com/v1`
All requests require the header:
`Authorization: Bearer YOUR_API_KEY`
---
## Endpoints
### GET /users
Returns a list of users.
**Query Parameters**
| Parameter | Type | Required | Description |
|-----------|---------|----------|----------------------|
| `limit` | integer | No | Max results (1–100) |
| `offset` | integer | No | Pagination offset |
**Response**
```json
{
"data": [
{ "id": 1, "name": "Alice", "email": "[email protected]" }
],
"total": 42,
"limit": 20,
"offset": 0
}
```
---
### POST /users
Creates a new user.
**Request Body**
```json
{
"name": "Bob",
"email": "[email protected]",
"role": "editor"
}
```
**Response** — `201 Created`
```json
{ "id": 43, "name": "Bob", "email": "[email protected]" }
```Start writing better Markdown today
Free, private, no account needed — open the editor in your browser and write immediately.