0. この記事を読んで分かること
- 初心者向けの意味
- 記法一覧
- 具体的な書き方と見え方
- おわりに
※しまぶーのIT大学【完全保存版】マークダウン記法を参考に書きました。
初心者の方はぜひ見てみてください。めちゃめちゃ分かりやすいです。
1.初心者向けの意味
結論:エンジニアなら必ず使うから、最低限の書き方を知って、使って欲しい!
マークダウンはメモを取る時などに使う記法の一種です。「Qiita」もマークダウンを使って記事を投稿します。アプリの説明文にもなる「README」もマークダウン記法ですね。私はこのマークダウンを使って記事を書くことに抵抗がありました。しかも不特定多数の人に記事を見られるなんて…
ですが、「最低限の記法を知ってQiitaを書いてみればいいんじゃね?」ってことで、7つの最低限必要な記法をなるべく分かりやすく以下に書いてみました。
2.今回扱う記法一覧
見出し→①
見出し
見出し
- リスト形式→②
- リスト形式
- 番号リスト形式→③
- 番号リスト形式
引用表示→④
斜線、太字、打ち消し線→⑤
ブロックを表示→⑦
input = gets.to_i
if input > 10
puts "10より大きい数字です"
elsif input <= 0
puts "0以下の数字です"
else
puts "10以下の数字です"
end
3.具体的な書き方と見え方
①見出し
#これが見出しです ##シャープを増やすと ###文字が小さくなります。 ####ご確認くださいませ。
↓こうなります↓
これが見出しです。
シャープを増やすと
文字が小さくなります。
ご確認くださいませ。
②リスト形式(箇条書き)
- ハイフン押して、半角スペース - これで箇条書きになります。 - Tabを押してからハイフン半角スペースをすると、ネストが可能です。 - 黒丸から白丸に変わっていますね。
↓こうなります↓
- ハイフン押して、半角スペース
- これで箇条書きになります。
- Tabを押してからハイフン半角スペースをすると、ネストが可能です。
- 黒丸から白丸に変わっていますね。
③リスト形式(番号)
1. 基本的には箇条書きと一緒です。 1. 頭を数字にすれば番号リストになります。 1. ポイントは、全て「1.」でも番号順になってくれること。 1. これは、後で番号順を書き直す時に手間が減って便利です。
↓こうなります↓
- 基本的には箇条書きと一緒です
- 頭を数字にすれば番号リストになります。
- ポイントは、「1.」でも番号になってくれること。
- これは、後で番号順を書き直す時に手間が減って便利です。
- もちろんネストも可。番号も自動的に1.となります。
④引用表示
山カッコ(>)、半角スペースで文字を打つと引用表示ができます。
↓こうなります↓
山カッコ、半角スペースで文字を打つと引用表示ができます。
⑤斜体、太字、打ち消し線
*アスタリスク一つで囲むと太字* **アスタリスク2つで囲むと斜体** ~~波線2つで囲むと打ち消し線~~
↓こうなります↓
アスタリスク一つで囲むと斜体
アスタリスク2つで囲むと斜体
アスタリスク3つで斜体&太字
波線2つで囲むと訂正線
⑥リンク表示
[google](https://www.google.com/) [各カッコ内に表示名](丸カッコにリンク)を書けば、リンク表示できます。
↓こうなります↓
google
各カッコ内に表示名を書けば、リンク表示できます。
⑦ブロック
「```」 バッククオート3つで上下を囲むことでブロックを表示できます。 (実際に打つ時は「」は必要ありません。今は強調のため書いています。) また「```ruby」と言語を追加してあげると、その言語にあったハイライトを勝手にしてくれます 「```」
↓こうなります↓
input = gets.to_i
if input > 10
puts "10より大きい数字です"
elsif input <= 0
puts "0以下の数字です"
else
puts "10以下の数字です"
end
3. おわりに
自分の勉強がてら、マークダウン記法の記事を書いてみました。やっぱり実際に書いてみることが大事ですね。私も書いていくうちに少し慣れてきた感があります。
自分が勉強している言語に加えて、マークダウンもサクサク書けるようQiitaで練習!