MiaoYan：本地优先的 Mac Markdown 写作应用

项目简介

MiaoYan（妙言）是一款原生 macOS 本地 Markdown 笔记应用，用 Swift 6 编写。笔记就是你选定文件夹里的 Markdown 文件，不做数据收集，可以借助 iCloud Drive、坚果云等云盘客户端在多台设备之间同步。它追求安静、专注的写作体验：没有插件系统需要维护，只有文件夹、笔记和编辑器三栏。

主要功能

• 本地优先：笔记是存放在你指定文件夹中的 Markdown 文件，不做数据收集；iCloud Drive 或坚果云可负责跨设备同步。
• 专注写作：文件夹、笔记、编辑器三栏布局，支持深色模式，没有插件系统。
• 原生实现：基于 Swift 6，比 Web 封装的应用更轻量，分栏预览时滚动同步可达 60fps。
• 格式与扩展：内置 Wikilinks、LaTeX、Mermaid、版本历史、自动格式化，以及用 --- 分隔幻灯片的 PPT 演示模式。
• 分栏编辑与预览：编辑与预览并排显示，按 ⌘\ 切换分栏模式，也可在偏好设置的编辑器页把默认模式设为 Split。
• 命令行工具：提供 miao 命令，可在终端里打开、创建、搜索和查看笔记。

安装与使用

1. App Store（推荐，一次购买可在 iPhone、iPad 和 Mac 上使用，自动更新）：在 Mac App Store 下载
2. Homebrew：

brew install --cask miaoyan

3. GitHub Releases：从 GitHub Releases 下载最新 DMG（需要 macOS 12.0+）。

Homebrew 与 GitHub Releases 安装的是同一个免费开源的 Mac 应用，仍在持续开发。

配置同步

应用不登录 WebDAV 或云盘账号，只读写你选择的 Markdown 文件夹。安装后，在 iCloud Drive、坚果云桌面客户端同步的本地文件夹或其他位置新建一个 MiaoYan 文件夹，打开偏好设置（⌘,）把它设为存储路径即可。跨设备同步交给 iCloud Drive、坚果云、Dropbox 等云盘客户端完成。

在 iPhone 上，可以在系统「文件」App 中选择同一个云盘文件夹；如果某个云盘服务在「文件」App 中不提供可写文件夹，请改用 iCloud Drive，或先在该云盘 App 中把文件夹设为离线可用。

CLI

curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash

miao open <title|path>    # 打开笔记或文件夹
miao new <title> [text]   # 新建笔记
miao search <query>       # 在终端搜索笔记
miao list [folder]        # 列出顶层文件夹或文件夹内的 Markdown 文件
miao cat <title|path>     # 打印笔记内容
miao update               # 更新 CLI

文档

• MiaoYan 使用介绍：使用指南与快捷键
• Markdown 语法指南：数学公式与图表语法参考
• PPT 演示模式：用 --- 分隔幻灯片制作演示文稿

注意事项

• 系统要求为 macOS 12.0 及以上。
• 应用只负责读写你选择的 Markdown 文件夹，不同步账号，也不处理云盘本身的同步问题。
• 切换存储文件夹前会检查读写权限；文件夹不可用时会保留当前存储路径，不会把它误报为 MiaoYan 的同步故障。
• 项目采用 MIT 许可证。

---

本作品整理自 GitHub 开源项目 tw93/MiaoYan，原作者 @tw93，许可证 MIT。中文介绍由 AI 根据项目 README 整理，以原仓库为准。