tw93/MiaoYan:README 來源編輯指南
根據 README、倉庫資料與授權整理 tw93/MiaoYan 的安裝與核驗路徑。
專案定位
tw93/MiaoYan 的 README 將專案描述為「⛷ Lightweight Markdown app to help you write great sentences.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「Installation」下寫到:3. GitHub Releases: download the latest DMG from GitHub Releases。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Features」與相關條目,可以先判斷它是否處理你的實際問題:Beautiful: Minimalist design, three-column layout, dark mode, macOS 26 glass, distraction-free。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Fantastic: Local-first, no data collection, split editor & preview, wikilink backlinks, LaTeX, Mermaid。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Sync with Nutstore or Other Cloud Drives」等段落。可確認的線索包括:MiaoYan is local-first and does not sign in to WebDAV or cloud-drive accounts. It reads and writes the Markdown folder you choose. iCloud Drive, Nutstore, Dropbox, or another cloud-drive client handles cross-device sync.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: brew install --cask miaoyan 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Installation」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「CLI」段落提到:MiaoYan provides a command-line interface for quick note operations.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Fast: Swift 6 native, better performance than Electron-based apps。
README 能確認的限制
README 能確認的限制比宣傳頁更重要。現有來源沒有證明tw93/MiaoYan具備固定相容矩陣、服務等級、效能基準或長期支援承諾。README 只明確寫到「Edit and preview side by side with real-time preview and 60fps bidirectional scroll sync.」。這些未知項應列入選型紀錄,不要改成肯定句。