拡張子ナビFILE EXTENSION LIBRARY
English
ホーム›文書›.md
ファイルを知る、使いこなす。
.md

Markdown

文書

MDは見出しや箇条書きを記号で書くMarkdownのテキストです。文章そのものと、HTMLのように整形されたプレビューを切り替えて使います。表やチェックリストなどはMarkdownの処理系によって対応が異なります。

主な用途
README・技術文書・軽量な文章の編集
中身の種類
テキスト
目次・よくある質問・根拠資料を見る

内容の最終確認： · 編集：Kai

まず確認：目的に合う開き方

MDはMarkdown記法のテキストです。文章を読むだけならテキストエディター、見出しやリンクの見た目を確かめるならMarkdownプレビューを使います。GitHub・ブログ・各エディターで使える記法が異なるため、公開先の仕様も確認します。

開き方・操作手順

使っている環境や目的の項目を開いて、手順を確認してください。

Windows：VS Codeで編集とプレビュー

ソースと表示結果を見比べると記法の間違いを見つけやすくなります。

  1. VS Codeの「ファイル」→「ファイルを開く」でMDを選択します。
  2. コマンドパレットから「Markdown: Open Preview to the Side」を選び、ソースとプレビューを並べます。
  3. 見出し・画像・リンクを確認し、MDと参照画像を同じフォルダー関係のまま保存します。
macOS・Linux：エディターで確認

Markdown用のアプリがなければ文字として読めます。

  1. VS Codeなどのテキストエディターの「開く」でMDを読み込みます。
  2. 書式付きワープロに貼り付けるのではなく、記号やインデントを含めて確認します。
  3. プレビューで画像がない場合はMDからの相対パスを確認。外部画像を読む際の通信も意識します。
スマホ・Web：公開先の表示を確認

単純なテキスト表示とMarkdown描画は別です。

  1. MDを保存し、対応ビューアかテキスト表示で開きます。
  2. 画像フォルダーが届いているか確認します。MD単体では相対参照の画像は送れません。
  3. 公開先で必要な表・コードブロック・改行が表示されるか確認し、プレビューの設定をむやみに緩めません。

操作名・対応状況はアプリ・OS・版によって異なります。変更する前に原本を残してください。

開けないとき：症状から確認

  • 画像だけ表示されない：画像ファイルへの相対パスを確認します。MDだけを移動すると、隣の画像フォルダーへの参照が切れることがあります。
  • 表や改行が意図通りにならない：公開先のMarkdown仕様を確認します。GitHub用の記法が別アプリで同じになるとは限りません。
  • 文字化け：保存時の文字コードを確認し、原本のコピーでUTF-8などの読み込みを試します。
  • コードが文章と一緒になる：コードブロックの開始・終了記号とインデントを確認します。公開先が対応する記法に合わせます。
  • リンクが別の場所へ移動する：相対パスの基準と大文字小文字を確認。ローカルで通ってもサーバーで一致しない場合があります。
  • 改行が消える：ソースの1改行をそのまま表示するかは記法に依存します。空行や公開先の指定した改行記法を確認します。

Markdown → HTML / PDF

  1. 公開先で使うMarkdown処理系でHTMLへ変換し、リンク先と画像の参照先を確認します。
  2. PDFが必要なら対応するプレビューや文書アプリで書き出し、改ページとコードブロックの折り返しを確認します。
  3. 書き出したHTMLやPDFでコード・表・画像・リンクを確認し、必要な付随ファイルも保管します。

変換時に外部画像を取得するアプリもあります。相対参照の画像も一緒に保管し、PDFへの書き出し機能は利用するアプリで確認します。

公開先ごとの記法の違い

CommonMarkを基礎にしていても、表、タスクリスト、数式などは追加機能の場合があります。「手元で表示できた」ことだけで公開先の対応は判断しません。

本文をコピーして使う前に、見出しの階層、コード、リンク、画像、表を公開先のプレビューで確認します。外部サービスへ機密情報を貼り付けないようにします。

この手順の根拠：CommonMark · Markdown Reference / Microsoft · Markdown and Visual Studio Code

画像とHTML書き出しの扱い

MDと画像のフォルダー構造をまとめて渡します。HTMLへ変換しても、画像が外部ファイルのままならHTMLだけで表示は完結しません。

MDソースは通常テキストですが、描画時のHTML・外部画像・リンクの扱いはビューアに依存します。更新済みアプリを使い、不要な拡張機能や実行設定を追加しないでください。

この手順の根拠：Microsoft · Markdown and Visual Studio Code

関連形式との違い

関連形式との違い
形式・選択肢役割と残せる情報
MD記法を含む文章の原本。表示結果は描画エンジンで変わります。
TXT記法も文字として読むだけ。見出しやリンクの描画はありません。
HTML / PDF配布用の表示結果。元MDと参照画像も残します。

取り扱いと安全性

リンク、埋め込みHTML、外部画像は別途確認します。内容を読むためだけに、プレビューのセキュリティ制限を無効にする必要はありません。

よくある質問

MDはプログラム？

基本は文書のテキストです。ただしコード例やHTMLが含まれるため、記載コマンドをそのまま実行しないでください。

README.mdをメモ帳で読める？

読めます。記号はそのまま表示され、整形した見た目はMarkdownプレビューで確認できます。

プレビューと公開ページが違うのは？

処理系、CSS、拡張記法の違いが考えられます。公開先で実際に確認します。

MDだけ送れば画像も届く？

相対パスで参照する画像は別ファイルです。画像フォルダーも同じ構造で送ります。

MarkdownをHTMLにすればどこでも同じ？

CSS、フォント、外部画像などで表示は変わります。出力先で確認してください。

形式の基本情報：正式名称・MIME type・管理団体
名称
Markdown source text
管理・仕様
Markdown implementations / CommonMark
MIME type
text/markdown

公式・一次情報

  • プロジェクト公式Markdown Reference

    見出し・リンク・コードなど、Markdownの基本的な記法を確認できます。

    CommonMark · リンク確認：
  • ソフトウェア公式Markdown and Visual Studio Code

    Markdownの編集、プレビュー、プレビューのセキュリティ設定の資料です。

    Microsoft · リンク確認：