MDPress

GitHub Markdown to PDF

README to PDF for any GitHub project

A README is written to be read on GitHub, yet sometimes it has to travel as a file: a client handover, a compliance folder, a course submission. MDPress reads the same GitHub-flavoured Markdown, so task lists, tables and fenced code come out as a paginated PDF with highlighted code and text you can select.

Open the converter

Convert a GitHub README to PDF in three steps.

  1. 01

    Get the raw Markdown

    Open README.md on GitHub and press the Raw button, or use the copy raw file icon beside it. If you have the repository cloned, the file is already on your disk.

  2. 02

    Paste or upload it

    Paste the text into the editor, or choose Upload Markdown and open the .md file. The live preview shows every section on real pages, so you can spot a missing image or a long code line before you export.

  3. 03

    Set the page and download

    The Technical style numbers the sections and gives code blocks room, which suits documentation. Pick A4 or US Letter, switch on a contents page if the README is long, and download.

A small README, ready to convert.

Paste a file like this one and every part of it carries into the PDF.

# tinycache

A small in-memory cache for Node.js with time-based expiry.

## Install

```bash
npm install tinycache
```

## Usage

```js
import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });
```

## Roadmap

- [x] Expiry per key
- [ ] Size limit

tinycache

A small in-memory cache for Node.js with time-based expiry.

Install

npm install tinycache

Usage

import { createCache } from "tinycache";
const cache = createCache({ ttl: 60_000 });
cache.set("user:1", { name: "Ada" });

Roadmap

  • Expiry per key
  • Size limit

Why convert a README here.

It reads GitHub-flavoured Markdown

Task lists, pipe tables, fenced code with a language label, autolinks and strikethrough are all understood, because the converter follows the same flavour GitHub does. A mermaid fence is drawn as a diagram, as it is on the repository page.

Code that stays readable on paper

Install commands and config samples are highlighted by language. A line that is wider than the page wraps inside its block instead of running off the edge, so nobody has to guess the end of a long command.

A contents page from your headings

Long READMEs already have an outline in their headings. The Contents tool lists the first three heading levels on a page at the front, with page numbers, and the Cover tool adds a title page with the project name, author and date.

Tips and honest limits.

  • Relative image paths such as docs/screenshot.png will not load, because the converter cannot see your repository. Upload the picture with the Images tool, or replace the path with the full web address of the image.
  • Raw HTML is shown as text and is not rendered. Many READMEs use HTML for a centred logo, badges in a row or a collapsible section, so rewrite those parts as plain Markdown or remove them.
  • Relative links to other files in the repository, like CONTRIBUTING.md, lead nowhere inside a PDF. Change them to full GitHub addresses before you export.

README to PDF questions.

Can I paste a GitHub link and convert the README directly?
No. MDPress does not fetch repositories. Open the README on GitHub, press Raw, copy the text and paste it, or upload the README.md file from your clone. It takes a few seconds and also works for private repositories, since you supply the text yourself.
Why are the images missing from my README PDF?
The README most likely points to images with relative paths, which only resolve inside the repository. Add each picture through the Images tool so it is embedded in the document, or link to an absolute address on the web. Embedded images count towards the 4 MB limit.
Do badges and HTML blocks in a README work?
Badges written in Markdown image syntax with a full web address load like any other image. Anything written as HTML tags is printed as literal text, so a centred header block or a details section needs converting to Markdown first.

Make the README a file you can send.

Paste the raw Markdown or upload README.md, check the preview and download. No account is needed for the first four PDFs each day.

Open the converter