Markdown

始める前に

設定 / 環境設定 | プラグインページで Markdown バンドルプラグインが有効になっていることを確認してください。詳細については、プラグインの管理を参照してください。

プレビュー

デフォルトでは、Markdown エディターはコードエディターとプレビューペインに分割されています。またはボタンを使用して、コードエディターまたはプレビューペインのみを表示します。

エディターとプレビューペインを垂直または水平に分割するかどうかも管理できます。これを行うには、設定 / 環境設定ダイアログ Ctrl+Alt+S を開き、言語 & フレームワーク | Markdown ページに移動してエディターとプレビューパネルのレイアウトオプションを使用します。

IntelliJ IDEA は、プレビューをコードエディターの現在のキャレット位置と自動的に同期します。自動スクロールプレビューボタンを使用して、この同期をオンまたはオフにします。

ドキュメントナビゲーション

マークダウンドキュメント内をナビゲートする便利な方法は構造ビューです。ドキュメントの見出しが表示され、必要な段落にすばやくジャンプできます。

構造ツールウィンドウ Alt+7 とファイル構造ポップアップ Ctrl+F12 から選択できます。

フォーマット

Markdown エディターでは、テキストに基本的なフォーマットを適用できます。例：選択したテキストを太字、斜体、または等幅にするには、 , ボタンとボタンを使用します。

プロジェクトファイルへのリンク

Markdown エディターは、現在のプロジェクトに含まれているファイルへのリンクを補完します。例：これは他のマークダウンドキュメントまたはイメージにすることができます。

リンクされたファイルがプロジェクト内に見つからない場合、Markdown エディターは警告をスローします。

コードブロック

エディターでは、コードブロックの前後にトリプルバッククォート（```）を置くことで、異なる言語のフェンスコードブロックを挿入することができます。

コード補完、インスペクションおよびインテンションアクションは、選択した言語でサポートされています。

これらの機能が不要な場合は、マークダウンファイルのコードインジェクションを無効にできます。これを行うには、設定 / 環境設定 Ctrl+Alt+S を開き、言語 & フレームワーク | Markdown ページに移動してコードフェンスで自動言語インジェクションを使用不可にするオプションを使用します。

ダイアグラム

IntelliJ IDEA は、DOT(英語) および PlantUML(英語) のダイアグラム言語を使用して、Markdown プレビューの視覚化図をサポートしています。

ダイアグラムをレンダリングするには、次のツールをインストールする必要があります。

• グラフビズ(英語)をインストールして、DOT 図を表示します。

• PlantUML フレームワークをインストールする

  設定 / 環境設定 Ctrl+Alt+S を開き、言語 & フレームワーク | Markdown ページに移動して、PlantUML フレームワークがインストールされていません警告の横にあるインストールボタンをクリックします。フレームワークは IntelliJ IDEA キャッシュにインストールされます。

ダイアグラムを視覚化するには、対応するコードブロックを puml または plantuml 言語で挿入します。以下のコードスニペットをコピーして、この機能の動作を確認できます。

プレビュー用のカスタム CSS

Markdown プレビューでは、カスタムスタイルシートを使ってドキュメントをレンダリングできます。基本的なプレゼンテーションの変更を行うためのカスタムスタイルシートを指定する（たとえば、プレビューのフォントサイズを大きくする）か、まったく新しい CSS を提供することができます（たとえば、GitHub Markdown スタイルを複製する場合）。

カスタムスタイルシートを提供するには、設定 / 環境設定ダイアログ Ctrl+Alt+S を開き、言語およびフレームワーク | Markdown ページに移動し、URI からロードオプションを使用して必要な CSS ファイルへのパスを設定します。このパスは、URL または絶対 / 相対パスのいずれかです。

代わりに、CSS ルールの追加エディターで直接 CSS を指定してください。

構文強調表示の構成

好みや習慣に従って Markdown を意識した構文強調表示を設定することができます。