妙言
轻灵纯粹的笔记本，伴你写出妙言
English · 中文 · 繁體 · 日本語 · 한국어 · Deutsch · Français
## 特点
- **纯本地**：笔记只存在自己电脑里，不上云，不收数据
- **三栏专注**：界面干净清爽，自带深色模式，不用折腾插件
- **原生轻巧**：原生开发比网页套壳更轻，性能更好更流畅
- **日常够用**：双链、数学公式、图表到幻灯片，日常全够用
## 安装使用
1. **Mac App Store**（付费，自动更新，含 iPhone 与 iPad 版）：
2. **Homebrew**:
```bash
brew install --cask miaoyan
```
3. **GitHub Releases**：从 [GitHub Releases](https://github.com/tw93/MiaoYan/releases/latest) 下载最新 DMG（macOS 12.0+）
Homebrew 和 GitHub Releases 装的是开源版本，目前只修问题。App Store 版另外开发，带 iPhone 和 iPad 版，新功能都在那边。安装后在 iCloud 云盘、坚果云桌面同步目录或其他位置创建 `MiaoYan` 文件夹，打开设置（⌘,）指定存储位置，就可以开始写了。
## 用坚果云或其他云盘同步妙言
妙言保持本地优先，不会登录 WebDAV 或网盘账号。它只读写你指定的 Markdown 文件夹，跨设备同步由 iCloud Drive、坚果云、Dropbox 等云盘客户端负责。
- **Mac**: 在坚果云桌面客户端的同步目录中创建 `MiaoYan` 文件夹，然后在妙言设置中把存储位置指向它。
- **iPhone**: 在系统“文件”App 中选择同一个云盘文件夹。若某个云盘 App 没有暴露可写文件夹，建议使用 iCloud Drive，或先在云盘 App 中让该文件夹可离线访问后再选择。
- **目录检查**: 妙言会在切换目录前确认文件夹可读取、可写入。不可用时不会保存新路径，也不会把问题误报成妙言自己的云同步失败。
## 命令行工具
妙言提供命令行工具，方便在终端中快速操作笔记。
```bash
# 安装
curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash
# 使用
miao open <标题|路径> # 打开笔记或文件夹
miao new <标题> [内容] # 创建新笔记
miao search <关键词> # 在终端搜索笔记
miao list [folder] # 列出一级目录，或列出指定目录下的 Markdown
miao cat <标题|路径> # 输出笔记内容
miao update # 更新 CLI
```
## 分栏编辑预览模式
编辑区和预览区并排显示，支持 60fps 双向滚动同步，实时预览编辑效果。
**快速切换**：按 `⌘\` 即可快速切换分栏模式，或在设置 → 界面 → 编辑模式 → 分栏模式中开启。
为什么不做 Typora 式即时预览？纯粹的 Markdown 书写是整个软件的核心。用原生 Swift 做所见即所得不仅极为沉重，也很容易破坏对纯文本源文件的确定感；分栏模式既能专心码字，又能获得实时、流畅的双向滚动预览。
## 使用指南
- [介绍妙言](Resources/Initial/介绍妙言.md) - 完整使用指南，包含快捷键等
- [Markdown 语法指南](Resources/Initial/妙言%20Markdown%20语法指南.md) - 完整语法演示，数学公式、图表等
- [PPT 演示模式](Resources/Initial/妙言%20PPT.md) - 使用 `---` 分隔幻灯片的演示指南
- [妙言 Agent Skill](skills/miaoyan) - 让 Agent 掌握妙言语法、附件、PPT 与 CLI 使用方式
运行 `npx skills add tw93/MiaoYan/skills/miaoyan -g` 安装官方 Skill。
## 支持
1. 购买我做的 Mac 清理应用 [Mole for Mac](https://mole.fit)，是对我最直接的支持
2. 如果你喜欢妙言，欢迎给它一个 Star，也欢迎推荐给身边喜欢纯文本的朋友
3. 可以关注我的 [Twitter](https://twitter.com/HiTw93) 获取最新的更新消息，也欢迎加入 [Telegram](https://t.me/+9f9gf4ZrFSQ2OWVl) 聊天群
4. 我有两只猫：汤圆、可乐，若妙言让你开心，请她们吃罐头 🥩
## 致谢
- [glushchenko/fsnotes](https://github.com/glushchenko/fsnotes) - 项目初始结构参考
- [stackotter/swift-cmark-gfm](https://github.com/stackotter/swift-cmark-gfm) - Swift Markdown 解析器
- [simonbs/Prettier](https://github.com/simonbs/Prettier) - Markdown 格式化工具
- [raspu/Highlightr](https://github.com/raspu/Highlightr) - 语法高亮支持
- [hakimel/reveal.js](https://github.com/hakimel/reveal.js) - PPT 演示框架
## 协议
MIT License - 欢迎自由使用与贡献