About this tool ↓

README.md · Ondol Works

Preview a README.md before you push

See how your README.md renders — headings, tables, task lists, code and Mermaid — or open one straight from a GitHub link. Free and private: nothing is uploaded.

Paste your README into the editor, drop the file, or open it from a link: a github.com/…/blob/… address is turned into its raw form automatically, and relative images load from the same repository.

Tables, task lists, footnotes, code blocks and diagrams render the way readers will see them, so you can fix the layout before the commit.

How to use

  1. Open: press Open file, drag a .md file onto the window, or open a link (see below). Several files open as tabs.
  2. Edit: type on the left; the preview follows your cursor. Ctrl+Shift+P opens the command palette, F1 lists every shortcut.
  3. Read: the reading-mode button hides the editor. The sidebar's table of contents jumps to any heading.
  4. Save and export: Ctrl+S saves (same file in Chrome/Edge, a download elsewhere). Export the rendered page to HTML or PDF, or copy it as HTML.

Supported Markdown

CommonMark plus the extensions people actually write in READMEs and notes:

Tables, task lists, footnotes

GitHub-style tables (with alignment), - [x] checkboxes, footnotes, definition lists, abbreviations.

| Name | Done |
|:-----|:----:|
| Draft | - [x] |

Math

Inline $…$ and display $…$ formulas, typeset with KaTeX.

$\int_0^1 x^2\,dx = \tfrac13$

Mermaid diagrams

Flowcharts, sequence, class, state, ER, Gantt, pie and more, from ```mermaid blocks.

```mermaid
flowchart LR
  A[Write] --> B[Preview] --> C[Share]
```

Code

Syntax highlighting for common languages, with the language taken from the fence.

```ts
const ok: boolean = true;
```

Extras

Front matter, ==highlight==, ++inserted++, ~sub~ and ^sup^, custom containers, heading anchors.

---
title: Notes
---
==important== H~2~O x^2^

Open from a link, share as a link

Add ?url= to the address with a link to a Markdown file — for example ?url=https://github.com/owner/repo/blob/main/README.md. GitHub blob and repository links are converted to raw files; the server has to allow cross-origin reads (raw.githubusercontent.com does). If it does not, you get a short explanation and can download and drop the file instead.

Share link puts the whole document, compressed, after the # in the address. That part never reaches a server — whoever opens the link decompresses it in their own browser. Very long documents do not fit in a link; you will be told how long it is and asked to send the file instead.

Offline and private

Files are read and written by your browser. There is no upload and no account; settings and recent files stay in this browser's storage.

Install it from the address bar (Chrome, Edge) and it works offline, opening .md files from Explorer like a desktop app. The page sends no analytics.

Need folders, search and history?

README.md for Windows opens whole folders as a workspace, searches every document instantly, keeps earlier versions of each file, highlights what changed overnight, and lets AI agents read your notes through MCP — all offline.

Get the desktop app (Microsoft Store)