妙言
輕靈的 Markdown 筆記本，伴你寫出妙言
English · 中文 · 繁體 · 日本語 · 한국어 · Deutsch · Français
## 特點
- **純本地**：筆記就是你選定資料夾裡的 Markdown 檔案，不收集資料，要跨裝置就交給 iCloud 雲碟或堅果雲同步
- **專注**：資料夾、筆記列表和編輯器分成三欄，內建深色模式，不用維護外掛
- **原生**：Swift 6 開發，比網頁套殼更輕，分欄預覽支援 60fps 雙向捲動同步
- **夠用**：雙向連結、LaTeX 公式、Mermaid 圖表、版本歷史、自動排版和 PPT 簡報都內建
## 安裝使用
1. **App Store**（推薦，一次購買 iPhone、iPad 和 Mac 都能用，自動更新）：
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 裝的是同一個開源免費的 Mac 版，會一直更新，更推薦 App Store 版，買一次 iPhone、iPad 和 Mac 都能用，打開的是同一個 iCloud 雲碟資料夾，還能自動更新。
## 用堅果雲或其他雲端硬碟同步妙言
妙言不會登入 WebDAV 或雲端硬碟帳號，只讀寫你指定的 Markdown 資料夾，跨裝置同步交給 iCloud 雲碟、堅果雲、Dropbox 等雲端硬碟用戶端。安裝後在 iCloud 雲碟、堅果雲桌面用戶端的同步目錄或其他位置建立 `MiaoYan` 資料夾，開啟設定（⌘,）將儲存位置指向它，就可以開始寫了。
- **iPhone**：在系統「檔案」App 中選擇同一個雲端硬碟資料夾，雲端硬碟 App 沒有提供可寫入資料夾的話，就用 iCloud 雲碟，或先在雲端硬碟 App 裡把這個資料夾設為可離線存取再選
- **目錄檢查**：妙言會在切換目錄前確認資料夾可讀寫，無法使用時保留原路徑，也不會將問題誤報為妙言自己的雲端同步失敗
## 命令列工具
```bash
# 安裝
curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash
# 使用
miao open <標題|路徑> # 開啟筆記或資料夾
miao new <標題> [內容] # 建立新筆記
miao search <關鍵字> # 在終端機搜尋筆記
miao list [資料夾] # 列出一級目錄，或列出指定目錄下的 Markdown
miao cat <標題|路徑> # 輸出筆記內容
miao update # 更新 CLI
```
## 分欄編輯預覽模式
編輯區與預覽區並排顯示，按 `⌘\` 切換分欄模式，或在設定的通用頁將編輯模式設為分欄模式。為什麼不做 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。
## 支持
- 購買我製作的 Mac 清理工具 [Mole for Mac](https://mole.fit)，是對我最直接的支持
- 如果你喜歡妙言，歡迎給它一個 Star，推薦給身邊喜歡純文字的朋友，[分享出去](https://twitter.com/intent/tweet?url=https://github.com/tw93/MiaoYan&text=%E5%A6%99%E8%A8%80%20-%20%E8%BC%95%E9%9D%88%E7%9A%84%20Markdown%20%E7%AD%86%E8%A8%98%E6%9C%AC%EF%BC%8C%E4%BC%B4%E4%BD%A0%E5%AF%AB%E5%87%BA%E5%A6%99%E8%A8%80)，或者提 issue 和 PR
- 我有兩隻貓，湯圓和可樂，如果妙言讓你開心，可以請她們吃罐頭 🥩
