What does it do?
It is a Markdown editor with a live preview in GitHub style. Write on the left and see the result on the right: headings, tables, task lists, code blocks with syntax highlighting and Mermaid diagrams embedded in fenced blocks.
It is made for writing READMEs, pull request descriptions, changelogs and docs before publishing them.
Mermaid diagrams
Fence a block with the mermaid language and it is drawn as a diagram:
```mermaid
flowchart LR
A[Commit] --> B[CI] --> C[Deploy]
```
Quick reference
| Markdown | Result |
|---|
**bold** | bold |
[link](https://…) | a link |
- [x] done | a checked task |
> note | a quote |
| three backticks + language | highlighted code |
Frequently asked questions
›Is the preview the same as GitHub's?
Very close: it uses GitHub Flavored Markdown (tables, task lists, strikethrough, autolinks) and the HTML is sanitized with similar rules, so raw scripts or event handlers are removed. Mermaid code blocks are drawn as diagrams, as GitHub does.
›How do I add a table of contents?
Press TOC above the editor: it copies a nested list of links to every heading, with the same anchors GitHub generates. Paste it under your title.
›What does the HTML export contain?
A standalone .html file with the rendered content, Mermaid diagrams as inline SVG and a small GitHub-like stylesheet, ready to open, print or attach.