妙言
輕靈純粹的筆記本，伴你寫出妙言
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 - 歡迎自由使用與貢獻