初心者のためのマークダウン記法


はじめに

これからQiitaへ自分の知識のアウトプットや備忘録を書くぞ!と決意したが、
そもそもマークダウン記法の書き方すら知らなかった・・・。

そのため、マークダウン記法の自主練習も兼ねてマークダウン記法ついてアウトプットしていきたいと思う。

1.はじめに

下記のように、実際の表示例→マークダウンでの記入方法の順で紹介していく。

 【表示】
  ↓
 【記入法】

私が自分のために書き示す備忘録のようなもののため、本当に使用する記法だけを抜粋しています。

【参考サイト】
Markdown記法 チートシート

1.コードの挿入

【表示】

sample.rb
  puts "Hello World"

  ↓
【記入法】

```ruby:sample.rb
puts "Hello World"
```

バッククォートを3つ前後につけるとコードが表示される。前後に空行を入れる必要あり。
最初の行に「ruby:sample.rb」などとつけるとコードが言語に応じてカラーリングされ、左上にファイル名が表示される。
※Macの場合は、shiftキー+@のキーでバッククォートは表示される。

2.コードのインライン表示

【表示】
コードputs "Hello World"をインラインでも表示できる。

【記入法】
コード`puts "Hello World"`をインラインでも表示できる。

インラインしたい部分に''シングルクォーテーションをつける

3.テキストの装飾

ここは見ればわかるので羅列していきます。
【表示例】

H1見出し

H2見出し

H3見出し

H4見出し

これは イタリック体 です。

これは 太文字 です

これは 打ち消し線 です.

【記入例】
#H1見出し
##H2見出し
###H3見出し
####H4見出し

これは *イタリック体* です。

これは **太文字** です

これは ~~打ち消し線~~ です.

4.テキストの折り畳み

【表示例】

これはテキストを折り畳みます。
details.rb
puts "Hello World"

【記入例】
<details><summary>これはテキストを折り畳みます。</summary><div>

```rb:details.rb
puts "Hello World"
```

</div></details>

5.箇条書き・数字付き箇条書き・チェックボックス

【表示】

  • Disc型リスト1
  • Disc型リスト2
  • Disc型リスト3

【記入例】

* Disc型リスト1
* Disc型リスト2
* Disc型リスト3


【表示】

  1. Disc型リスト1
  2. Disc型リスト2
  3. Disc型リスト3

【記入例】

\1. Disc型リスト1
\2. Disc型リスト2
\3. Disc型リスト3


【表示】

  • Disc型リスト1
  • Disc型リスト2
  • Disc型リスト3

【記入例】

* [ ] Disc型リスト1
* [x] Disc型リスト2
* [x] Disc型リスト3

6.引用

【表示】

これは引用文です

これはネストした引用文です

【記入例】
>これは引用文です
>>これはネストした引用文です

7.リンク

【表示】

こちらはリンクです

【記入例】
[こちらはリンクです](https://qiita.com/Qiita/items/c686397e4a0f4f11683d#gist%E9%80%A3%E6%90%BA%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6--2019%E5%B9%B41%E6%9C%888%E6%97%A5%E6%8F%90%E4%BE%9B%E7%B5%82%E4%BA%86 "qiitaのトップページ")

8.画像の埋め込み

【表示】

【記入例】

![画像を埋め込みます](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/765745/0892f57f-08ae-0247-ef2a-e95565a52bb2.png
"画像タイトル")

おまけ

バックスラッシュ[]をMarkdownの前に挿入することで、Markdownをエスケープ(無効化)することができます。