読者です 読者をやめる 読者になる 読者になる

はい!今やってます!

Work Pertly, Live Idly

【Markdown】基本さえ知れば十分なマークダウン記法

Markdown記法について

このブログの記事の編集方法をMarkdown記法に変更しました。
主にManualをMarkdown記法で記述してgitでも管理するようにしようと考えています。
HTMLのシンタックスシュガー程度にしか捕らえてないのですが、互換性があって手順書等の保存にも最適な気がしたので、 Markdownを学習する事にしました。
今回自分の作業用に必要十分だと思うものだけ記載しています。特に複数の記載方法を持つシンタックスについても自分の気に入った書き方のみを記載しています。

目次

  1. 見出し
  2. パラグラフ, 改行, 水平線
  3. 文字装飾(斜体, ボールド)
  4. ブロッククオート
  5. コードブロック
  6. リスト(番号無し, 番号ありリスト)
  7. リンク
  8. エスケープ

1.見出し

文章の大きな構成要素となる見出しについては#という文字で表現します。
#を書いた数で見出しのレベルが指定でき# 〜 ######の6レベルで指定可能です。

見出し(レベル1)

見出し(レベル2)

見出し(レベル3)

見出し(レベル4)

見出し(レベル5)
見出し(レベル6)

2.パラグラフ, 改行, 水平線

パラグラフ

記事を構成する上で文の要素、HTMLでいう<p> </p>に相当するパラグラフを扱うのが改行文字です。 改行文字だけの行を挿入する事でパラグラフを表現する事ができます。

文字列A

文字列B

文字列C

と記載することで

文字列A
文字列B
文字列C

と出力する事ができます。 ※いずれも別のパラグラフ要素に内包される。

改行

文章の途中で改行したい場合は、行末に(半角スペース)を2つ以上記載する事で文章を途中で改行させる事ができます。

1行目(ここに半角スペース2個以上)
2行目(ここに半角スペース2個以上)
3行目(ここに半角スペース2個以上)

と記載する事で

1行目
2行目
3行目

3.文字装飾(斜体, ボールド)

文字装飾が必要な場合には*というアスタリスク文字を使って、斜線とボールドを表現する事が可能です。

斜体

斜体を表現する場合は*(アスタリスク一つ)で文字を囲みます。
*斜体*
と記載する事でMarkdown記法では下記のように出力されます。

斜体

ボールド

ボールド(強調)を表現する場合は**(アスタリスク二つ)で文字を囲みます。
**強調**
と記載する事でMarkdown記法では下記のように出力されます。

強調

4.ブロッククオート

ブロッククオートが必要な場合には>という文字を使って、表現します。

>ブロッククオート1
>ブロッククオート2
>>ブロッククオートの入れ子

と記載する事でMarkdown記法では下記のように出力されます。

ブロッククオート1
ブロッククオート2

ブロッククオートの入れ子

5.コードブロック

コードブロックが必要な場合には```というバッククオートを使ってコードを表現します。

echo "Hello World!!"

と記載する事でMarkdown記法では下記のように出力されます。

echo "Hello World!!"'

6.リスト(番号無し, 番号ありリスト)

リストには番号無しリストと番号ありリスト2つの表現方法があります。

番号無しリスト

番号無しリストが必要な場合には-というダッシュ/ハイフンを使ってリストを表現します。

- (半角スペース)番号無しリスト1
- (半角スペース)番号無しリスト2
- (半角スペース)番号無しリスト3

と記載する事でMarkdown記法では下記のように出力されます。

  • 番号無しリスト1
  • 番号無しリスト2
  • 番号無しリスト3

番号ありリスト

番号ありリストが必要な場合には1という数字.(ドット)(半角スペース)を使って番号ありリストを表現します。

1. (半角スペース)番号無しリスト1
2. (半角スペース)番号無しリスト2
3. (半角スペース)番号無しリスト3

と記載する事でMarkdown記法では下記のように出力されます。

  1. 番号無しリスト1
  2. 番号無しリスト2
  3. 番号無しリスト3

7.リンク

リンクが必要な場合にはURL<>を使ってリンクを表現します。
<http://google.com> と記載する事でMarkdown記法では下記のように出力されます。

http://google.com

8.エスケープ

Markdown記法で特殊な意味を持つ文字#*,->の記載が必要な場合には対象の文字列の前に\をつける事で文字のエスケープが可能です。 \# と記載する事でMarkdown記法では下記のように出力されます。

#