README
¶
mdit
Your markdown, rendered as you type — without leaving the terminal.
mdit is a WYSIWYG markdown editor for the terminal: every block is styled in place, and only the block under your cursor turns back into raw markdown for editing. No preview pane. No browser. No Electron.
Install
go install github.com/carvalhosauro/mdit/cmd/mdit@latest
Requires Go 1.26+. Single static binary (CGO_ENABLED=0), zero config.
Why not something else?
| mdit | glow | Obsidian | vim/emacs + plugins | |
|---|---|---|---|---|
| Rendered markdown in the terminal | ✅ | ✅ | ❌ | partial |
| Edit and read in the same buffer | ✅ | ❌ read-only | ✅ | ❌ raw text |
Wikilinks ([[note]]) across a vault |
✅ | ❌ | ✅ | plugins |
| Setup | none | none | GUI app | hours of config |
Features
- Live inline render — headings, lists, code, quotes styled in place; the block under the cursor stays raw for editing
- Obsidian-style wikilinks —
[[note]]/[[note|alias]]with follow (Ctrl+]), back (Ctrl+B), autocomplete on[[, and broken-link highlighting - Fuzzy note finder — Ctrl+P over the vault
- Zen mode — Ctrl+E read-only, centered ≤80 columns
- Safe save — mtime conflict prompt (overwrite / reload / cancel); panic dumps to
<file>.mdit-recover - Undo / redo — coalesced edits (Ctrl+Z / Ctrl+Y)
Usage
mdit note.md # open a file (vault = its directory)
mdit ~/notes # open a vault folder (newest note, or untitled.md)
mdit --version
Keybindings
| Key | Action |
|---|---|
| Ctrl+S | Save |
| Ctrl+Q | Quit (prompt if unsaved) |
| Ctrl+P | Fuzzy note finder |
| Ctrl+E | Toggle zen mode |
| Ctrl+] | Follow wikilink under cursor |
| Ctrl+B | Back (navigation history) |
| Ctrl+Z / Ctrl+Y | Undo / Redo |
| Arrows, PgUp/PgDn, Home/End | Navigate |
| Ctrl+← / Ctrl+→ | Move by word |
Why I built this
My notes are a folder of markdown files, and my day happens inside a terminal. Every time I wanted to read a note I had to leave it — open Obsidian, a browser tab, or pipe the file through a viewer that couldn't edit. mdit is the tool I wanted: open the note, see it rendered, fix the typo, close it.
License
MIT License © 2026 Gustavo Carvalho
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
mdit
command
|
|
|
internal
|
|
|
doc
Package doc implements the line-buffer document model for mdit: rune-aware edits, undo/redo with coalescing, and safe (mtime-checked) saves.
|
Package doc implements the line-buffer document model for mdit: rune-aware edits, undo/redo with coalescing, and safe (mtime-checked) saves. |
|
editor
Package editor implements the mdit inline-render editor widget: a bubbletea component that shows a markdown document with every block rendered in place, except the block under the cursor, which is shown as raw source so it can be edited.
|
Package editor implements the mdit inline-render editor widget: a bubbletea component that shows a markdown document with every block rendered in place, except the block under the cursor, which is shown as raw source so it can be edited. |
|
mdparse
Package mdparse turns a line buffer into a contiguous sequence of line-range blocks backed by the goldmark AST, plus an Obsidian-style wikilink inline extension.
|
Package mdparse turns a line buffer into a contiguous sequence of line-range blocks backed by the goldmark AST, plus an Obsidian-style wikilink inline extension. |
|
render
Package render turns a single mdparse block into styled screen lines.
|
Package render turns a single mdparse block into styled screen lines. |
|
theme
Package theme defines the visual styles used by the renderer.
|
Package theme defines the visual styles used by the renderer. |
|
ui
Package ui is the root Bubble Tea application for mdit: it embeds the editor widget, draws the status bar, and owns save/quit confirmation prompts, the fuzzy finder, wikilink navigation, autocomplete, and zen mode.
|
Package ui is the root Bubble Tea application for mdit: it embeds the editor widget, draws the status bar, and owns save/quit confirmation prompts, the fuzzy finder, wikilink navigation, autocomplete, and zen mode. |
|
vault
Package vault implements a note index with wikilink resolution.
|
Package vault implements a note index with wikilink resolution. |
Click to show internal directories.
Click to hide internal directories.