ITエンジニアには必須マークダウン記法
エンジニアをしていく上では必須スキルになります。
これを身につけることにより、記法がシンプルになり分かりやすくなります🌱
なんなら、時短にも繋がるのでこの機会に覚えておくとスキルアップに貢献していくことでしょう✨
初めてのマークダウン記法てなに?
マークダウン記法(Markdown)は、文章を「簡単なルール」で装飾できる書き方のことです。
例えば、文章を書くときに、見出しを付けたり、文字を強調したり、箇条書きを作ったりしますよね😺
その文章表現を難しいプログラミング言語を使わずに、シンプルな記号で表現できます。
特徴
-
シンプル:# や * など、身近な記号を使うだけ
-
わかりやすい:装飾がなくても普通のテキストとして読める
-
幅広く使える:ブログ記事、ノート、GitHubのREADME、チャットツールなど多くの場所で使われている
たとえば、
# 見出し
**太字**
- 箇条書き
と書くと、次のように表示されます。
見出し
太字
- 箇条書き
つまり「読みやすさ」と「書きやすさ」を両立した文章フォーマットが、マークダウン記法です。
必要なマークダウン記法をまとめてみた
マークダウン記法には種類が沢山あります。
それを表でまとめたので、実際につかって覚えてくださいね。
機能 | 記法 | 表示例 | 補足・説明 |
---|---|---|---|
見出し1 | # タイトル |
# タイトル | 行頭に # 1つと半角スペース。 |
見出し2 | ## タイトル |
## タイトル | 行頭に # 2つと半角スペース。 |
見出し3 | ### タイトル |
### タイトル | 行頭に # 2つと半角スペース。 # の数を増やすと見出しが小さくなる(最大6まで)。 |
太字 | **太字** |
太字 | 文字の前後をアスタリスク2つ。 |
斜体 | *斜体* |
斜体 | 文字の前後をアスタリスク1つ。 |
太字+斜体 | ***強調*** |
強調 | 文字の前後をアスタリスク3つ。 |
箇条書き |
- 項目 または * 項目
|
- 項目 | 行頭に「-」の後に半角スペース。 |
番号付きリスト | 1. 項目 |
1. 項目 | 行頭に数字(ピリオド付)+半角スペース。 |
チェックリスト | - [ ] やること |
- [ ] やること | リスト形式。[ ] で空欄、[x] でチェック済みにできる。 |
リンク | [表示名](URL) |
Webサイトなどへのリンクを貼れる。 | |
画像表示 |  |
![]() |
リンクの記法前にビックリマークを付ける。 |
引用 | > 引用文 |
> 引用文 | 行頭に「>」+半角スペース。 |
コード(1行) | `コード` |
コード |
コードや命令を文中で目立たせたいとき。バッククォート1つで囲む。 |
コードブロック(複数行) | <br>コード<br> |
<br>コード<br> |
バッククォート3つで囲む。シンタックスハイライト指定も可能。 |
区切り線 |
--- または ***
|
--- | 3つ以上のハイフン、アスタリスク、アンダースコアで水平線を挿入。 |
まとめ
シンプルに表現できるのはいいのですが…💦
種類が多くて覚えるのが大変です。文章を打つ中で実際に使っていけば覚えていくことができます☺️🌱
まずは見出し、太文字、箇条書きから覚えていき
ちょっとずつ覚えていくいけばいいでしょう