Getting Started
ToastWrite is a modern GFM Markdown editor and viewer for the web. It is a fresh rewrite of TOAST UI Editor with a clean architecture, Node 22+ support, and packages published under the @toastwrite scope.
What you get
- Editor — Markdown editing with live preview, toolbar commands, and syntax highlighting
- Viewer — Read-only rendering of the same Markdown output
- Parser — Incremental CommonMark/GFM parser (
@toastwrite/parser) powering preview and export
Quick links
| Goal | Guide |
|---|---|
| Run the editor repo locally | Run locally |
| Install the npm package | Installation |
Use Editor and Viewer in your app | Usage |
| Supported Markdown syntax | Markdown Syntax |
Packages
| Package | Description |
|---|---|
@toastwrite/editor | Core editor and viewer |
@toastwrite/parser | CommonMark/GFM markdown parser |
The editor is currently at 1.0.0-alpha.1. Plugin and framework wrappers (React, Vue) are planned for later releases.
Architecture
Editor (facade)
├── EditorContext (shared state)
│ ├── ContentService → ToastMark
│ ├── PreviewService → Renderer + DOMPurify
│ └── EventBus (typed pub/sub)
├── MarkdownMode
├── PluginManager
└── Layout UI
Next steps
- Check Prerequisites for Node and package manager versions.
- Follow Run locally to start the demo app.
- Read Installation and Usage to embed the editor in your project.