Skip to content

Turn a README into a PDF worth attaching.

READMEs are written for GitHub, but sooner or later one has to leave GitHub: a client wants the setup guide as a document, a security review needs an offline copy, a course submission requires PDF. Copy-pasting into Word mangles the code blocks; browser printing slices tables in half.

Scripto understands GitHub-Flavored Markdown natively — fenced code with syntax highlighting, tables, task lists, badges, emoji — and typesets it into real pages where code blocks break cleanly and every page carries the project name and a page number.

Open the README template

How to convert a README.md to PDF

  1. Grab your README

    Copy the raw contents of README.md (the “Raw” button on GitHub) or just drag the file into Scripto.

  2. Paste into Scripto

    Open the editor and paste. GitHub-Flavored Markdown — tables, task lists, fenced code, emoji — renders immediately in the paginated preview.

  3. Pick a technical skin

    The Technical or Blueprint skins are tuned for documentation: tighter code blocks, clear heading hierarchy, mono accents.

  4. Export PDF

    One click. Your README becomes a paginated document with a cover page and clickable table of contents if you want them.

Code blocks that survive pagination

The hardest part of converting developer docs is code. Scripto highlights fenced code blocks (with the language label preserved), keeps short blocks intact on one page, and breaks long ones at line boundaries — never mid-line, never mid-character. Inline code stays inline, and wide code can scale down instead of overflowing the page.

Tables, badges and the rest of GitHub Markdown

GFM tables render with proper column widths and repeat their header row when they cross a page break. Task lists keep their checkboxes, footnotes become real footnotes, and shield badges render as images. If your README embeds raw HTML, that works too.

Make it a real document

A README printed as-is still looks like a web page. Two clicks turn it into a document: enable the cover page (title, subtitle, author, date) and the table of contents generated from your headings. Add a running footer like “MyProject — Setup Guide” and it is ready for the people who will never open GitHub.

Frequently asked questions

Does syntax highlighting survive in the PDF?

Yes. Fenced code blocks are highlighted (Prism grammar set) and the colors are preserved in the exported PDF exactly as previewed.

What happens to relative image links?

Images with absolute URLs render normally. Relative repo paths (./docs/img.png) have no file to resolve to — paste the absolute raw.githubusercontent.com URL for those.

Can I convert several project docs into one PDF?

Concatenate the Markdown files in the editor (they stack into one document), add a cover and TOC, and export a single handbook-style PDF.

Will GitHub badges (shields.io) show up?

Yes — they are ordinary images. If you prefer a cleaner print, delete the badge line before exporting.

Is anything uploaded to a server?

No. The conversion runs entirely in your browser; your documentation never leaves your machine.

Related guides

Try it now — free

Turn a GitHub README.md into a clean, paginated PDF with unbroken code blocks, working tables and page numbers. Free, client-side, no upload.