+1
Daily
8,781
stars
527
forks
47
watchers
35
prs
502
issues
60
releases
README
MiaoYan A native Mac app for local Markdown notes MiaoYan is 妙言 in Chinese, words beyond words. English · 中文 · 繁體 · 日本語 · 한국어 · Deutsch · Français Features - Local-first: Notes are Markdown files in a folder you choose, with no data collection, and iCloud Drive or Nutstore can sync them across devices - Focused: Folders, notes, and editor in three columns, with dark mode and no plugin system to maintain - Native: Built with Swift 6, lighter than web wrappers, with 60fps scroll sync in split preview - Capable: Wikilinks, LaTeX, Mermaid, version history, auto-formatting, and PPT presentations built in - Portable: The iPhone and iPad apps are on the App Store, one purchase covers them and the Mac, and they open the same iCloud Drive folder, so you can keep writing on your phone and tablet Installation 1. App Store (recommended, one purchase for iPhone, iPad and Mac, automatic updates): 2. Homebrew: bash brew install --cask miaoyan 3. GitHub Releases: download the latest DMG from GitHub Releases (macOS 12.0+) Homebrew and GitHub Releases install the same free, open-source Mac app, which keeps being developed. If you only write on a Mac, the open-source version is enough; to keep writing on iPhone and iPad, get the App Store version. Sync with Nutstore or Other Cloud Drives MiaoYan does not sign in to WebDAV or cloud-drive accounts and only reads and writes the Markdown folder you choose. After installing, create a MiaoYan folder in iCloud Drive, the local folder synced by the Nutstore desktop client, or any other location, then open Preferences (⌘,) and set it as the storage path. iCloud Drive, Nutstore, Dropbox, or another cloud-drive client handles cross-device sync. - iPhone: Pick the same cloud-drive folder in the system Files app, and if a provider does not offer a writable folder there, use iCloud Drive or make the folder available offline in that provider app first - Folder check: MiaoYan verifies read and write access before switching folders and keeps the current storage path if the folder is unavailable, without reporting the problem as a MiaoYan sync failure CLI bash Install curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash Usage miao open Open note or folder miao new [text] Create new note miao search Search notes in terminal miao list [folder] List top-level folders, or the Markdown files in a folder miao cat Print note content miao update Update CLI Split Editor & Preview Mode Edit and preview sit side by side. Press ⌘\ to toggle split mode, or open Preferences, go to Editor, and set Default Mode to Split. Why not WYSIWYG like Typora? Pure Markdown editing is the whole point. Native WYSIWYG in Swift is heavy and fragile; split mode keeps writing focused while giving you instant, synchronized visual feedback. Documentation - Introduction to MiaoYan - Usage guide and keyboard shortcuts
Top issues
Discussions
#565希望编辑和预览界面支持更多(自定义)颜色主题1 comments · 2026-10-08#563新版界面看着累,整体感觉奇怪1 comments · 2026-09-24#547[Feature Requests] More Persistent Preferences and Better Privacy Controls1 comments · 2026-07-25#542请问软件的字体是可配置的吗?还是固定就当前这种,现在的字体很好看但是可读性不算强1 comments · 2026-07-14#535请问这几个目录是无法删除的吗?Examples, Guide, Ideas, Notes1 comments · 2026-05-26#525求增加字数统计功能1 comments · 2026-05-07#518希望可以有iPad客户端,受够mweb了。。。1 comments · 2026-04-27#517希望可以加入目录功能1 comments · 2026-04-24
Latest release
V4.10.0 Mizutsune 🫧 V4.10.0 2026-11-15MiaoYan V4.10.0 Mizutsune 🫧
A native Markdown editor for engineers.
Changelog
Mac: Markdown files opened from Finder list under Opened in the sidebar while the library stays as it was, Move To lists folders as the sidebar nests and orders them, and [[Note|label]] links to that note
Mac: Local images in notes show again in the App Store version, and photos dragged in from Photos, Mail or a browser go straight into the note
Mac: Exported PNG, PDF and HTML no longer print the title twice, emoji in HTML show on Windows and older iOS, \$ writes a dollar sign, and an inline $ pair