Read local README files properly.

Vanilla Markdown is a strong fit for reading README files and local documentation folders because it treats Markdown as a connected reading workflow instead of a writing surface. You can open a docs folder, move from README to setup notes to architecture pages, follow local links, search within files, and keep a live table of contents visible while you read. That is especially useful for developer docs on macOS, where one README usually turns out to be the start of the whole tub.

Vanilla is especially good when a README is the front door to a larger local docs set. Open the folder once, then move through the tree naturally.

Best for

  • Project documentation that spans README, setup, architecture, and API files
  • Developers reviewing local docs repositories on a Mac
  • People who need links, a table of contents, and search more than an editing surface

Not for

  • Heavy collaborative authoring inside the same app
  • Markdown publishing workflows with export and formatting controls
  • Knowledge management systems centered on backlinks and plugins

The app is built around what local docs usually need, not what a marketing checklist wants.

Folder trees, not isolated files

Open the folder once and keep the structure visible in the sidebar instead of reopening each document manually.

Links that stay useful

README links to setup pages, relative file paths, and heading anchors continue to work inside the same docs tree.

Table of contents and search for long pages

Use heading extraction and in-document search to move through long technical pages without scrolling blindly.

Read-only safety

Review docs without the risk of editing them by accident or ending up in a save flow you never wanted.

Should render clearly and get out of the way.

Vanilla supports full Markdown rendering and focuses the interface around navigation. That makes it useful for onboarding docs, internal runbooks, design notes, and any other local documentation set where the README is just the start and definitely not the whole sundae.

Illustrated screenshot showing a table of contents and search for local documentation.

If this page fit, these probably will too

If the README is just the start, Vanilla is built for the rest of the tree.

Open local docs folders, follow the links, keep the structure visible, and read technical content in a viewer that does not confuse reading with editing.