Skip to content
Markdown to PDF
Open editor

README to PDF

GitHub README to PDF

Paste a repository link or your README’s Markdown and download a tidy PDF with highlighted code, working links and images — perfect for handouts, reviews and offline reading.

Start writing
  • No signup
  • No watermark
  • No upload — runs in your browser
  • Free forever
# Acme CLI

> A fast, friendly command-line tool for shipping static sites.

[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

**Tip:** paste your own repository link into **Open → Import from link** to replace this example with your README.

## Installation

```bash
npm install -g acme-cli
```

## Quick start

```bash
acme init my-site
cd my-site
acme dev
```

## Configuration

Create an `acme.config.json` in your project root:

```json
{
  "outDir": "dist",
  "minify": true,
  "plugins": ["sitemap", "rss"]
}
```

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `outDir` | `string` | `"dist"` | Where built files are written |
| `minify` | `boolean` | `true` | Minify HTML, CSS and JS |
| `plugins` | `string[]` | `[]` | Plugins to load in order |

## API

```ts
import { build } from 'acme-cli';

await build({ root: process.cwd(), minify: true });
```

## Contributing

1. Fork the repository
2. Create a branch: `git checkout -b feature/amazing`
3. Commit your changes and open a pull request

> [!NOTE]
> Run `npm test` before opening a pull request.

## License

MIT © Acme Inc.
123 words 1,170 chars ~1 min read Ln 1, Col 1 A4 · portrait · README Private · on-device

Why use it

Why use this README to PDF tool

  • Import straight from GitHub

    Paste a repo, file or Gist link. Your browser fetches the README directly from GitHub — we never see it.

  • Images and badges just work

    Relative image paths like ./docs/screenshot.png are rewritten to GitHub’s raw URLs so they appear in the PDF.

  • Code that reads like code

    Syntax highlighting for 200+ languages, no coding ligatures, and long lines that wrap instead of disappearing off the page.

How to

How to use the README to PDF converter

  1. STEP 01

    Import the README

    Open → Import from link, then paste https://github.com/owner/repo. Or paste the Markdown yourself.

  2. STEP 02

    Pick the README theme

    It mirrors familiar repository styling. Add a table of contents or page numbers from Style.

  3. STEP 03

    Save as PDF

    Click Download PDF and choose “Save as PDF”. Links and the table of contents stay clickable.

Why convert a README to PDF?

A README is the front door of a project, but it lives on GitHub. Reviewers, clients, students and auditors often want a document they can annotate, attach to a ticket or read on a plane. Printing the GitHub page directly drags in navigation bars, sidebars and cut-off code. Converting the Markdown itself gives you a clean document that looks designed rather than screenshotted.

What carries over

  • Headings, lists and tables — GitHub-flavoured Markdown is fully supported, including alignment in tables and nested lists.
  • Code blocks — highlighted with the same grammars VS Code uses. Short blocks never split across pages.
  • Images and badges — rebased to raw GitHub URLs when you import by link.
  • Alerts — GitHub’s > [!NOTE] style callouts keep their colour and icon-free, print-friendly styling.
  • Links — every link stays clickable in the PDF, and headings get anchors so a table of contents works too.

Tips for a great README PDF

  1. Turn on Table of contents in Style → Document for long READMEs.
  2. Use Landscape if your README has wide tables.
  3. Add \newpage before big sections like API reference so they start on a fresh page.
  4. Switch the code theme to a dark one for slides-style handouts.

FAQ

Frequently asked questions

Can I convert a private repository’s README?

Import by link only works for public repositories. For private ones, copy the README text (or open the file from your computer) and paste it into the editor — it never leaves your browser.

Why are some images missing?

Images must be reachable from your browser. Relative paths are fixed automatically for imported READMEs; if you pasted the text yourself, use full image URLs or import by link instead.

Does it support GitHub alerts and task lists?

Yes — > [!NOTE], [!TIP], [!WARNING] and the rest render as styled callouts, and task lists render as checkboxes.

Can I convert docs with several Markdown files?

Open them one at a time, or paste them into one document and separate them with \newpage so each starts on a new page.

Ready when you are.

Paste your Markdown above, or open the full-screen editor.

Open the editor