Markdown
Markdown (英語) は、フォーマット要素をプレーンテキストに追加するための軽量のマークアップ言語です。RubyMine は Markdown ファイルを認識し、ハイライト、補完、フォーマットを行う専用エディターを提供し、レンダリングされた HTML をライブプレビューペインに表示します。サポートは CommonMark の仕様(英語)に基づいています。
新しい Markdown ファイルを作成する
デフォルトでは、RubyMine は、.md または .markdown 拡張子を持つすべてのファイルを Markdown ファイルとして認識します。
プロジェクトツールウィンドウ Alt+1 でディレクトリを右クリックし、 を選択します。
または、必要なディレクトリを選択し、Alt+Insert を押してから、ファイルを選択することもできます。
認識された拡張子を持つファイルの名前を入力します(例: readme.md)。
Markdown エディターは、テキストフラグメントを選択したときに表示されるフローティングツールバーにいくつかの基本的なフォーマットアクションを提供します。プレビューペインを使用して、レンダリングされた HTML を表示できます。
![Markdown エディターのフォーマットツールバー Markdown editor formatting toolbar](https://resources.jetbrains.com/help/img/idea/2024.1/rm_markdown-basics.png)
たとえば、ソースコード、イメージ、他の Markdown ファイルを参照する必要がある場合、現在のプロジェクト内のファイルへのリンクの補完もあります。詳細については、リンクを参照してください。
![Markdown エディター補完ポップアップ Markdown editor completion popup](https://resources.jetbrains.com/help/img/idea/2024.1/rm_markdown-completion.png)
コードブロック
フェンスで囲まれたコードブロックを挿入するには、コードブロックの前後にトリプルバッククォート ```
を使用します。コードブロックの言語を指定すると、デフォルトで、Markdown エディターが対応する言語を挿入します。
これにより、指定された言語の構文のハイライトとその他のコーディング支援機能が有効になります: 補完、インスペクション、およびインテンションアクション。
![フェンスドコードブロックでの Markdown 完了 Markdown completion in fenced code blocks](https://resources.jetbrains.com/help/img/idea/2024.1/rm_markdown_support_fenced_code_completion.png)
コードブロックのコーディング支援を無効にする
コードブロックが構文的に正しいことを意図していない場合は、コードブロックのコードインジェクションと構文エラーを無効にすることをお勧めします。
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。次のオプションをクリアします。
コードフェンスに言語を注入
コードフェンスの問題を表示
変更を適用するには、OK をクリックします。
Markdown ファイルからコマンドを実行する
プロジェクトのクローンを作成する場合、通常、アプリケーションの実行、環境の構成などを行うための指示とコマンドを含む README.md ファイルがあります。RubyMine はこれらのコマンドを検出し、コマンドを実行するためのガターアイコンを提供します。
対応するガターアイコンをクリックするか、キャレットが実行するコマンドにあるときに Ctrl+Shift+F10 を押します。
IDE 設定 Ctrl+Alt+S のMarkdown ファイルから直接実行できるコマンドを検出チェックボックスをオフにします。
で Markdown ファイルのコマンドを実行するためのガターアイコンを無効にすることができます:詳細は、Markdown 言語設定を参照してください。
ダイアグラム
Markdown エディターは、Mermaid(英語) および PlantUML(英語) で定義されたダイアグラムをレンダリングできます。これはデフォルトで無効になっており、追加の手順が必要です。
![Markdown の Mermaid ダイアグラム Mermaid diagram in Markdown](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-diagrams-mermaid.png)
人魚ダイアグラムのサポートを有効にする
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。Mermaid(英語) プラグインを見つけてインストールします。
PlantUML ダイアグラムのサポートを有効にする
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。PlantUML を Markdown 拡張機能にインストールして有効にします。
RubyMine が関連する拡張機能をダウンロードしたら、OK をクリックして変更を適用します。
HTML プレビュー
デフォルトでは、Markdown エディターには、Markdown ソースの隣にレンダリングされた HTML コードのプレビューペインが表示されます。Markdown エディターの右上隅にある エディターまたは
プレビューをクリックすると、エディターまたはプレビューペインのみを表示できます。
エディターを分割して水平方向にプレビュー
デフォルトでは、エディターとプレビューは垂直方向 (横に並べて) に分割されているため、ワイドモニターに便利です。水平方向に分割して、エディターの下部にプレビューが表示されるようにすることもできます。これは、縦方向に表示する場合に便利です。
エディターの右上隅にある
をクリックして、エディタープレビューペインを開きます。
をクリックして、エディターとプレビューを水平に分割します。
![Markdown エディターとライブプレビューペインが水平方向に分割 Markdown editor and live preview pane split horizontally](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-preview-split-horizontally.png)
プレビューのデフォルトのレイアウトを構成するには、プレビューレイアウトリストを使用できます。
のエディターを無効にし、スクロールバーの同期をプレビューする
デフォルトでは、エディターとプレビューペインのスクロールバーは同期されています。つまり、プレビューペインの場所はソースの場所に対応しています。
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。エディターでスクロールを同期してプレビューするをクリアします。
変更を適用するには、OK をクリックします。
プレビューのフォントサイズを変更する
CSS をカスタマイズすることでプレビューのフォントサイズを定義することもできますが、組み込みのスタイルシートのフォントサイズを設定することもできます。
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。プレビューフォントサイズフィールドでフォントサイズを設定します。
変更を適用するには、OK をクリックします。
プレビューのフォントサイズを頻繁に調整する必要がある場合は、設定で変更するのではなく、次の 2 つのアクションにショートカットを割り当てます: プレビューのフォントサイズを大きくするとプレビューのフォントサイズを小さくします。
カスタム CSS
RubyMine は、プレビューペインで HTML をレンダリングするためのデフォルトのスタイルシートを提供します。これらのスタイルシートは、デフォルトの UI テーマと一致するように設計されています。特定の CSS ルールを構成して、小さなプレゼンテーションの変更を行うことができます。たとえば、見出しのフォントサイズを変更したり、リストの行間隔を変更したりできます。または、予想される出力により一致するようにまったく新しい CSS を提供することもできます。たとえば、GitHub Markdown スタイル(英語)を複製する場合などです。
![GitHub レンダリングスタイルに似たカスタム CSS を使用した Markdown プレビュー Markdown preview with a custom CSS that resembles GitHub rendering style](https://resources.jetbrains.com/help/img/idea/2024.1/rm_markdown-preview-custom-css.png)
HTML プレビューをレンダリングするための CSS の構成
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。カスタム CSS で設定を構成します。
からロードを選択して、カスタム CSS ファイルの場所を指定します。
CSS ルールルールを選択して、オーバーライドする特定の CSS ルールを入力します。
変更を適用するには、OK をクリックします。
カスタム CSS ルールの例を次に示します。
イメージ
デフォルトでは、Markdown はイメージに次の構文を使用します。これは、プロジェクト内のパスの補完を使用して入力できます。
![Markdown ドキュメントに挿入されたイメージ Inserted image in a Markdown document](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-image-inserted.png)
画像の挿入
Ctrl+U を押します。
または、Alt+Insert を押して挿入ポップアップを開き、イメージを選択します。
画像の挿入ダイアログでイメージへのパスを指定します。
OK をクリックします。
イメージを設定するには、イメージが挿入されている行の余白にある をクリックします。例: 画像の挿入および画像の構成ダイアログで HTML に変換を選択すると、生の HTML マークアップを含むイメージを Markdown ファイルに挿入できます。
![生の HTML でイメージを挿入 Insert Image with raw HTML](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-insert-image-html.png)
これにより、次のようになります。
![生の HTML で挿入されたイメージ Image inserted with raw HTML](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-image-inserted-as-html.png)
リンク
次の構文でリンクを定義できます。
![Markdown ファイルにリンクを挿入する Insert a link in a Markdown file](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-link-inserted.png)
リンクを挿入
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)
RubyMine は、現在のコンテキストで使用可能なリンクラベル(現在のファイルに関連するファイルと有効なヘッダーラベル)の補完を提供します。
参照されるヘッダーに移動するためのリンクラベルの Ctrl+Click。
ヘッダーまたはラベルで使用箇所の検索 Alt+F7 を呼び出すと、このラベルを指すすべてのリンクを表示できます。ヘッダーまたはラベルで名前変更リファクタリング Shift+F6 を呼び出して、関連するすべての使用箇所とともに名前を変更することもできます。
目次の生成
現在のファイルで使用可能なヘッダーの適切にインデントされたリストを生成できます。
現在のファイルの目次を追加する場所にキャレットを置き、Alt+Insert を押して挿入ポップアップを開きます。
目次を選択します。
このファイルにすでに目次がある場合は、いくつかのヘッダーを追加、削除、名前変更した後で、目次の更新を選択して更新します。
目次は <!-- TOC -->
コメントタグで囲まれています。
テーブル
RubyMine は、Markdown でのテーブルの作成と編集をサポートします。
テーブルの挿入
Alt+Insert を押して挿入ポップアップを開き、テーブルを選択します。
テーブルのサイズ(行と列の数)を選択します。
各セルの内容を入力し、Tab を押してキャレットをあるセルから次のセルに移動します。新しい行を追加するには、Shift+Enter を押します。入力すると、RubyMine は行と列を自動的に調整して、表のセルの内容に適切に適合させます。
テーブル編集時の支援機能の無効化については、「スマートキー: Markdown」を参照してください。
RubyMine は、フォーマットが正しくないテーブルをハイライトし、修正できるようにします。リストからクイックフィックスを選択すると、RubyMine はクイックフィックスの適用結果を示すプレビューを表示します。
![Markdown インスペクション (誤ってフォーマットされたテーブルの場合) Markdown inspection for incorrectly formatted table](https://resources.jetbrains.com/help/img/idea/2024.1/markdown_table_formatting_inspection.png)
デフォルトでは、RubyMine はエディターにテーブルの列と行のマーカーを表示します。これらのマーカーを使用して、列と行を選択、移動、挿入、削除、整列します。マーカーは、Markdown ファイルに固有の特殊なタイプのインレイヒントです。これらのマーカーが表示されない場合は、Ctrl+Alt+S を押して IDE 設定を開き、 に移動して、 オプションをチェックします。
![Markdown ファイルのテーブルの編集 Editing a table in a Markdown file](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-tables.png)
列マーカーをクリックして、次のアクションを実行します。
列を左に移動
列を右に移動
列を左に挿入
列を右に挿入
列セルの選択
左揃え
中央揃え
右揃え
列の除去
行マーカーをクリックして、次のアクションを実行します。
行を上に移動
行を下に移動
行を上に挿入
行を下に挿入
行の選択
行の除去
フローティングツールバー
Markdown ファイルでテキストを選択すると、RubyMine にはさまざまなフォーマットオプションを備えたフローティングツールバーが表示されます。
![Markdown フローティングツールバー The Markdown floating toolbar](https://resources.jetbrains.com/help/img/idea/2024.1/markdown-floating-toolbar.png)
通常のテキストと H1
から H6
までのレベルのヘッダーのどちらかを選択します
太字 Ctrl+B
斜体 Ctrl+I
取り消し線 Ctrl+Shift+S
コード Ctrl+Shift+C
リンクの作成 Ctrl+Shift+U
順序なしリスト
順序付きリスト
チェックマークリスト
フローティングツールバーをカスタマイズする
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。Markdown エディターのフローティングツールバーで必要なアクションを追加または削除します。
詳細は、メニューおよびツールバーを参照してください。
変更を適用するには、OK をクリックします。
フローティングツールバーを非表示にする
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。Markdown でフローティングツールバーの非表示を選択します。
変更を適用するには、OK をクリックします。
Markdown ファイルを再フォーマットする
RubyMine は、適切な行の折り返し、空白行、インデントを使用して Markdown ファイルを再フォーマットできます。
ビルドの実行時、またはその他のアクション時に、VCS コミットで自動的に再フォーマットをトリガーできます。または、いつでも手動で再フォーマットを呼び出すことができます。
メインメニューで、
に移動するか、Ctrl+Alt+L を押します。
RubyMine は、Markdown ファイルのコードスタイル設定に従ってコンテンツをフォーマットします。
Markdown コードスタイル設定を構成する
Ctrl+Alt+S を押して IDE 設定を開き、
を選択します。
詳細は、Markdown コードスタイル設定を参照してください。
Markdown ファイルを変換する
Markdown プラグインは、Markdown ファイルをそのまま HTML および PDF にエクスポートできます。Pandoc(英語) を構成すると、Microsoft Word ファイル(DOCX)との間でエクスポートおよびインポートすることもできます。
Pandoc の構成
RubyMine は、Pandoc のインストールを自動的に検出できるはずです。そうでない場合は、以下を実行します。
メインメニューで、
に移動します。Pandoc 設定で、Pandoc 実行可能ファイルの場所と、MicrosoftWord ドキュメントからインポートしたイメージを保存する場所を指定します。
変更を適用するには、OK をクリックします。
MicrosoftWord からインポート
メインメニューで、
に移動します。ドキュメントの場所を指定します。
Markdown ファイルを別の形式にエクスポートする
RubyMine は、Microsoft Word(Pandoc が必要)、PDF、HTML にエクスポートできます。
エディターとプレビューまたは
プレビューをクリックして、エディターに HTML プレビューペインを表示します。
メインメニューで、
に移動します。Markdown のエクスポートダイアログで、出力ファイルの名前、場所、形式を指定して、OK をクリックします。
生産性のヒント
Markdown のハイライトをカスタマイズする
RubyMine は、配色設定に従ってさまざまな Markdown 要素をハイライトします。
設定ダイアログ(Ctrl+Alt+S)で、エディター | カラースキームの切り替え | Markdown を選択します。
配色を選択するか、デフォルトから継承されたハイライト設定を受け入れるか、色とフォントを設定する説明に従ってカスタマイズします。
大きな Markdown ファイルで移動する
構造ツールウィンドウ Alt+7 またはファイル構造ポップアップ Ctrl+F12 を使用して、関連する見出しを表示して移動します。
Markdown ファイルにコメントを追加する
Markdown には、行をコメントアウトするための専用の構文はありません。ただし、次のように、アドレスのないリンクラベルを使用してコメント行をエミュレートすることは可能です。
コメントアウトする行にキャレットを置き、Ctrl+/ を押します。
これにより、コメントアウトされたテキストが括弧で囲まれ、必要に応じてその前に空白行が含まれるリンクラベルが追加されます。コメントを解除するには、同じショートカットを押します。
行を折り返して段落を埋める
デフォルトでは、RubyMine は長い行にハードラップを自動的に追加しません。ファイルを再フォーマットすると行が折り返されます。
Ctrl+Alt+S を押して IDE 設定を開き、Markdown コードスタイル設定を設定して、入力時に自動改行を有効にします。
を選択します。あるいは、ハードラップを完全に無効にして、構成された最大行長よりも長い段落を保持します。
アクションを使用して、キャレットがある段落にのみ改行を追加することもできます。
関連ページ:
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_completion_basic_2.png)
コード補完
このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完:基本コード補完は、可視性スコープ内のクラス、メソッド、キーワードの名前を完成させるのに役立ちます。コード補完を呼び出すと、RubyMine はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本補完を呼び出す名前の入力を開始します。を押すか、メインメニューからを選択してください。...
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_lang_injection_settings.png)
言語インジェクション
言語インジェクションを使用すると、コードに埋め込まれた他の言語のコード部分を操作できます。文字列リテラルに言語 (HTML、CSS、XML、RegExp など) を挿入すると、プロジェクトのメイン言語でなくても、挿入されたコードに対して包括的なコーディング支援を受けることができます。一時的に言語をインジェクションするデフォルトでは、IDE は一時的に言語を挿入します。これは、埋め込まれた要素を削除すると、インジェクションも失われることを意味します。言語を挿入する文字列リテラル、タグ、属性内にキャ...
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_inspections_settings.png)
コードインスペクション
RubyMine には、プロジェクト内の異常なコードを検出して修正する一連のコードインスペクションがあります。IDE は、さまざまな問題を見つけてハイライトし、デッドコードを見つけ、考えられるバグやスペルの問題を見つけ、全体的なコード構造を改善することができます。インスペクションは、すべてのプロジェクトファイルまたは特定のスコープでのみ(たとえば、本番コードまたは変更されたファイルでのみ)コードをスキャンできます。すべてのインスペクションには、問題がコードに影響を与える可能性がある程度の重大度レ...
![](https://pleiades.io/icons/rubymine.png)
Markdown 言語設定
このページを使用して、RubyMine で Markdown サポートを構成します。デフォルトレイアウト Markdown ファイルエディターのデフォルトのレイアウトを選択します。エディターのみ、プレビューペインのみ、その両方を表示します。エディターの右上隅にあるボタンを使用して変更できます。プレビューレイアウトエディターとプレビューペインを分割する方法を選択します: 垂直(並べて)または水平(エディターのプレビュー)。プレビューフォントサイズ HTML プレビューに組み込まれているスタイルシートのフォ...
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_find_usages_highlight_editor.png)
使用箇所を検索
コードを記述または編集するときに、変更または削除するコード要素に遭遇する場合があります。変更を行う前に、コード要素がどこで使用され、アプリケーションにどのように影響するかを確認することをお勧めします。使用箇所の検索アクションを使用すると、コードベース全体でコード要素の参照を検索できます。検索プロセスを管理し、単一のファイルのみで検索したり、検索をプロジェクト全体に拡張したり、特定の検索範囲を作成したりできます。さらに、使用箇所のハイライトの色を構成したり、用途の自動ハイライトを完全に無効にしたり...
![](https://resources.jetbrains.com/help/img/idea/2024.1/rm_refactoring_rename_preview.png)
名前の変更リファクタリング
名前変更リファクタリングを使用して、シンボル、ファイル、ディレクトリ、Rails アプリケーションコンポーネント、Rails 名前付きスコープ、Rails フィクスチャなどの名前を変更します。RubyMine は、コード全体で、名前が変更された項目へのすべての参照を自動的に変更します。ローカル変数またはプライベートメソッドの名前の変更は、限られた範囲のみが影響を受けるため、インラインで簡単に実行できます。クラスや public メソッドの名前を変更すると、多くのファイルに影響を与える可能性があり...