MDファイルとMarkdownの関係
Markdownは、プレーンテキストに少ない記号を加えて文書構造を表す記法です。MDファイルは、そのMarkdownを書いたテキストファイルで、一般的に.mdという拡張子を使います。
ファイルの中に保存されるのは、整形済み画面ではなく文字と記号です。Markdown対応アプリがその記号を読み取り、見出し、リスト、リンク、表、コードとして表示します。
# 作業メモ
これは**重要な項目**です。
- 確認する
- 公開する作業メモ(大見出し)
これは重要な項目です。(重要な項目が太字)
・確認する
・公開する| 用語 | 意味 |
|---|---|
| Markdown | 文章構造を表す軽量な記法 |
| MDファイル | Markdownが書かれたプレーンテキストファイル |
| .md | Markdownファイルでよく使う拡張子 |
| レンダラー | 記法を読み取り、整形後の表示を作るソフトウェア |
README.mdは何をするファイルか
README.mdは、フォルダーやプロジェクトの入口に置く説明文書です。ソフトウェアの目的、インストール方法、使い方、ライセンス、問い合わせ先などを書きます。GitHubなどはREADME.mdを自動でレンダリングするため、訪問者は記号ではなく整形された説明を目にします。
README.mdだけが特別なファイル形式なのではありません。通常のMarkdownに、用途を示す慣例的な名前が付いているだけです。
WindowsでMDファイルを開く・作る
既存ファイルは、メモ帳、VS Code、その他のテキストエディターから開けます。#や*が見えても壊れているわけではなく、ソースを表示している状態です。
- プレーンテキストで作成テキストエディターにMarkdownを書きます。
- 名前を付けて保存ファイルの種類を「すべてのファイル」にし、可能なら文字コードをUTF-8にします。
- .mdで終わる名前にするnotes.mdと保存します。拡張子を表示して、notes.md.txtになっていないか確認します。
macOS・Linux・VS Codeで開く
macOSのテキストエディットで新しく作る場合は、リッチテキストではなく標準テキストに切り替えます。Linuxでは一般的なテキストエディターで開けます。OSではなく、利用するアプリがMarkdown表示に対応しているかがポイントです。
VS CodeはMarkdown編集とプレビューに対応しています。ファイルを開き、Windows・LinuxではCtrl+Shift+V、macOSではCmd+Shift+Vでプレビューを表示できます。
MDファイルでよく起きる問題
開けないように見える問題の多くは、拡張子、表示アプリ、画像パス、利用先のMarkdown拡張に原因があります。
| 症状 | 考えられる原因 | 確認方法 |
|---|---|---|
| #や*がそのまま見える | ソース表示で開いている | Markdownプレビューを使う |
| notes.md.txtになった | エディターが.txtを付けた | 拡張子を表示し、すべてのファイルで保存する |
| 画像が表示されない | 相対パスとファイル位置が合わない | 画像を一緒に移すかパスを直す |
| 表が崩れる | GFM表に未対応、または区切り行が不正 | 公開先の仕様と表記法を確認する |
| アプリごとに改行が違う | 拡張記法や設定が異なる | 最終公開先で確認する |
MDを編集・プレビュー・変換する
編集は任意のテキストエディターでできますが、表やコードを含む文書はプレビューと並べると誤りを見つけやすくなります。特に見出し順、表、タスクリスト、画像、コードフェンス、改行を確認します。
相手がMarkdownを使わない場合は形式を変えます。閲覧・印刷用ならPDF、共同編集ならDOCX、Web公開ならHTMLが一般的です。元の.mdを残しておけば、目的ごとに出力を作り直せます。
公式仕様と参考資料
記法やアプリの動作を確認するときは、最終的に一次資料を参照します。
関連ツール
よくある質問
MDファイルを開くのに専用ソフトは必要ですか?
いいえ。内容を見るだけならテキストエディターで開けます。整形後の表示にはMarkdownプレビューを使います。
WordでMDファイルを開けますか?
ソースを文字として開ける場合はありますが、Wordは標準のMarkdownレンダラーではありません。編集可能な文書が必要ならDOCXへ変換します。
README.mdは別の形式ですか?
いいえ。README.mdも通常のMDファイルです。プロジェクトの説明に使う慣例的なファイル名です。
アプリによって表示が違うのはなぜですか?
基本記法は共通でも、表、タスクリスト、脚注、改行、CSSなどの対応が異なるためです。
