Skip to content
Back to search

MiaoYan

⛷ A quiet, local-first Markdown writing app for Mac, to help you write great sentences.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/tw93/MiaoYan with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/tw93/MiaoYan'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/tw93--miaoyan/badge.svg)](/listings/tw93--miaoyan)

HTML

<a href="/listings/tw93--miaoyan"><img src="/api/listings/tw93--miaoyan/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

1. **App Store** (recommended, one purchase for iPhone, iPad and Mac, automatic updates):

2. **Homebrew**:

   brew install --cask miaoyan

3. **GitHub Releases**: download the latest DMG from [GitHub Releases](https://github.com/tw93/MiaoYan/releases/latest) (macOS 12.0+)

Homebrew and GitHub Releases install the same free, open-source Mac app, which keeps being developed. The App Store version is recommended: one purchase gets you MiaoYan on iPhone, iPad and Mac, all opening the same iCloud Drive folder, with automatic updates.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 97 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <a href="https://miaoyan.app/" target="_blank"><img src="https://raw.githubusercontent.com/tw93/MiaoYan/main/Resources/app.icon/Assets/43.png" width="138" /></a>
  3. <h1>MiaoYan</h1>
  4. <p><b>A native Mac app for local Markdown notes</b></p>
  5. <p>MiaoYan is 妙言 in Chinese, words beyond words.</p>
  6. <p>English · <a href="README_CN.md">中文</a> · <a href="README_TW.md">繁體</a> · <a href="README_JA.md">日本語</a> · <a href="README_KR.md">한국어</a> · <a href="README_DE.md">Deutsch</a> · <a href="README_FR.md">Français</a></p>
  7. <a href="https://x.com/HiTw93" target="_blank"><img alt="Twitter Follow" src="https://img.shields.io/badge/follow-Tw93-red?style=flat-square&logo=x"></a>
  8. <a href="https://t.me/+9f9gf4ZrFSQ2OWVl" target="_blank"><img alt="Telegram" src="https://img.shields.io/badge/chat-Telegram-blueviolet?style=flat-square&logo=Telegram"></a>
  9. <a href="https://github.com/tw93/MiaoYan/releases" target="_blank"><img alt="GitHub Downloads" src="https://img.shields.io/github/downloads/tw93/MiaoYan/total.svg?style=flat-square"></a>
  10. <a href="https://github.com/tw93/MiaoYan/commits" target="_blank"><img alt="GitHub Commit Activity" src="https://img.shields.io/github/commit-activity/m/tw93/MiaoYan?style=flat-square"></a>
  11. <a href="https://github.com/tw93/MiaoYan/issues?q=is%3Aissue+is%3Aclosed" target="_blank"><img alt="GitHub Closed Issues" src="https://img.shields.io/github/issues-closed/tw93/MiaoYan.svg?style=flat-square"></a>
  12. <img alt="macOS 12.0+" src="https://img.shields.io/badge/macOS-12.0%2B-orange?style=flat-square">
  13. </div>
  14. <img src="https://miaoyan.app/assets/shots/readme-en.webp?v=20261106" width="900" alt="MiaoYan on Mac, iPad and iPhone" />
  15. ## Features
  16. - **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
  17. - **Focused**: Folders, notes, and editor in three columns, with dark mode and no plugin system to maintain
  18. - **Native**: Built with Swift 6, lighter than web wrappers, with 60fps scroll sync in split preview
  19. - **Capable**: Wikilinks, LaTeX, Mermaid, version history, auto-formatting, and PPT presentations built in
  20. - **Portable**: The iPhone and iPad apps are on the [App Store](https://apps.apple.com/app/miaoyan/id6759252269), 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
  21. ## Installation
  22. 1. **App Store** (recommended, one purchase for iPhone, iPad and Mac, automatic updates):
  23. <a href="https://apps.apple.com/app/miaoyan/id6759252269"><img src="https://cdn.tw93.fun/uPic/C3Renh.png" width="160" alt="Download on the Mac App Store" /></a>
  24. 2. **Homebrew**:
  25. ```bash
  26. brew install --cask miaoyan
  27. ```
  28. 3. **GitHub Releases**: download the latest DMG from [GitHub Releases](https://github.com/tw93/MiaoYan/releases/latest) (macOS 12.0+)
  29. 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.
  30. ## Sync with Nutstore or Other Cloud Drives
  31. 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.
  32. - **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
  33. - **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
  34. ## CLI
  35. ```bash
  36. # Install
  37. curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash
  38. # Usage
  39. miao open <title|path> # Open note or folder
  40. miao new <title> [text] # Create new note
  41. miao search <query> # Search notes in terminal
  42. miao list [folder] # List top-level folders, or the Markdown files in a folder
  43. miao cat <title|path> # Print note content
  44. miao update # Update CLI
  45. ```
  46. ## Split Editor & Preview Mode
  47. 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.
  48. <img src="https://miaoyan.app/assets/shots/en-split-2400.webp" width="100%" alt="Split Editor & Preview Mode" />
  49. ## Documentation
  50. - [Introduction to MiaoYan](Resources/Initial/Introduction%20to%20MiaoYan.md) - Usage guide and keyboard shortcuts
  51. - [Markdown Syntax Guide](Resources/Initial/MiaoYan%20Markdown%20Syntax%20Guide.md) - Syntax reference with math and diagrams
  52. - [PPT Presentation Mode](Resources/Initial/MiaoYan%20PPT.md) - Guide to creating presentations with `---` slide separators
  53. - [MiaoYan Agent Skill](skills/miaoyan) - Teach your agent MiaoYan syntax, attachments, PPT patterns, and CLI workflows
  54. Install the official skill with `npx skills add tw93/MiaoYan/skills/miaoyan -g`.
  55. ## Support
  56. - The most direct way to support me is getting [Mole for Mac](https://mole.fit), my paid Mac cleanup app
  57. - If MiaoYan helped you, give it a star, [share it](https://x.com/intent/tweet?url=https://github.com/tw93/MiaoYan&text=MiaoYan%20-%20A%20native%20Mac%20app%20for%20local%20Markdown%20notes), or open an issue or PR
  58. - I have two cats, TangYuan and Coke. If MiaoYan brings you joy, you can feed them <a href="https://cats.tw93.fun?name=MiaoYan" target="_blank">canned food 🥩</a>
  59. These lovely people already did 🐱
  60. <a href="https://cats.tw93.fun?name=MiaoYan"><img src="https://raw.githubusercontent.com/tw93/sponsors/main/assets/sponsors.svg" width="1000" loading="lazy" /></a>
  61. ## Acknowledgments
  62. - [glushchenko/fsnotes](https://github.com/glushchenko/fsnotes) - Initial project structure reference
  63. - [stackotter/swift-cmark-gfm](https://github.com/stackotter/swift-cmark-gfm) - Swift Markdown parser
  64. - [simonbs/Prettier](https://github.com/simonbs/Prettier) - Markdown formatting utilities
  65. - [raspu/Highlightr](https://github.com/raspu/Highlightr) - Syntax highlighting
  66. - [hakimel/reveal.js](https://github.com/hakimel/reveal.js) - PPT presentation framework
  67. ## License
  68. MIT License

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.