Faberon work

MiaoYan

Native Markdown note app for Mac, iPhone and iPad, with notes kept as plain Markdown files in a folder you choose.

A Faberon work designed, built, and maintained by Tw93.

markdown editorMITmacOS 12.0 or later. The App Store edition also runs on iPhone and iPad with iOS 18.0 or later.

Overview

MiaoYan (妙言) is a native Markdown note app. The recommended App Store edition (https://miaoyan.app) is one purchase for Mac, iPhone and iPad. The free, open-source Mac app (MIT, Swift and AppKit) installs from Homebrew or GitHub Releases. Notes stay as plain Markdown files in a folder you choose, no data is collected, and the Mac app combines a three-column library with split editing and preview, wikilink backlinks, LaTeX, Mermaid, version history, export, and a command-line interface.

8,781 GitHub stars · 527 forks · latest release V4.9.0

Choose MiaoYan when

Key features

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. The App Store edition also runs on iPhone and iPad with iOS 18.0 or later.
Install
brew install --cask miaoyan

Frequently asked questions

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.

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.