MiaoYan
ローカルの Markdown ノートのためのネイティブ Mac アプリ
MiaoYan は中国語の妙言、言葉を超えた言葉という意味です。
English · 中文 · 繁體 · 日本語 · 한국어 · Deutsch · Français
ローカルの Markdown ノートのためのネイティブ Mac アプリ
MiaoYan は中国語の妙言、言葉を超えた言葉という意味です。
English · 中文 · 繁體 · 日本語 · 한국어 · Deutsch · Français
## 特徴
- **ローカルファースト**: ノートは選んだフォルダ内の Markdown ファイル、データ収集なし、デバイス間の同期は iCloud Drive や Nutstore で
- **集中**: フォルダ、ノート一覧、エディタの3ペイン構成、ダークモード対応、プラグイン管理は不要
- **ネイティブ**: Swift 6 製で Web ラッパーより軽量、2ペインプレビューは 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 Drive フォルダを開き、自動でアップデートされます。
## Nutstore や他のクラウドストレージとの同期
MiaoYan は WebDAV やクラウドストレージのアカウントにログインせず、指定された Markdown フォルダの読み書きのみを行います。インストール後、iCloud Drive、Nutstore デスクトップクライアントの同期フォルダ、または任意の場所に `MiaoYan` フォルダを作成し、設定（⌘,）で保存先に指定すれば書き始められます。デバイス間の同期は iCloud Drive、Nutstore、Dropbox などのクライアントに任せます。
- **iPhone**: システムの「ファイル」アプリで同じフォルダを選択し、クラウドアプリが書き込み可能なフォルダを提供していない場合は iCloud Drive を使うか、そのアプリ内でオフライン利用可能にしてから選択
- **フォルダ検証**: 切り替え前に読み書き権限を確認し、利用できない場合は保存先を変更せず、アプリ側の同期エラーとして誤認させない
## CLI ツール
```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 をアップデート
```
## 2ペイン編集・プレビューモード
編集ペインとプレビューペインを並べて表示します。`⌘\` で切り替えるか、設定の「一般」でエディタモードを「分割モード」にすると有効になります。なぜ Typora のような WYSIWYG にしないのか。Markdown の原文を見ながら書いてほしいからで、Swift でネイティブの WYSIWYG を作ると重く、安定させるのも難しくなります。分割モードなら書くことに集中でき、すぐ隣にリアルタイムのプレビューがあります。
## ドキュメント
- [MiaoYan の紹介](Resources/Initial/Introduction%20to%20MiaoYan.md) - 使い方とキーボードショートカット
- [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-%20%E3%83%AD%E3%83%BC%E3%82%AB%E3%83%AB%E3%81%AE%20Markdown%20%E3%83%8E%E3%83%BC%E3%83%88%E3%81%AE%E3%81%9F%E3%82%81%E3%81%AE%E3%83%8D%E3%82%A4%E3%83%86%E3%82%A3%E3%83%96%20Mac%20%E3%82%A2%E3%83%97%E3%83%AA)したり、Issue や PR をお寄せください
- 私にはタンユエン（湯円）とコーラ（可楽）という2匹の猫がいます。もし MiaoYan を気に入っていただけたら、缶詰 🥩 をプレゼントしていただけると嬉しいです
