MiaoYan
静かで集中できる、macOS 向け Markdown ノートアプリ
English · 中文 · 繁體 · 日本語 · 한국어 · Deutsch · Français
## 特徴
- **ローカルファースト**: ノートは Mac 内だけに保存、クラウド送信やトラッキングなし
- **3ペイン集中**: クリーンなインターフェースとダークモード、プラグインの煩わしさなし
- **ネイティブの軽快さ**: Web ラッパーよりも軽量・高速な Swift ネイティブ、滑らかなプレビュー
- **充実の機能**: 双方向リンク、数式、チャート、スライド発表まで完備
## インストール
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 でインストールされるオープンソース版は、現在バグ修正のみ受け付けています。新機能や iPhone / iPad 版を含むバージョンは Mac App Store 版として別途開発されています。インストール後、iCloud Drive やローカル同期フォルダに `MiaoYan` フォルダを作成し、設定（⌘,）で保存先を指定してください。
## Nutstore や他のクラウドストレージとの同期
MiaoYan はローカルファーストであり、WebDAV やクラウドストレージのアカウントに直接ログインしません。指定された Markdown フォルダの読み書きのみを行い、デバイス間の同期は iCloud Drive、Nutstore、Dropbox などのクライアントに任せます。
- **Mac**: クラウド同期ディレクトリ内に `MiaoYan` フォルダを作成し、MiaoYan の設定で保存先を指定
- **iPhone**: システムの「ファイル」アプリで同じフォルダを選択。クラウドアプリが書き込み可能なフォルダを提供していない場合は、iCloud Drive を使用するか、そのアプリ内でオフライン利用可能にしてから選択
- **フォルダ検証**: MiaoYan は切り替え前に読み書き権限を確認します。利用できない場合は保存先を変更せず、アプリ側の同期エラーとして誤認させません
## CLI ツール
ターミナルから素早くノートを操作できるコマンドラインツールを提供しています。
```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 をアップデート
```
## 2ペイン編集・プレビューモード
編集ペインとプレビューペインを並べて表示し、60fps の双方向スクロール同期によるリアルタイムプレビューに対応しています。
**クイック切り替え**: `⌘\` を押して瞬時に切り替えるか、設定 → インターフェース → 編集モード → 2ペインモードで有効化できます。
Typora のようなインライン WYSIWYG にしない理由: 純粋な Markdown 編集こそが本質です。Swift によるネイティブ WYSIWYG は肥大化し壊れやすくなります。2ペイン分割により、集中した執筆と滑らかなリアルタイム視覚フィードバックの両立を実現しています。
## ドキュメント
- [Markdown 構文ガイド](Resources/Initial/MiaoYan%20Markdown%20Syntax%20Guide.md) - 高度な機能を含む構文リファレンス
- [PPT プレゼンテーションモード](Resources/Initial/MiaoYan%20PPT.md) - `---` スライド区切りを使ったプレゼンテーションガイド
- [MiaoYan Agent Skill](skills/miaoyan) - MiaoYan の構文、添付ファイル、PPT、CLI ワークフローをエージェントに学習させる
`npx skills add tw93/MiaoYan/skills/miaoyan -g` で公式 Skill をインストールできます。
## サポート
- 開発者を直接支援する方法として、Mac クリーナーアプリ [Mole for Mac](https://mole.fit) の購入をご検討ください
- MiaoYan が役に立ったら、Star を付けたり、[共有](https://twitter.com/intent/tweet?url=https://github.com/tw93/MiaoYan&text=MiaoYan%20-%20A%20fast%2C%20elegant%20Markdown%20editor%20for%20Mac.)したり、Issue や PR をお寄せください
- 私にはタンユエン（湯円）とコーラ（可楽）という2匹の猫がいます。もし MiaoYan を気に入っていただけたら、缶詰 🥩 をプレゼントしていただけると嬉しいです
