はじめに
QiitaやConfluence、Redmineなどの管理ツール系でも使える、
Markdown記法について基本的なことをまとめていきます。
基本のキ
種類 | 記法 | 表記例 |
---|---|---|
見出し | 行頭に#(#の個数がH1~H6) | #見出し1 ##見出し2 |
斜体 | テキストの前後に * または _ | *斜体* |
太字 | テキストの前後に ** | *太字* |
絵文字 | [☺]ボタン、または :emoji:で 絵文字が書ける(: に続いて"angel"とか入力すると入力候補が表示される) | ![]() |
訂正線(取り消し線) | - [ ] チェックOFF, - [x] チェックON | - [ ] - [x] ※チェックONの[]内に記載するのはx(エックス) |
チェックリスト | テキストの前後に ~~ | ~~訂正線~~ |
下線 | テキストの前後に <u> | <u>下線</u> ※Qiitaの場合は<INS>下線</INS> |
エスケープ | Markdown記法の前に \ | Markdown記法の前に \(例を書けず) |
リスト | 行頭に*または- | * リスト項目 * リスト項目 * リスト項目 |
番号付リスト | 行頭に 数字. | 1. リスト項目 2. リスト項目 3. リスト項目 |
引用 | 行頭に> | >メールの返信と同じ |
ソースコード | テキストの前後に` | `npm run dev` |
区切り線 | 3つ以上の * か _ または – | - - - |
表 | | で整形 | | No | 氏名 | 保有資格 | | :--: | :----------------- | : | - - -: | :----------------- | : | | 1 | ゴルゴンゾーラ | プロジェクトマネージャ | |
リンク | [タイトル](リンク先URL)\ | [Qiita](https://qiita.com) |
リスト
表だけだと少々分かりづらいので、リストに関しては例と実際の見え方を交えて記載する
箇条書きリスト
行頭にハイフン- 、アスタリスク* 、プラス+のいずれか付ける。字下げしたい場合はTabキーか半角スペース4つ。
(記載例)
- リスト1
- リスト2
- Tabキーで半角スペース4つインデント(字下げ)
* リスト1
* リスト2
* Tabキーで半角スペース4つインデント(字下げ)
+ リスト1
+ リスト2
+ Tabキーで半角スペース4つインデント(字下げ)
(実際の見え方)
- リスト1
- リスト2
- Tabキーで半角スペース4つインデント(字下げ)
- リスト1
- リスト2
- Tabキーで半角スペース4つインデント(字下げ)
- リスト1
- リスト2
- Tabキーで半角スペース4つインデント(字下げ)
番号付きリスト
行頭に "数字."をつけ、字下げしたい場合はTabキーか半角スペース4つ。
(記載例)
1. 番号リストA
1. 番号リストB
1. 番号B-1【Tabキーか半角スペース4つでインデント(字下げ)】
1. 番号B-2【Tabキーか半角スペース4つでインデント(字下げ)】
1. 番号リストC
(実際の見え方)
- 番号リストA
- 番号リストB
- 番号B-1【Tabキーか半角スペース4つでインデント(字下げ)】
- 番号B-2【Tabキーか半角スペース4つでインデント(字下げ)】
- 番号リストC
アコーディオン
アコーディオン形式で展開と非展開状態とで表示可能とする
(記載例)
<details>
<summary>タイトル</summary>
内容
</details>
(実際の見え方)
タイトル
内容注釈
(記載例)
テキスト1の注釈[^1]
テキスト2の注釈[^2]
[^1]: テキスト1の注釈
[^2]: テキスト2の注釈
補足:Qiitaで文字色を変えたい場合
<font color="red">**赤色の文字色**</font>
と記載すると、以下のようになる
赤色の文字色
※この記事が分かりやすいです
https://qiita.com/tommy_aka_jps/items/7ad9e53872532336de38
以上