📌

マークダウン記法に則ってブログを書こう

2023/04/24に公開

なぜマークダウン記法に則った書き方が重要なのか?

マークダウン記法は構造的に整理されており、文章を綺麗に書くことができるようになります。
そのことにより読み手が読みやすくなります。文章構成を意識することが重要です。

また、「こう書いたら読みにくいかもしれないから、こう書こう」と常に読む人の気持ちを想像して書くことにより、より読みやすい内容になります。

構造が整理された文章

次に、構造的に整理された文章とはどのような文章なのか。特に重要な3つのことを具体的に例を用いてお伝えします。

1.見出し

以下のように#を利用することにより、見出しの大きさを変更できます。

見出し1

# 見出し1

見出し2

## 見出し2

見出し3

### 見出し3

見出し4

#### 見出し4

2.リスト

-を利用することにより、リストにできます。

  • Hello, APPRENTICE!
- Hello, APPRENTICE!

また、番号付きリストはそのまま数字で表記します。

  1. Hello, APPRENTICE!
  2. Hello, World!
1. Hello, APPRENTICE!
2. Hello, World!

3.コードブロック

コードは「```」で挟むことでブロックとして挿入できます。以下のように言語を指定するとコードへ装飾(シンタックスハイライト)が適用されます。今回はRubyで記載してます。
また言語:ファイル名と:区切りで記載することで、ファイル名がコードブロックの上部に表示されるようになります。

hello.rb
def name
  Hello, World!
end

まとめ

今回のマークダウン記法はほんの一例です。様々なマークダウン記法を駆使することによって、より細かい表現が可能になります。身に付くには実際にやってみるのが一番だと思いました。
  また、文章構成を意識することは、相手にわかりやすく伝えることと関連します。これはマークダウン記法に限らず、コードを書く際や実際に会話するときにも役立ちます。広義の意味で考えると非常に大事な内容だったと改めて実感することができました。

Discussion