README to PDF converter
Turn a GitHub README.md, or any project documentation written in Markdown, into a PDF you can share with people who do not use GitHub.
How to use the README to PDF converter
- Download or copy your README.md.
- Upload it here, or paste the text, and choose PDF.
- Download the PDF.
What stays intact
- Headings and the document structure
- Tables and lists
- Code blocks with their spacing
- Links
- Images that are embedded in the file
About the README to PDF converter
Why convert a README
A PDF is easy to attach to a proposal, hand to a client, include in an audit pack, or read offline. It looks the same for everyone and does not need GitHub, an account or a Markdown viewer.
Images and badges
A README usually shows pictures with links such as ./docs/screenshot.png or badges loaded from other websites. For privacy and safety this converter never downloads files from other places, so those images show as a short text note. To include a picture, embed it inside the Markdown file.
Code and tables
Fenced code blocks keep their indentation in a fixed-width font, and tables stay tables, with the header row repeated on every page when they are long.
Paper size
Choose A4 or US Letter before converting, and every page gets a page number.
Frequently asked questions
- Why are my badges and screenshots missing?
- Images stored elsewhere are not downloaded, so they appear as text notes. Embed an image in the Markdown if you need it in the PDF.
- Can I convert a whole repository?
- One file at a time. Convert each Markdown file you need, such as README.md or a document in your docs folder.
- Does it support GitHub-style tables?
- Yes. Tables written with vertical bars are drawn as proper tables.