#はじめに
Qiitaを書く際に使われるMarkdown記法について自分なりにまとめてみました。Qiita及びMarkdown記法によるドキュメント作成の参考にしていただけたら幸いです。
##目次
- 見出しの書き方
- 黒背景(コードブロック)の書き方
- 斜体文字と太文字の書き方
- 引用及び二重引用
- 打ち消し線
##見出しの書き方
この上に書かれている「見出しの書き方」という大きな文字は次のように書くことで表すことができます。
###記述例
#見出しの書き方
#は半角で書き、#の数を変えていくことで徐々に大きさを小さくしていくことができます。
###表示例
#この見出しは#が1つ
##この見出しは#が2つ
###この見出しは#が3つ
####この見出しは#が4つ
#####この見出しは#が5つ
######この見出しは#が6つ
とこのように大きさが小さくなっていきます。6段階の大きさを設定できるようですが、最後の5段階目と6段階目の違いは自分にはいまいちわかりません。
#黒背景(コードブロック)の書き方
見出しの書き方にも出てきた黒い背景にする方法としては、文書の前後をバッククオーテーション3つ(```)で囲む必要があります。以下のように書くと、
###記述例
(空白行)
‘‘‘
print("Hello World")
‘‘‘
(空白行)
例のため、ここでのバッククオーテーションは全角
###表示例
print("Hello World")
とこのように書くことができます。この状態であれば、黒背景の右上に出てくるボタンをクリックすることで簡単にコピーすることができます。さらに、この黒背景ではファイル名を入れることができます。その方法としては次のように書くだけです。
###記述例
(空白行)
‘‘‘py:hellow.py
↑[言語名:ファイル名]と書く
print("Hello World")
‘‘‘
(空白行)
###表示例
print("Hello World")
とこのようにコードブロックの左上にファイル名を書くことができました。言語名によって勝手に色が変わるようです。また、色を付けたいだけであれば「言語名:ファイル名」の言語名だけの部分で大丈夫です。ファイル名はつきませんがこれも言語によって勝手に色が変わります。
#斜体文字と太文字の書き方
斜体文字と太文字はそれぞれ次のように書くことで表せます。
###記述例
*Hello*
↑斜体で協調したい英数字を*(アスタリスク1個)で囲む。
**Hello**
↑太文字で強調したい箇所を**(アスタリスク2個)で囲む。
###表示例
斜体文字 : Hello 太文字 : Hello
#引用及び二重引用
>を先頭に書くだけです。>>とすることで二重に引用することもできます。>を増やしていくことで何重にも引用することができますが、使い道はあまりなさそうです。
###表示例
>を1個先頭につけることでこのように書ける。
>を2個先頭につけることでこのように書ける。
>が3個はこのようになり、以降増えていくがが使い道はなさそう
#打ち消し線
打ち消し線を書くためには以下のように書きます。~~で文章を挟むように書くと打ち消せます。
###記述例
〜〜打ち消したい文章をこのように〜〜で囲む〜〜
###表示例
打ち消したい文章を〜〜で囲む
#水平線
_(アンダーバー) , *(アスタリスク) , -(ハイフン)を3つ以上連続で記述することで水平線を表すことができます。
###記述例
---
***
___
###表示例
#リンク関連
##リンクテキスト
単純にリンクを載せたい場合は次のように書けばいいです。[名前](リンク先のURL)という形で書きます。
###記述例
[Qiita](https://qiita.com)
###表示例
Qiita
##リンク(タイトル・画像付き)
飛びたいリンク先のURLを張るだけで次のようになります。
###記述例
https://qiita.com
###表示例
https://qiita.com
#気になるページをMarkdown記法で見る
Qiitaを見ている中で書き方がいまいち分からないといった場合にはMarkdown記法で見たいURLの最後に.mdと書くだけでそのページの書き方を見ることができます。
#あとがき
あまり内容を書いていませんが今回のところはこれまでにしておきます。時間があったら随時ページを更新していきたいです。