Turn your project's README into a shareable, professionally formatted PDF. Handles everything GitHub renders — badges, code blocks, tables, images, and more.
A typical README rendered with full formatting.
# My Awesome Project
A lightweight CLI tool for managing cloud infrastructure.
## Installation
```bash
npm install -g awesome-cli
```
## Quick Start
```javascript
const { deploy } = require('awesome-cli');
await deploy({ region: 'us-east-1' });
```
## Features
| Feature | Description |
|---------------|----------------------|
| Auto-scaling | Scale based on load |
| Monitoring | Built-in dashboards |
| Zero downtime | Rolling deployments |A lightweight CLI tool for managing cloud infrastructure.
npm install -g awesome-cli
const { deploy } = require('awesome-cli');
await deploy({ region: 'us-east-1' });
| Feature | Description |
|---|---|
| Auto-scaling | Scale based on load |
| Monitoring | Built-in dashboards |
| Zero downtime | Rolling deployments |
Your README is often the most important document in your project. But not everyone has a GitHub account or knows how to navigate a repository. A PDF makes your documentation universally accessible.
Clients, managers, and partners who don't use GitHub can review your project documentation as a clean PDF.
Keep PDF copies of important READMEs for offline reference, compliance records, or internal knowledge bases.
Turn your well-written README into a professional document for grant applications, technical proposals, or sprint reviews.
GitHub badges (build status, coverage, version) and images render correctly in the preview and PDF output.
Fenced code blocks with syntax highlighting for 190+ languages. Your installation commands and code examples look sharp.
GFM tables with alignment, ordered/unordered lists, nested lists, and task lists all convert perfectly.
Your README's heading hierarchy (H1-H6) is preserved with proper typography, spacing, and visual hierarchy in the PDF.
Open your repository on GitHub, click the README.md file, then click the "Raw" button to see the plain markdown. Select all and copy.
Paste the content into the MarkdownToPDF editor, or drag your .md file directly onto the page.
If your README references local images, drag them into the editor. They'll be stored in your browser and embedded in the PDF.
Review the live preview, then click Download PDF. Your browser's print dialog will open — choose "Save as PDF".
| Feature | MarkdownToPDF | GitHub Print | Pandoc CLI |
|---|---|---|---|
| No installation | ✅ | ✅ | ❌ |
| GFM tables & tasks | ✅ | ✅ | ✅ |
| Syntax highlighting | ✅ | ❌ | ⚠️ Config needed |
| Mermaid diagrams | ✅ | ✅ | ❌ |
| Local images | ✅ | ❌ | ✅ |
| Privacy (no upload) | ✅ | ❌ | ✅ |
| Live preview | ✅ | ❌ | ❌ |
Use heading hierarchy consistently (H1 for title, H2 for sections, H3 for subsections) for a clean table of contents in the PDF.
Keep code blocks short — very long code blocks may span multiple pages. Consider linking to files instead.
Use relative image paths in your README, then drag the images into the editor for local conversion.
Test your PDF by checking page breaks — the print dialog lets you preview before saving.
Paste your README.md and get a professional PDF in seconds.
Start ConvertingBuilt by Yogendra Singh