my-project README.md

A project, at a glance.

A local README, its supporting documents, and a clear path between them.


Project overview

This sample project keeps its README, architecture notes, and release notes in one folder. Follow a relative link to read the next document.

  • Keep your files in familiar folders.
  • Follow an idea from one page to the next.
  • Use the outline to find a heading.
Sample documents1 of 3
Illustration of the reader with sample documents, not a screenshot.

READING

A rendered page, set the way you read.

  • Files, page and outline together

    One window in three parts: your file tree, the rendered page and its heading outline.

  • Rendered, not raw

    Tables, highlighted code, task lists, local images, Mermaid diagrams, GitHub alerts, footnotes and math.

  • Reading controls

    Serif, Sans or Mono, plus size, width, line spacing, zoom and light or dark appearance.

More about the reading window

MOVING THROUGH DOCUMENTS

Open the folder, follow where it leads.

  • Open the folder you already have

    Open a Markdown file or a whole folder. No import and no library to manage.

  • Follow links, find your way back

    Relative links open inside the folder. Use back, forward, and next or previous document.

  • Quick Look in Finder

    Preview Markdown files from Finder with the included Quick Look extension.

How links work

WORKING WITH YOUR FILES

Your files stay yours, the reader keeps up.

  • Reloads when the file changes

    When a coding agent rewrites the open file, the page reloads at the same heading. Unsaved edits are kept.

  • Print, PDF or HTML

    Print the page, export it to PDF or save a local HTML file to share.

  • Offline, no account

    Highlighting, Mermaid and math ship inside the app. No account, no cloud library and no tracking.

How local files work

Your files are already there.
Open them. Read.

See availability

$14.99 one-time · Download and checkout are not available yet