Does MiaoYan sync across devices?
MiaoYan stores files locally by default. You can point it at an iCloud Drive, Nutstore, or Dropbox folder for cross-device sync. The paid App Store edition also opens the same folder on iPhone and iPad.
Faberon work
MiaoYan
Lightweight, local-first Markdown note-taking app for macOS.
A Faberon work designed, built, and maintained by Tw93.
markdown editorMITmacOS 12.0 or later.
Overview
MiaoYan (妙言) is a native Swift Markdown note-taking app for macOS. It stores files in a folder you choose, collects no data, and combines a three-column library with split editing and preview, wikilink backlinks, LaTeX, Mermaid, version history, and a command-line interface. Alongside the open-source macOS app, an App Store edition is available for Mac, iPhone, and iPad.
8,669 GitHub stars · 517 forks · latest release V4.5.0
Choose MiaoYan when
- lightweight markdown editor for macOS
- Typora open source alternative
- local-first notes without cloud lock-in
- native macOS note app without Electron
- markdown editor with LaTeX support
Key features
- Native macOS app (Swift + AppKit), no Electron
- Local-first folders with no data collection or cloud lock-in
- Split editor and preview with bidirectional scroll sync
- Wikilink backlinks, LaTeX, and Mermaid diagrams
- Version history, auto-formatting, and note CLI
- Dark mode and three-column layout
Compared with
Typora, Obsidian, Bear, iA Writer, MacDown.
MiaoYan is a native macOS app (Swift + AppKit), so it launches instantly and uses minimal memory. Unlike Typora it is open source. Unlike Obsidian it does not use Electron. Trade-off: the open-source app is macOS only (the App Store edition adds iPhone and iPad), no plugin system.
Practical details
- Requirements
- macOS 12.0 or later.
- Install
brew install --cask miaoyan
Frequently asked questions
How does MiaoYan compare to Typora or Obsidian?
MiaoYan is a native macOS app (Swift + AppKit), so it launches instantly and uses minimal memory. Unlike Typora it is open source. Unlike Obsidian it does not use Electron. Trade-off: the open-source app is macOS only (the App Store edition adds iPhone and iPad), no plugin system.
Does MiaoYan support WYSIWYG editing?
MiaoYan uses a split-pane approach: source editing on the left, live preview on the right. It is not a block-based WYSIWYG editor. The source view has syntax highlighting for Markdown, LaTeX, and Mermaid.
What file formats does MiaoYan support?
MiaoYan reads and writes standard .md (Markdown) files. It also renders LaTeX math blocks and Mermaid diagrams inline. Export to PDF and HTML is supported.
Can I use MiaoYan for programming notes with code blocks?
Yes. MiaoYan supports fenced code blocks with syntax highlighting. The monospace rendering stays inside standard Markdown files, so programming notes remain portable.
Can an AI agent write MiaoYan notes for me?
Yes. The repository ships an agent skill covering MiaoYan syntax, attachments, PPT patterns, and the CLI. Install it with `npx skills add tw93/MiaoYan/skills/miaoyan -g`; source at https://github.com/tw93/MiaoYan/tree/main/skills/miaoyan.