はじめに
久しぶりにQiitaで記事を投稿しようとしたときに、Markdownの書き方をすっかり忘れてしまっていたので、Markdown記法の備忘録を残すことにしました。
個人的によく利用するものを抜粋し、記法の注意点などをまとめております。
Markdownとは
Markdown(マークダウン)は、簡単な記号を使って文章の構造や装飾を指定できる記述方法です。
HTMLに変換可能というメリットがあります。
Markdown記法一覧
見出し
"#
"(シャープ)を先頭に付けることで、見出しとしてその行を大文字にすることができます。
1~6つまで、"#
"の数を増やすことで、文字サイズが異なる見出しを書くことができます。
"#
"と見出し文字の間には、半角スペースを1つ入れる必要があります。
Qiitaでは、見出しの左側に自動的にリンクが貼られます。
記述例
表示例
1行目
2行目
3行目
4行目
5行目
6行目
リスト
"-
"(ハイフン)、"+
"(プラス)、"*
"(アスタリスク)のいずれかを先頭につけることで、リストとして箇条書きにすることができます。
インデントを付けることで、ネストを深くしたリストを書くことができます。
"-
"、"+
"、"*
"と文字の間には、半角スペースを1つ入れる必要があります。
記述例
表示例
- 見出し1
- 見出し2
- 見出し2_1
- 見出し2_2
- 見出し2_2_1
- 見出し2_2_2
- 見出し2_2_2_1
- 見出し3
- 見出し3_1
番号付きリスト
"1.
"のような数値+半角ドットを先頭に付けることで、番号付きリストにすることができます。
インデントを付けることで、ネストを深くした番号付きリストを書くことができます。
数値の部分は表示される際に自動的に適切な番号で表示されます。
数値+半角ドットと文字の間には半角スペースを1つ入れる必要があります。
記述例
表示例
- 見出し1
- 見出し2
- 見出し2_1
- 見出し2_2
- 見出し3
外部リンク
外部のWebサイト等のURLリンクを貼るときに使います。
"[表示名](リンク先)
"を記載することで、"[]
"(大かっこ)に記述した文字内に"()
"(小かっこ)に記述したリンクを挿入することができます。
記述例
表示例
内部リンク
ページ内の見出しのURLリンクを貼るときに使います。
"[表示名](#リンク先の見出し)
"を記載することで、"[]
"(大かっこ)に記述した文字内に"()
"(小かっこ)に記述したリンクを挿入することができます。
記述例
表示例
表
以下の3つの要素から表を挿入することができます。
1. ヘッダー行:表の一番上の行で、見出しを記述します
2. 区切り行:ヘッダー行とデータ行の間に記述する行です
3. データ行:区切り行の下の行で、データを記述します
記述方法
テーブルの各列は"|
"(バーティカルバー)で区切ります。
1.ヘッダー行
ヘッダー行は、"|
"の間に表示したい文字を記述します。
ヘッダー行は自動的に太字で記述されます。
2.区切り行
区切り行は"|
"の間に"-
"(ハイフン)を記述します。
区切り行の"-
"と":
"(コロン)を組み合わせることで、以下のようにデータ行の配置位置を変えることができます。
・左寄せ:":-----
"(コロンを左側に置く)
・中央揃え:":-----:
"(コロンを両側に置く)
・右寄せ:"-----:
"(コロンを右側に置く)
※"-
"のみの場合は、左揃えとなります
3.データ行
データ行は、"|
"の間に表示したい文字を記述します。
必要なデータの数だけデータ行を下に記述することができます。
"<br>
"タグを記述することで、表内で改行することができます。
記述例
表示例
ヘッダー1 | ヘッダー2 | ヘッダー3 | ヘッダー4 |
---|---|---|---|
データA | データB | データC | データD |
左揃え | 中央揃え | 右揃え | 指定なし |
a | b | c | 改行 できます |
文字フォント等の変更
網掛け
文字を"``
"(バッククォート)で囲むことで、その文字を網掛けにすることができます。
記述例
表示例
文字を網掛け
にします
斜体
文字を"*
"(アスタリスク)もしくは"_
"(アンダースコア)で囲むことで、その文字を斜体にすることができます。
※"_
"の場合は、前後の文字との間に、半角スペースを1つ入れる必要があります。
※日本語の場合は、斜体にすることができません。
記述例
表示例
文字をsyataiにします
文字を syatai にします
太字
文字を"**
"(アスタリスク)もしくは"__
"(アンダースコア)2つで囲むことで、その文字を太字にすることができます。
※"__
"の場合は、前後の文字との間に、半角スペースを1つ入れる必要があります。
記述例
表示例
文字を太字にします
文字を 太字 にします
太字の斜体
文字を"***
"(アスタリスク)もしくは"___
"(アンダースコア)3つで囲むことで、その文字を太字の斜体にすることができます。
※"___
"の場合は、前後の文字との間に、半角スペースを1つ入れる必要があります。
※日本語の場合は、斜体にすることができません。
記述例
表示例
文字を太字のsyataiにします
文字を 太字のsyatai にします
訂正線
文字を"~~
"(チルダ)2つで囲むことで、その文字に訂正線を入れることができます。
記述例
表示例
文字を取り消しします
引用
">
"(大なり記号)を先頭に付けることで、その行を引用した表示にすることができます。
">
"の数を増やすことで、二重、三重に引用することができます。
記述例
表示例
引用しています
さらに引用しています
もっと引用しています
すごく引用しています
水平線
"-
"(ハイフン)、"_
"(アンダースコア)、"*
"(アスタリスク)のいずれかを3つ以上連続して記述することで、水平線を挿入することができます。
連続する記号の間には、スペースがあっても水平線を挿入できます。
記述例
表示例
1
2
3
4