Excel使いの中年エンジニアが挑む！ Markdown記法克服ガイド

1. はじめに

私はもうすぐ40歳になる中年エンジニアです。

これまでExcelを使用してドキュメント作成してきましたが、最近様々な案件に触れるにあたり、Markdown記法で記載できると便利であると痛感するようになりました。

この記事では、Markdown記法の基本概念や、Markdown記法を始めるにあたっての躓きポイントを紹介します。
同じような状況でMarkdown記法に興味を持っている方や、Markdown記法で書き始めたばかりの方のハードルを下げられればと考えています。

2. Markdown記法とは？

テキストを構造化するための軽量なマークアップ言語です。Markdownは「記号」を使って文章を装飾することが特徴です。例えば、見出しは行頭に#をつけ、太字にしたいときは単語を**で囲みます。これらをプレビューすると、それらしく見えるわけです。

「それの何が素敵なの？」と思われた方のために、Excelと比較してみます。

Excelと比べていいところ

• 2-1. 様々なプラットフォームで使用できる共通言語である（GitLab、Slack、Backlog等）^[1]
• 2-2. 文字強調（色の変換、太字、罫線等）がライティングの中で容易に行える
• 2-3. テキストデータなので差分が分かりやすい

最初はとっつきにくく感じますが、慣れてしまえばライティングのスピードが上がり、異なるプロジェクト・開発環境においても汎用的に使えるため便利になるということです。

3. 私のつまずきポイント別解説

ここからは、私が乗り越えるのに大変だったつまずきポイントと、乗り越え方を紹介します。

「Markdown記法の基本を説明してほしかった！」と思われた方は、そのような内容の見やすい文献はたくさん出回っているので、そちらをご参考ください。

3-1. 改行どうやってやるの？ ！

Markdown記法では、Enterを押しただけではプレビューしても改行されないため、本当に初期で躓きました。以下のいずれかの方法で改行されます。

• 解決策1：2回改行する
• 解決策2：文末に半角スペース2つ入力
• 解決策3：\（バックスラッシュ）入力
• 解決策4：<br>を入力
  ※個人的に解決策2が入力しやすさにおいておすすめです

`プレビュー方法`

VSCodeで記載している場合は、Ctrl + Shift + Vでプレビューを表示できます（プレビューの方法は各ツールによって異なります）。

3-2. 引用記号>が使いづらい！

>を使用すると引用のように見せることができますが、行が膨らんでしまったり、引用内の改行もややこしく、使いづらく感じていました。そんなとき、バッククォート「`」がしっくりくることを知りました。

• インラインコード: 文字列のように、文中の特定の単語を強調したいときに使う方法。

  これは`インラインコード`の例です。
  

  プレビュー結果
  　 これはインラインコードの例です。

• コードブロック: ```（バッククォート3つ）で複数行を囲み、引用のように使う方法。

  ```
  これは
  コードブロック
  の例です。
  ```
  

  プレビュー結果

  これは
  コードブロック
  の例です。
  

3-3. 読みやすいリスト構造を記載したい！

リスト構造を記載する際に、箇条書きや番号付きリストを使用すると、ネストが深い場合でも読みやすい形で表現できます。最初は、インデントが合っておらずプレビューしてもうまく表現されない等の苦労はありましたが、記載を2-3回繰り返せば慣れていきます。

• 箇条書き

  - 項目1
    - サブ項目1-1
    - サブ項目1-2
  - 項目2
  

  プレビュー結果
  • 項目1
    • サブ項目1-1
    • サブ項目1-2
  • 項目2
• 番号付きリスト

  1. 項目A
     1. サブ項目A-1
     2. サブ項目A-2
  2. 項目B
  

  プレビュー結果
  1. 項目A
     1. サブ項目A-1
     2. サブ項目A-2
  2. 項目B

3-4. 柔軟な形で表形式に表すには…

Markdown記法でExcelのような表形式を表現する方法はあります！　が、Markdown記法で書くと、以下のようにExcelよりも遥かに大変です。

| ヘッダー1 | ヘッダー2 | ヘッダー3 |
| :---: | :---: | :---: |
| データ1A | データ1B | データ1C |
| データ2A | データ2B | データ2C |

プレビュー結果

ヘッダー1	ヘッダー2	ヘッダー3
データ1A	データ1B	データ1C
データ2A	データ2B	データ2C

なお、Excelで作成した表をコピー&ペーストすると自動で変換してくれるツールも出回っていますので、比較的作成のハードルが下がっています！

`変換ツールの紹介`

Excelライクに入力・Excelからコピー&ペーストすればMarkdown表記に変換してくれるツール
https://notepm.jp/markdown-table-tool

4. まとめ

Markdownはこわくない！
記載したように、必要最低限のことはMarkdown記法で実現できます！　また、プログラミング言語と比較すると覚える事も少ないので、新しい言語に触れることが好きな人はまずは書いてみることをお勧めします！

この記事が、Markdownの食わず嫌いな方の最初の一歩を踏み出せるひとつになれば幸いです。

---

脚注

1. プラットフォームによって、対応していない機能もありますので注意が必要です。