README to PDF or Word
Paste a GitHub repository link or the README itself, and get a clean document to send, print or attach.
How it works
Point at a repo
Enter a GitHub repository and fetch its README, or paste the text.
Pick a format
PDF for sending and printing, Word for editing.
Download
Code blocks, tables and badges come out as they look on GitHub.
When it helps
Handing a project to someone outside GitHub. A client, a reviewer or a grant committee gets a document instead of a link to a repository.
Docs for an offline or regulated setting. Attach the PDF to a ticket, an audit or a release package.
Editing in Word. The .docx keeps headings and tables as Word styles, so non-developers can work on it.
Do this from your agent
Working in the repository already? Your agent can publish the README, or the whole docs folder, and export it as PDF in one command.
# Install once
npm install -g @opendocs.cc/cli
# Authenticate (one-time, opens browser)
opendocs login --browser
# Publish, get a shareable URL back
opendocs publish report.md --export pdf --jsonFAQ
Which links work?
A repository (github.com/owner/repo or just owner/repo), a folder in one (…/tree/main/docs), or a Markdown file (…/blob/main/docs/guide.md or a raw.githubusercontent.com link). For anything else, paste the text.
Does it work with private repositories?
No. Your browser fetches the README from GitHub without signing in, so only public repositories work. For a private one, open the README on GitHub, copy the raw text and paste it here.
What about images and relative links?
Relative image paths and links are pointed at the repository on GitHub, so badges, screenshots and links to other files keep working in the PDF.
Does my repository go through your servers?
The README is fetched by your browser, straight from GitHub. Only the text you convert is sent to our converter, and it isn't stored.
Is there a limit?
2 MB of Markdown per file, and 5 conversions a minute, 30 an hour and 100 a day from one address. GitHub also allows 60 fetches an hour per address without an account; past that, paste the README instead.
Can I publish a README as a web page?
Yes. After converting, "Publish it as a link" makes a page anyone can open for 24 hours. With an account, your agent can publish the docs folder of a repository and keep it in sync.
More free tools
Publish your docs, not just export them
OpenDocs publishes Markdown from your repository as shareable pages, with PDF and Word export included.
Free for up to 50 documents. No credit card.