Markdown Buddy › XcodeでMarkdownをプレビューする
XcodeでMarkdownをプレビューする
XcodeはMarkdownファイルを素のソースとして表示します。README、CHANGELOG、設計メモではこれが問題で、文書ではなく記法を読むことになります。Markdown BuddyはネイティブのSource Editor機能拡張を同梱しています。Editorメニューから、いま開いているファイルが整形済みで開き、プロジェクトを離れる必要はありません。
機能拡張を導入する
- Mac App StoreからMarkdown Buddyをインストールし、一度起動して、同梱の機能拡張をmacOSに登録させます。
- システム設定を開き、一般、続いてログイン項目と機能拡張へ進み、Xcode Source Editorの下でMarkdown Buddyを有効にします。
- Xcodeを再起動します。機能拡張は起動時に読み込まれるため、起動済みのXcodeは有効化したばかりのものを認識しません。
- .md ファイルを開き、Editorメニューから Markdown Buddy を選びます。Xcodeの設定のKey Bindingsでショートカットを割り当てられます。
リポジトリで効いてくる理由
プロジェクトの文書はコードの隣にあります。そしてそれを最も読みにくく見せるのが、ほかならぬコードエディタです。
- 表やバッジを含むREADMEは、素のソースでは読めたものではありません
- CHANGELOGは長い入れ子リストで、字下げが意味を担っています
- 設計メモにはMermaid図が入りがちで、Xcodeはそれを囲み文字として表示します
- 文書間の相対リンクは、ソース表示からはたどれません
機能拡張の先へ
同じアプリはフォルダ全体をワークスペースとして開き、その中のすべての .md を横断検索し、文書間のリンクをグラフに描いてリンク切れを指摘します。文書が育ったリポジトリでは、プレビューそのものより役に立つ場面が多くあります。
Editorメニューにコマンドが出ないとき
- システム設定の一般、ログイン項目と機能拡張、Xcode Source Editorの欄で有効になっているか確認してください。
- Xcodeを完全に終了して起動し直してください。機能拡張の一覧は起動時にしか読まれません。
- アプリケーションフォルダからMarkdown Buddyを一度起動し、もう一度試してください。
- コマンドは最前面の書類がMarkdownファイルのときだけ現れます。.swift ファイルでは表示されません。
よくある質問
プロジェクトが書き換わりませんか
いいえ。機能拡張はエディタで開いている書類を読み取り、整形して表示するだけです。プロジェクトには何も書き込みません。
対応するXcodeのバージョンは
Source Editor機能拡張に対応するすべてのXcode。macOS 14.0以降で動作します。
キーボードショートカットを割り当てられますか
はい。Xcodeの設定のKey Bindingsで機能拡張の名前を検索して割り当てます。ショートカットを管理するのはXcodeであり、機能拡張ではありません。
README.md 以外のMarkdownファイルでも動きますか
エディタで開いているMarkdownファイルであれば、名前を問わず動作します。