🏗️

マークダウン入門:読みやすく書きやすい文書作成の基本

はじめに

システム開発の世界では、たくさんの文書を作成する機会があります。仕様書、設計書、手順書、議事録など、種類も様々です。これまで、こうした文書作成にはWordやExcel、PowerPointといったツールがよく使われてきました。しかし、最近「マークダウン(Markdown)」という書き方が注目されています。特に、開発現場での情報共有やドキュメント作成で広く使われるようになってきました。

このレポートでは、「マークダウンって何?」「どんなところが便利なの?」「どうやって書くの?」といった疑問に、ITの学習を始めたばかりの方にも分かりやすくお答えします。ExcelやPowerPointに代わる新しい文書作成の方法として、マークダウンの基本を学んでいきましょう。

マークダウンとは?

マークダウンは、文章を書くための「書き方のルール」の一つです。コンピューターが理解しやすい特別な命令(タグ)をたくさん覚える必要はなく、普段使っているような記号(例えば #* など)を使って、文章に見出しをつけたり、箇条書きにしたり、文字を強調したりすることができます。

一番の特徴は、シンプルで覚えやすいこと、そして書いたそのままの状態でも読みやすいことです。Wordのように見た目を整えるための複雑な機能はありませんが、文章の構造(どこが見出しで、どこがリストかなど)を分かりやすく示すことに特化しています。

マークダウンで書かれた文章は、ただのテキストファイルなので、どんなパソコンやテキストエディタでも開いて編集できます。そして、専用のツールを使うと、HTML(ウェブページの元になる言語)やPDFといった、他の形式に簡単に変換することもできます。

なぜマークダウンが便利なの?

マークダウンが多くの開発者やライターに支持されているのには、いくつかの理由があります。

  1. 書くのが簡単で速い: WordやPowerPointのように、マウスでボタンをクリックして書式を設定する必要がありません。キーボードから簡単な記号を入力するだけで、文章の構造を整えられます。これにより、文章の内容そのものに集中して、スピーディーに書き進めることができます。

  2. 特別なソフトが不要: マークダウンはただのテキストなので、Windowsのメモ帳やMacのテキストエEditなど、どんなテキストエディタでも書くことができます。もちろん、VS Codeのような高機能なエディタを使えば、色付け(シンタックスハイライト)やプレビュー機能で、さらに便利に書くことができます。

  3. 読みやすい: マークダウンで使われる記号は、文章の流れを邪魔しないように考えられています。そのため、HTMLなどに変換する前の、書いたままの状態でも、どこが見出しでどこがリストなのかが直感的に分かりやすく、内容を把握しやすいです。これは、他の人が書いた文書を読むときや、後で自分が見返すときにとても役立ちます。

  4. 共有や再利用がしやすい: テキストファイルなので、メールで送ったり、チャットで共有したりするのが簡単です。また、Gitなどのバージョン管理システム(変更履歴を記録する仕組み)との相性が抜群です。誰がいつどこを変更したのかが分かりやすく、複数人での共同作業にも向いています。

  5. 色々な形式に変換できる: マークダウンで書いた文書は、Pandocなどのツールを使えば、HTML、PDF、Word文書など、様々な形式に変換できます。一度マークダウンで書いておけば、用途に合わせて出力形式を変えることが可能です。

マークダウンの基本的な書き方

ここでは、よく使われる基本的なマークダウンの書き方(記法)をいくつか紹介します。実際にテキストエディタで試しながら覚えるのがおすすめです。

見出し

文章のタイトルや章・節のタイトルを示すには、行頭に #(ハッシュマーク)をつけます。# の数で、見出しのレベル(大きさ)が変わります。# と見出し文字の間には半角スペースを入れるのが一般的です。

# 見出しレベル1 (一番大きな見出し)
## 見出しレベル2
### 見出しレベル3
#### 見出しレベル4
##### 見出しレベル5
###### 見出しレベル6 (一番小さな見出し)

段落

普通の文章(段落)は、 просто текст として記述します。段落と段落の間は、1行以上の空行を入れます。

これは最初の段落です。

これは次の段落です。間に空行を入れることで、別の段落として認識されます。

強調

文字を強調したい場合は、強調したい部分を *(アスタリスク)または _(アンダースコア)で囲みます。

  • *斜体* または _斜体_斜体
  • **太字** または __太字__太字
  • ***斜体かつ太字*** または ___斜体かつ太字___斜体かつ太字
  • ~~打ち消し線~~打ち消し線 (※これは拡張機能の場合があります)

リスト(箇条書き)

順序のないリスト(箇条書き)を作るには、行頭に *-(ハイフン)、+(プラス)のいずれかをつけます。記号の後には半角スペースを入れます。ネスト(入れ子)にする場合は、行頭にスペースを入れてインデント(字下げ)します。

- りんご
- みかん
  - 温州みかん
  - はっさく
- バナナ

*** 水色
  * 紺色
*

順序のあるリスト(番号付きリスト)を作るには、行頭に数字とピリオド . をつけます。数字の後には半角スペースを入れます。数字は 1. から始めれば、あとは自動で連番になります(1. だけを続けて書いても大丈夫な場合が多いです)。

1. まず、手を洗う。
2. 次に、材料を切る。
   1. 野菜を切る。
   2. 肉を切る。
3. 最後に、炒める。

リンク

ウェブページなどへのリンクを貼るには、[表示するテキスト](URL) の形式で書きます。

[Google](https://www.google.com)
[Qiitaのホームページ](https://qiita.com)

画像

画像を埋め込むには、リンクの書き方の先頭に !(エクスクラメーションマーク)をつけます。![代替テキスト](画像のURLまたはファイルパス) の形式です。代替テキストは、画像が表示されない場合に代わりに表示される文字です。

![ネコの画像](https://example.com/cat.jpg)
![ロゴ](/images/logo.png) // ローカルファイルの場合

引用

他の文章や発言を引用するには、行頭に >(大なり記号)をつけます。> の後には半角スペースを入れるのが一般的です。

> これは引用文です。
> 人の言葉を借りる時に使います。
>> 引用の中にさらに引用をネストすることもできます。

コード

プログラムのコードなどを表示したい場合があります。

  • インラインコード: 文中に短いコードを埋め込む場合は、コード部分を `(バッククォート)で囲みます。
    `printf("Hello, World!");` という関数を使います。
    
  • コードブロック: 複数行のコードを表示する場合は、コード全体を (バッククォート3つ)または `~~~`(チルダ3つ)で囲みます。開始の の後に言語名(例: python, java, javascript)を指定すると、色付け(シンタックスハイライト)されることが多いです。
    ```python
    def greet(name):
        print(f"Hello, {name}!")
    
    greet("Markdown")
    ```
    

水平線

話の区切りなどに水平線を入れたい場合は、行頭から ***---___ のいずれかを3つ以上続けます。ハイフンを使う場合は、直前の行がテキストだと見出しと間違われる可能性があるので、前後に空行を入れるのが安全です。

最初のセクション

---

次のセクション
***
最後のセクション

表(テーブル)

表を作成することもできます(これは拡張機能として扱われることが多いですが、広く使われています)。|(パイプ)で列を区切り、ヘッダー行の下に |---|---| のような区切り線を入れます。区切り線のハイフンの数や | の位置は揃っていなくても大丈夫ですが、揃えた方が見やすいです。コロン : を使うと、列内の文字揃え(左寄せ、中央寄せ、右寄せ)を指定できます。

| ヘッダー1 | ヘッダー2 | ヘッダー3 |
|---|:---:|---:|
| 左寄せ   | 中央寄せ | 右寄せ   |
| セル1-1  | セル1-2  | セル1-3  |
| セル2-1  | セル2-2  | セル2-3  |

マークダウンはどんな時に使う?

マークダウンはその手軽さと汎用性から、様々な場面で活用されています。

  • READMEファイル: ソフトウェアの使い方や説明を書くファイル(GitHubなどでよく見かけます)。
  • 技術ブログや記事: Qiita、Zenn、はてなブログなど、多くの技術ブログサービスがマークダウンに対応しています。
  • 議事録やメモ: 会議の内容や日々のメモを素早く構造的に記録するのに便利です。
  • 簡単な仕様書や設計書: 文章中心のドキュメントであれば、マークダウンで十分に記述できます。
  • チャットツールでのメッセージ: SlackやTeamsなど、一部のチャットツールではマークダウン記法でメッセージを装飾できます。
  • 静的サイトジェネレータのコンテンツ: Webサイトのコンテンツをマークダウンで記述し、HTMLを自動生成するツール(Jekyll, Hugoなど)で使われます。

注意点

マークダウンは非常に便利ですが、いくつか知っておくと良い点があります。

  • 方言(Flavor)がある: マークダウンには、基本的な仕様(CommonMarkなど)の他に、GitHub Flavored Markdown (GFM) のように、独自の拡張機能を追加した「方言」が存在します。例えば、表の書き方や打ち消し線、チェックリストなどは、方言によってサポート状況が異なります。どの環境で使うかによって、使える記法が少し違う場合があることを覚えておきましょう。
  • 複雑なレイアウトは苦手: WordやPowerPointのように、文字のフォントや色、サイズを細かく指定したり、画像を自由な位置に配置したりといった、複雑なレイアウト調整は基本的にできません。あくまで文章の構造を示すためのものです。
  • プレビュー環境があると便利: 書いたマークダウンがどのように表示されるか(レンダリング結果)を確認するには、プレビュー機能のあるエディタやツールを使うと便利です。書いている途中でも、最終的な見た目を確認しながら作業できます。

まとめ

マークダウンは、シンプルな記号を使って、誰でも簡単に構造化された文書を作成できる便利な書き方です。特別なソフトが不要で、書いたままの状態でも読みやすく、様々なツールとの連携も容易なため、特にシステム開発の現場で広く活用されています。

基本的な書き方はすぐに覚えられるので、まずは簡単なメモや議事録からマークダウンを使ってみるのがおすすめです。慣れてくれば、仕様書やブログ記事など、より多くの場面でその手軽さと効率の良さを実感できるはずです。ExcelやPowerPointとは異なる、テキストベースのドキュメンテーションの第一歩として、ぜひマークダウンをマスターしてみてください。

Accenture Japan (有志)

Discussion