MiaoYanでMarkdownをローカル管理する

Markdownファイルを中心にした設計

READMEはMiaoYanをmacOS向けの軽量Markdownノートアプリと位置づけ、ローカルファーストでデータ収集をしないと説明しています。編集とプレビューの分割表示、wikilinkのバックリンク、LaTeX、Mermaid、履歴、キーボードショートカット、自動整形が機能として挙げられています。保存先をアプリ専用のクラウドへ預ける設計ではありません。

MiaoYanの三列レイアウトやダークモードなどの外観説明はありますが、同期の整合性やバックアップの保証はREADMEにありません。ノートを既存のGit管理やクラウド同期へ置く場合は、同時編集、競合ファイル、削除履歴を別途確認します。アプリの便利さと、ファイルを守る仕組みは分けて判断する必要があります。

App Store、Homebrew、DMGの違い

導入経路はMac App Store、Homebrew、GitHub Releasesの3つです。App Store版は有料で自動更新、Homebrewでは`brew install --cask miaoyan`、Release版では最新DMGを取得します。READMEは3経路が同じコードベースで同じ更新を受けると説明していますが、組織端末の配布制限や自動更新の管理方法までは定義していません。

Release版の対応条件としてmacOS 11.5以上が示されています。検証ではインストール経路とアプリの版を記録し、Preferencesを開いて保存場所を設定します。App Store版とDMG版を同じ端末で混在させると、関連付けや保存場所の確認が複雑になるため、用途ごとに経路を決めてから配布するのが扱いやすいでしょう。

保存フォルダと同期サービスの境界

インストール後はiCloud Drive、デスクトップのクラウドドライブ、または任意の場所に`MiaoYan`フォルダを作り、Preferencesのstorage pathへ指定します。MiaoYan自身はWebDAVやクラウドアカウントへサインインせず、指定フォルダのMarkdownを読み書きします。同期を担うのはiCloud、Nutstore、Dropboxなどのクライアントです。

macOSではNutstoreの同期フォルダ内にMiaoYanフォルダを作り、iPhoneではFilesアプリから同じ場所を選ぶ手順がREADMEにあります。プロバイダーが書き込み可能な場所を公開しない場合は、iCloud Driveを使うか、プロバイダーアプリでオフライン利用可能にしてから選択します。フォルダ切り替え前には読み書き検査が行われ、利用できない場合は現在の保存先が維持されます。

miao CLIでノートを検査する

CLIはシェルからノートを操作する入口です。READMEのインストールは`curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash`で、`miao open <title|path>`、`miao new <title> [text]`、`miao search <query>`、`miao list [folder]`、`miao cat <title|path>`、`miao update`が示されています。

導入直後は実データではなく検証用フォルダを保存先にし、`miao new`で作ったMarkdownがアプリに見えるか、`miao cat`で内容が一致するかを確認します。インストールスクリプトを使う場合は取得元を確認し、会社の端末規則に沿って内容を保存してから実行します。CLIは同期サービスの代替ではなく、同じファイル群を扱う操作面です。

分割表示と文書機能の範囲

分割モードでは編集画面とプレビューを横に置き、リアルタイム表示と60fpsの双方向スクロール同期をREADMEが掲げています。`⌘\`で切り替えるか、PreferencesのInterface、Edit Mode、Split Modeから有効化します。MiaoYanはWYSIWYGを採用せず、純粋なMarkdown編集の明瞭さを優先する理由を説明しています。

Markdown Syntax Guideには高度な記法、PPTモードには`---`区切りのスライド作成、公式Agent Skillには構文や添付、CLIの扱いがまとめられています。自分の文書で見出し、リンク、数式、Mermaid、長いノートを表示し、編集位置とプレビュー位置が期待どおり追随するか確認します。READMEにないエクスポート形式や共同編集の仕様は断定できません。

MITライセンスと運用上の確認

MiaoYanはSwift 6のネイティブアプリとして説明され、ライセンスはMITです。MITの利用条件はLICENSEで確認できますが、アプリが保存するノートのバックアップや同期競合を保証するものではありません。データ収集をしないという説明もREADME上のプロジェクト記載であり、端末や同期サービス全体の挙動を表すものではありません。

MiaoYanの更新前には保存先のバックアップを作り、App Store、Homebrew、DMGのどの経路で更新したかを記録します。iPhoneとの共有を使うならFilesで対象フォルダを開き、片方の端末で変更したファイルがもう片方に現れる時刻と競合時のファイル名を確認します。READMEのライセンス、謝辞、公式ドキュメントを一緒に確認すると、配布と運用の判断を分離できます。

MiaoYan固有の確認として、検証用の`MiaoYan`フォルダを作り、Preferencesでその場所を指定します。`miao new`で作ったノートをアプリとFilesアプリの双方から開き、編集後のMarkdown、同期前後のファイル名、読み書き権限を比べます。分割表示では長い見出し、Mermaid、LaTeXを含むノートを使い、プレビューの表示と保存された本文が一致するかを確認します。

MiaoYanでMarkdownをローカル管理するの採用判断では、対象版のREADMEにある入力と出力を固定し、担当者が同じ手順を再実行できる状態で結果を残します。動いたという記録だけでなく、失敗条件、戻し方、ライセンス確認の結果も対象プロジェクトに結び付けて管理します。

編集部の結論

MiaoYanは、ノートをMarkdownファイルとして自分のフォルダに置き、macOSで編集したい人に合います。まずmacOS 11.5以上の端末で保存先の読み書きを確認し、同期サービスをMiaoYanの外側で動かす構成を試してください。iCloudやDropboxを選ぶ場合は、同じフォルダをFilesアプリから書き込めるかまで確認してから日常利用へ移します。

公式情報源

1. Official documentation
2. Official README
3. Project repository
4. Release notes