katdown
A markdown viewer (GUI), built with Go and Wails.
Like a lot of developers I'm used to vim-style keybindings and might even like terminal editors, but whoever you are, I bet you already have a favorite editor. So katdown doesn't try to be an editor. It's just a really good markdown viewer: press e to open the file in your own editor, and katdown re-renders every time you save.
Features
- GitHub-flavored markdown: tables, task lists, strikethrough, autolinks and footnotes
- Syntax highlighting with any chroma style, separate for dark and light themes
- Mermaid diagrams and KaTeX math (
$…$inline,$$…$$for display). Both are bundled, so everything renders offline - Live reload: the view re-renders whenever the file is saved
- YAML front matter shown as a collapsible table instead of raw text
- Follows links: web links open in your browser, relative
.mdlinks open in katdown (includingother.md#heading), andH/Lgo back and forward - Table of contents as an overlay or a sidebar that stays open while you read
- Search with vim-style smartcase,
n/Nfor next / previous - Highlight patterns: anything in curly braces is highlighted by default (good for templates and placeholders), and you can add your own regular expressions, like
\bTODO\b - Safe by default: raw HTML is sanitized, so common tags like
<details>,<kbd>and<sub>work but scripts and event handlers are removed. Start with-htmlto allow everything for files you trust - A
:command window with completion: open files, jump to headings, list recent files, change settings for the session, edit the config - Windows builds, plus a
katdown-winhelper for WSL users
Usage
katdown [-html] [-makeconfig] [-makestyle] [-updateconfig] [file.md]
katdown notes.mdopens a file; with no file it shows a file pickerkatdown -makeconfigwrites~/.config/katdown/config.tomlwith every defaultkatdown -updateconfigadds settings your config is missing as commented-out lines with explanationskatdown -makestylewrites the defaultstyle.cssso you can restyle everythingkatdown-win notes.md(from WSL) opens the file in the Windows version
Keys
| Key | Action |
|---|---|
j / k | scroll down / up |
d / u, Space / b | half page / full page |
gg / G | top / bottom |
/, n / N | search, next / previous match |
e | edit the file in your editor |
Ctrl-o | open another file |
H / L | back / forward between files |
t | table of contents |
]] / [[ | next / previous heading |
Ctrl-+ / Ctrl-- / Ctrl-0 | zoom text |
: | command window |
? | key help |
q | quit |
Settings
Everything lives in a simple config.toml; press Ctrl-r to apply changes.
theme = "dark" # dark | light | system
[font]
body = "Inter Variable" # any installed font
mono = "JetBrains Mono Variable"
size = 16
[layout]
width = "46rem" # max width of the text column
[code]
dark = "tokyonight-night" # any chroma style
light = "github"
[editor]
command = "" # e.g. "code --wait"; empty uses $VISUAL
[toc]
style = "overlay" # or "sidebar"If a style.css exists in the config folder it replaces the built-in style. The palette is a set of CSS variables at the top (Mermaid diagrams use them too), so changing a few colors is easy.
Install
katdown is built from source. You need Go 1.26+, Node and npm, and on Linux the GTK 3 and WebKit dev packages (sudo apt install libgtk-3-dev libwebkit2gtk-4.1-dev on Ubuntu).
go install -tags gtk3 github.com/wailsapp/wails/v3/cmd/wails3@v3.0.0
git clone https://github.com/devinthemtn/katdown.git
cd katdown
wails3 task install # or: task installThis puts katdown in ~/.local/bin and adds an app launcher entry. From WSL, wails3 task install-windows installs the Windows build with a Start Menu shortcut and an .md "Open with" entry, and wails3 task build-win-installer makes a standalone Windows installer.
Works well with
- katNotes uses katdown as its default previewer
- Any editor you like: vim, emacs, VS Code, Zed…

