Markdown サポート
Markdown (英語) は、フォーマット要素をプレーンテキストに追加するための軽量のマークアップ言語です。 PyCharm は Markdown ファイルを認識し、ハイライト、補完、フォーマット機能を備えた専用エディターを提供します。 サポートは CommonMark 仕様 に基づいています。
新しい Markdown ファイルを作成する
デフォルトでは、PyCharm は .md または .markdown 拡張子を持つすべてのファイルを Markdown ファイルとして認識します。
プロジェクト ツールウィンドウ（Alt+1 ）でディレクトリを右クリックし、 を選択します。
または、必要なディレクトリを選択し、 Alt+Insert を押してから、 ファイル を選択することもできます。
認識された拡張子を持つファイルの名前を入力します（例: readme.md ）。
Markdown エディターは、テキストフラグメントを選択した際に表示される フローティングツールバーで、いくつかの基本的なフォーマットアクションを提供します。 プレビューペインを使用して、レンダリングされた HTML を表示できます。
たとえばソースコード、イメージ、他の Markdown ファイルを参照する場合、現在の project 内のファイルへのリンクで 補完も利用できます。 詳細については、 リンク を参照してください。
Markdown のフォーマットing
フローティングツールバー
Markdown ファイルでテキストを選択すると、PyCharm はさまざまなフォーマットオプションを備えたフローティングツールバーを表示します。
で通常のテキストと、 H1 から H6 までのレベルのヘッダーを選択できます。
太字 Ctrl+B
斜体 Ctrl+I
取り消し線 Ctrl+Shift+S
コード Ctrl+Shift+C
リンクを作成 Ctrl+Shift+U
箇条書きリスト
番号付きリスト
チェックリスト
フローティングツールバーをカスタマイズする
Ctrl+Alt+S を押して設定を開き、 を選択します。
Markdown エディターのフローティングツールバー で必要なアクションを追加または削除します。
詳細については、 メニューとツールバー を参照してください。
変更を適用するには、 OK をクリックします。
フローティングツールバーを非表示にする
Ctrl+Alt+S を押して設定を開き、 を選択します。
Markdown で フローティングツールバーを非表示にする を選択します。
変更を適用するには、 OK をクリックします。
リンク
次の構文でリンクを定義できます：
リンクを挿入
Ctrl+Shift+U を押す。
または、 Alt+Insert を押して 挿入… ポップアップを開き、 リンク を選択します。
一部のテキストがハイライトされている場合は、リンクのテキストとして [ ] で囲まれます。 URL をクリップボードにコピーした場合は、リンク URL として ( ) で囲まれます。
リンクの上にマウスを置くと、オプションのタイトルが表示されます。
他のファイルやヘッダーへのリンク
URL の他に、現在のファイルの任意のヘッダーへのリンクを追加できます：
# This is a chapter Link to [this chapter](#this-is-a-chapter)現在のファイルに関連する他のファイルにリンクすることもできます：
# This is a chapter Link to [a chapter in another file](another-file.md#some-chapter)
PyCharm は、現在のコンテキストで使用できるリンクラベルの補完（現在のファイルに関連するファイルと有効なヘッダーラベル）を提供します：
参照されるヘッダーに移動するためのリンクラベルの Ctrl+Click。
ヘッダーまたはラベルで 使用箇所の検索 Alt+F7 を呼び出すと、このラベルを指すすべてのリンクを表示できます。 ヘッダーまたはラベルで 名前変更 リファクタリング Shift+F6 を呼び出して、関連するすべての使用箇所とともに名前を変更することもできます。
イメージ
デフォルトでは、Markdown はイメージに次の構文を使用します。これは、project 内のパスを補完して自分で入力できます：
画像の挿入
Ctrl+U を押す。
または、 Alt+Insert を押して 挿入… ポップアップを開き、 イメージ を選択します。
画像の挿入 ダイアログで画像へのパスを指定し、 OK をクリックします。
イメージを設定するには、イメージが挿入されている行のガターで 
をクリックします。 例: 画像の挿入 および 画像の構成 ダイアログで HTML に変換 を選択して、生の HTML マークアップを含むイメージを Markdown ファイルに挿入できます。
これにより、次のようになります：
リスト
Markdown では、順序なしリストに、後にスペースが続く -、 *,、 + を使用でき、順序付きリストに、後にピリオドが続く番号 (1。、 2。、 3。) を使用できます。 チェックボックス付きのタスクリストには、 - [x] を使用できます。 簡単にフォーマットするには、 フローティングツールバー を使用します。
IDE は、入力時にリストのインデントを階層に合わせて自動的に調整します。 この動作は設定で無効にできます。 Ctrl+Alt+S を押して設定を開き、 を選択して、 入力時にインデントを調整する を無効にします。
リストの番号付けを設定する
PyCharm で順序付きリストの番号付け方法を制御できます。
Ctrl+Alt+S を押して設定を開き、 を選択します。
リスト セクションで、 入力時にリスト番号を再割り当て を有効にします。
PyCharm は、入力時に順序付きリストの番号付けを自動的に調整します。
さらに、 リストの番号付け ドロップダウンリストから、番号付けスタイルを選択します:
連番: 各リスト項目に連続した番号を付けます (
1。、2。、3。)。 このオプションは、Markdown ソースの番号付けをレンダリングされたリストと一致させ、ソースを読むときに項目の位置がすぐに分かるようにします。'1.' を使用: 新しい項目をすべて
1。として記述します。 このオプションでは、Markdown レンダラーに番号付けを処理させるため、リストの番号を手動で振り直さずに項目を挿入、削除、並べ替えしやすくなります。前の番号を使用: 新しい項目ごとに前の項目の番号を再利用します (例:
5.、5.、5.)。 このオプションにより、編集と並べ替えがしやすくなり、リストの既存の開始番号が保持されます。
テーブル
PyCharm は、Markdown でテーブルを作成・編集する操作をサポートします。
テーブルの挿入
Alt+Insert を押して 挿入… ポップアップを開き、 テーブル を選択します。
テーブルのサイズ（行と列の数）を選択します。
各セルの内容を入力し、 Tab を押してキャレットをあるセルから次のセルに移動します。 新しい行を追加するには、 Shift+Enter を押します。 入力すると、PyCharm は行と列を自動的に調整して、テーブルのセル内容に適した形にします。
テーブル編集時の支援機能の無効化については、 スマートキー: Markdown を参照してください。
PyCharm は、フォーマットが正しくないテーブルをハイライトし、修正できるようにします。 リストからクイックフィックスを選択すると、PyCharm はクイックフィックスの適用結果を示すプレビューを表示します。
PyCharm は、テーブルのソーステキストを変更せずに、エディター内のテーブルセルと列区切りを自動的に揃えて、テーブルを読みやすくします。 この位置合わせなしでテーブルを表示する場合は、 テーブルセルを視覚的に整列 を で無効にします。
デフォルトでは、PyCharm はエディターにテーブルの列と行のマーカーを表示します。 これらのマーカーを使用して、列と行を選択、移動、挿入、削除、整列します。 マーカーは Markdown ファイルに固有の特殊な インレイヒントの一種です。 これらのマーカーが表示されない場合は、 Ctrl+Alt+S を押して IDE 設定を開き、 に移動し、 オプションをチェックしてください。
列マーカーをクリックして、次のアクションを実行します：
列を左に移動
列を右に移動
左に列を挿入
右に列を挿入
列セルを選択
左揃え
中央揃え
右揃え
列を削除
行マーカーをクリックして、次のアクションを実行します：
行を上に移動
行を下に移動
上に行を挿入
下に行を挿入- 行を選択
- 行を削除
コードブロック
フェンスで囲まれたコードブロックを挿入するには、コードブロックの前後にトリプルバッククォート ``` を使用します。 コードブロックの言語を指定すると、デフォルトで、Markdown エディターが 対応する言語を挿入します。
これにより、指定された言語の構文のハイライトとその他のコーディング支援機能が有効になります: 補完、 インスペクション 、および インテンションアクション。
doctest インジェクションを使用して、REPL モードで Python コードの実行を示すこともできます。
コードブロックのコーディング支援を無効にする
コードブロックが構文的に正しいことを想定していない場合は、コードインジェクションと構文エラーを無効化することを検討してください。
Ctrl+Alt+S を押して設定を開き、 を選択します。
次のオプションをクリアします：
コードフェンス内の言語を挿入
コードフェンス内のエラーを表示
変更を適用するには、 OK をクリックします。
Markdown ファイルからコマンドを実行する
プロジェクトのクローンを作成する場合、通常、アプリケーションの実行、環境の構成などを行うための指示とコマンドを含む README.md ファイルがあります。 PyCharm はこれらのコマンドを検出し、コマンドを実行するためのガターアイコンを提供します。
対応するガターアイコンをクリックするか、キャレットが実行するコマンドにあるときに Ctrl+Shift+F10 を押します。
コマンドの実行時に、 作業ディレクトリとして使用するディレクトリを選択できます: 親ファイルディレクトリまたはプロジェクトディレクトリ。
IDE 設定 Ctrl+Alt+S の で Markdown ファイルのコマンドを実行するためのガターアイコンを無効にすることができます: Markdown ファイルから直接実行できるコマンドを検出 チェックボックスをオフにします。
詳細については、 Markdown 言語設定 を参照してください。
数式
Markdown プラグインは、TeX および LaTeX 構文でドキュメントに数式を追加できます。 インライン数式にはドル記号 $...$ 、数式ブロックには二重ドル記号 $$...$$ を使います。
リテラルのドル記号を挿入したい場合は、バックスラッシュでエスケープしてください： \$ または \$$。
ダイアグラム
Markdown エディターは、 Mermaid(英語) および PlantUML(英語) で定義されたダイアグラムをレンダリングできます。 これはデフォルトで無効になっており、追加の手順が必要です。
Mermaid ダイアグラムのサポートを有効にする
Ctrl+Alt+S を押して設定を開き、 を選択します。
Mermaid(英語) プラグインを見つけてインストールします。
PlantUML ダイアグラムのサポートを有効にする
Ctrl+Alt+S を押して設定を開き、 を選択します。
PlantUML を Markdown 拡張機能 にインストールして有効にします。
PyCharm が関連する拡張機能をダウンロードしたら、 OK をクリックして変更を適用します。
目次
PyCharm では、ドキュメント内の見出しから目次を生成できます。
目次の生成
現在のファイルで使用可能なヘッダーの適切にインデントされたリストを生成できます。
現在のファイルの目次を追加する場所にキャレットを置き、 Alt+Insert を押して 挿入… ポップアップを開きます。
目次 を選択します。
このファイルにすでに目次がある場合は、いくつかのヘッダーを追加、削除、名前変更した後で、 目次の更新 を選択して更新します。
目次は <!-- TOC --> コメントタグで囲まれています。
目次から見出しを省略する
特定の見出しを目次から除外できます。
省略する見出しにキャレットを置き、 Alt+Enter を押して、 目次から見出しを省略する を選択します。
IDE は、この見出しを目次から除外する <!-- omit from toc --> を見出しの前に挿入します。
Markdown をプレビュー
デフォルトでは、Markdown エディターには、Markdown ソースの隣にレンダリングされた HTML コードのプレビューペインが表示されます。 Markdown エディターの右上隅にある 
エディター または 
プレビュー をクリックすると、エディターまたはプレビューペインのみを表示できます。
エディターを分割して水平方向にプレビュー
デフォルトでは、エディターとプレビューは垂直（並列）に分割されており、ワイドモニターに便利です。 また、水平方向に分割してプレビューをエディターの下部に表示することもでき、縦長ディスプレイの方が便利です。
エディターの右上隅にある
をクリックして、 エディタープレビュー ペインを開きます。
をクリックして、エディターとプレビューを水平に分割します。
プレビューのデフォルトのレイアウトを構成するには、 の プレビュー レイアウト リストを使用できます。
エディターを無効にし、スクロールバーの同期をプレビューする
デフォルトでは、エディターとプレビューペインのスクロールバーは同期されています。つまり、プレビューペインの場所はソースの場所に対応しています。
Ctrl+Alt+S を押して設定を開き、 を選択します。
エディター とプレビューでスクロールを同期 をクリアします。
変更を適用するには、 OK をクリックします。
プレビューのフォントサイズを変更する
CSS をカスタマイズすることでプレビューのフォントサイズを定義することもできますが、組み込みのスタイルシートのフォントサイズを設定することもできます。
Ctrl+Alt+S を押して設定を開き、 を選択します。
プレビュー フォントサイズ フィールドでフォントサイズを設定します。
変更を適用するには、 OK をクリックします。
プレビューのフォントサイズを頻繁に調整する必要がある場合は、設定で変更するのではなく、次の 2 つのアクションにショートカットを割り当てます: プレビューフォントサイズの拡大 と プレビューフォントサイズの縮小。
カスタム CSS
PyCharm は、プレビューペインで HTML をレンダリングするためのデフォルトのスタイルシートを提供します。 これらのスタイルシートはデフォルトの UI テーマと一貫性を持つよう設計されています。 特定の CSS ルールを設定して、見た目を少し変更できます。たとえば、見出しのフォントサイズやリストの行間を変更できます。 あるいは、 GitHub Markdown スタイルを再現したい場合など、期待される出力により合致する全く新しい CSS を指定することもできます。
HTML プレビューをレンダリングするための CSS の構成
Ctrl+Alt+S を押して設定を開き、 を選択します。
カスタム CSS で設定を構成します。
読み込み元 を選択して、カスタム CSS ファイルの場所を指定します。
CSS ルール ルールを選択して、オーバーライドする特定の CSS ルールを入力します。
変更を適用するには、 OK をクリックします。
カスタム CSS ルールの例を次に示します：
Markdown ファイルを再フォーマットする
PyCharm は、適切な行の折り返し、空白行、インデントで Markdown ファイルを 再フォーマットできます。
ビルドの実行時、またはその他のアクション時に、VCS コミットで自動的に再フォーマットをトリガーできます。または、いつでも手動で再フォーマットを呼び出すことができます。
メインメニューで、 に移動するか、 Ctrl+Alt+L を押します。
PyCharm は Markdown ファイルの コードスタイル設定に従って内容をフォーマットします。
Markdown コードスタイル設定を構成する
Ctrl+Alt+S を押して設定を開き、 を選択します。
行を折り返して段落を埋める
デフォルトでは、PyCharm は長い行に自動でハードラップを追加しません。 ファイルを再フォーマットすると行が折り返されます。
Ctrl+Alt+S を押して設定を開き、 を選択します。 入力時に自動改行を有効にするには、 Markdown コードスタイル設定を設定します。
あるいは、設定した最大行長を超える段落を保持する場合は、ハードラップを完全に無効にします。 の 長いテキストの折り返し オプションを無効にしてください。
アクションを使用して、キャレットがある段落にのみ改行を追加することもできます。
ドキュメント内を移動して管理する
大きな Markdown ファイル内を移動する
構造 ツールウィンドウ Alt+7 または ファイル構造 ポップアップ Ctrl+F12 を使用して、関連する見出しを表示して移動します。
Markdown ファイルにコメントを追加する
Markdown には、行をコメントアウトするための専用の構文はありません。 ただし、次のように、アドレスのないリンクラベルを使用してコメント行をエミュレートすることは可能です。
コメントアウトする行にキャレットを置き、 Ctrl+/ を押します。
これにより、コメントアウトされたテキストが括弧で囲まれ、必要に応じてその前に空白行が含まれるリンクラベルが追加されます。 コメントを解除するには、同じショートカットを押します。
Markdown のハイライトをカスタマイズする
PyCharm は 配色設定に従ってさまざまな Markdown 要素をハイライトします。
設定 ダイアログ（Ctrl+Alt+S ）で、 エディター | カラースキーム | Markdown を選択します。
カラースキームを選択するか、デフォルトから継承したハイライト設定を使用するか、あるいは 色とフォント の説明に従ってカスタマイズします。
Markdown ファイルを変換する
Markdown プラグインは、Markdown ファイルを HTML と PDF にエクスポートできます。 Pandoc(英語) を設定すると、Microsoft Word ファイル（DOCX）へのエクスポートとインポートも可能になります。
Pandoc の構成
PyCharm は Pandoc のインストールを自動的に検出できるはずです。 そうでない場合は、以下を実行します。
メインメニューで へ移動します。
Pandoc 設定 で、Pandoc 実行可能ファイルの場所と、MicrosoftWord ドキュメントからインポートしたイメージを保存する場所を指定します。
変更を適用するには、 OK をクリックします。
MicrosoftWord からインポート
メインメニューで へ移動します。
ドキュメントの場所を指定します。
Markdown ファイルを別の形式にエクスポートする
PyCharm は Microsoft Word（Pandoc が必要 ）、PDF、HTML へのエクスポートが可能です。
- エディターとプレビュー または プレビュー をクリックして、エディターに HTML プレビューペインを表示します。
メインメニューで へ移動します。
Markdown をエクスポート ダイアログで、出力ファイルの名前、場所、形式を指定して、 OK をクリックします。
