Read a local README
Choose README.md in MarkdownPaper or drop it into the browser window. The
document is rendered locally, and the contents rail helps you move through
long sections without keeping a sidebar open.
Links from one Markdown file to another work once both are in your library.
Open the README's folder in the desktop app and a link such as
docs/setup.md opens that document. In the browser, a link finds a document
you have already opened under the same file name, and otherwise tells you
which file to open.
Relative images, a screenshot or diagram stored beside the README such as
docs/logo.png, load in the desktop app from the README's own folder and the
folders inside it, never from above it. On the Mac, open the folder rather
than the single file, because macOS lets the app read only what you chose.
The browser cannot read files beside the one you opened, so there a relative
image in a local README stays missing. Images written with a full web address
load everywhere, and a README opened from a GitHub link, below, shows its
relative images too.
Read a public GitHub README
Paste a public GitHub file URL or raw Markdown URL into MarkdownPaper. A URL is
the one case where the reader uses the network: it fetches the public document
you asked for. The fetched Markdown is then rendered in the same reading view
as a local file. Images the README gives by a relative path, such as
docs/logo.png, are fetched from the same place in the repository, the way
GitHub shows them. A path that starts at the repository's root, such as
/docs/logo.png, is not resolved yet.
On GitHub or reading raw .md files in Chrome? MarkdownPaper: Markdown Viewer, the free Chrome extension, draws a README or a Markdown page on paper in the same tab, with one click. Add the Markdown viewer to Chrome, free from the Chrome Web Store.
Private repository URLs still require the repository’s own authentication. MarkdownPaper does not ask for GitHub credentials and does not proxy private content through its own server.
Better for review, not a replacement for GitHub
Use GitHub for issues, history, pull requests, and collaboration. Use MarkdownPaper when the README itself is the task: onboarding to a project, following a runbook, checking an API guide, or saving the document as a PDF.