どうも、Typhonです。
初投稿です。
本記事の内容
- Markdown記法に関する必要最低限の知識
Markdownとは
一言で表すと 「タグの要らないHTML」
マークアップ言語(HTML等)をより簡略化して記述することを目的に、John Gruberらが2004年に開発(軽量マークアップ言語)
特徴
1. 手軽な文章構造の明示
見出しや箇条書きなどの文章構造を簡単な記号のみで簡単に実装可能
構造化されると文章が非常に見やすい
2. 高い可読性
タグが不要であるため、コードリーディングしやすい
ノンプログラマーにも優しい
3. 使えるプラットフォームを選ばない
OSを問わずに使用でき、実際に多くのプラットフォームで使用されている
インデックス
見出し
箇条書きリスト
番号付きリスト
段落と改行
テキストの装飾
インライン
コードブロック
水平線
外部リンク
ページ内リンク
画像挿入
見出し
6段階の大きさの見出しを生成する
記法
# 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5 ###### 見出し6
表示例
見出し1
見出し2
見出し3
見出し4
見出し5
見出し6
箇条書きリスト
ハイフン+半角スペースで生成
入れ子構造のリストも生成可能
記法
- リスト1
- リスト1-1
- リスト1-2
- リスト1-2-1
- リスト2
表示例
- リスト1
- リスト1-1
- リスト1-2
- リスト1-2-1
- リスト2
番号付きリスト
数字+ピリオド+半角スペースで生成
数字を適当に記述しても、表示の際は勝手に修正して表示してくれるので便利
記法
1. リスト1
1. リスト1-1
1. リスト1-2
1. リスト1-2-1
1. リスト2
表示例
- リスト
- リスト
- リスト
- リスト
- リスト
段落と改行
段落は空白行を挟むことで生成
改行は行末に半角スペースを挟むことで生成
記法
文末に半角スペース2つを入れた場合、(半角スペース×2) 改行をすることが出来ます。 半角スペースを入れなかった場合、(半角スペースなし) 改行することはできません。
表示例
文末に半角スペース2つを入れた場合、
改行をすることが出来ます。
半角スペースを入れなかった場合、 改行することはできません。
テキストの装飾
文字を太字、 斜体 、取り消し線で装飾する場合は、アスタリスク(*)とチルダ(~)の記号を用いる。
記法
**Bold** *Itaric* ~~Strikethrough~~ **_Bold & Itaric_**
表示例
Bold
Itaric
Strikethrough
Bold & Itaric
インライン
短いコードを文中に表示したい場合、バッククォート(`)1つでコード表記したい範囲を囲む
記法
Hello World!を出力するには、`print("Hello world!")`と入力します。
表示例
Hello World!を出力するには、print('Hello world!')と入力します。
コードブロック
まとまったコードを記述したい場合、バッククォート(`)3つでコード表記したい範囲を囲む
記法
```
for i in range(10):
print(i)
```
表示例
for i in range(10):
print(i)
水平線
アンダースコア(_)、アスタリスク(*)、ハイフン(-)等を3つ以上連続して記述
太さや色の変更にはHTML/CSSの知識が必要
記法
___ *** ---
表示例
外部リンク
リンク: 別ページや外部サイトと繋がっている文字やボタンを指す
指定したURLや飛ぶことが出来る
記法
[Google](https://www.google.co.jp/)
表示例
ページ内リンク
同じページ内の特定の個所に飛ぶことが出来る
目次などで使用
記法
[インデックスへ飛ぶリンク](#インデックス)
表示例
画像挿入
- 多くの場合、「右クリック→画像アドレスをコピー」で画像のアドレスを取得可能
(著作権には注意) - リンク付き画像にもできる
記法
通常の画像  リンク付き画像 [](https://www.flaticon.com/free-icon/typhon_1218742)
表示例
通常の画像
リンク付き画像(こちらのフリー画像を取得したサイトに飛びます)
