More than 5 years have passed since last update.

知っておくべき最低限のMarkdown記法

Posted at 2019-07-21

GitのReadmeやQiita等で使用されているMarkdown記法。
就職先のプロジェクト管理ツールがMarkdown記法なので、入社前に少しでも覚えておくと楽だよとアドバイスもらったので、どうせなら自分が見やすい理解しやすいようにQiitaにまとめようと思い記事にしています。

Markdown記法については多くの記事がありますがあえて自分の手でまとめています。

Markdown記法の何を覚えればいいの？

正直、エンジニアがプロジェクト管理の中で使用するMarkdown記法ってどんなものがあるのかまったく想像がつきません。
なので、エンジニア歴4年の我が家のメンター様(旦那)にアドバイスをもらい、よく使いそうなもののリストを作ります。

入社前の限られた時間ですべてのMarkdown記法を覚えることは不可能ですからね。
似たような境遇の方がいらっしゃったら、参考にしていただければと思います。

このあたりをおさえておけば一先ずは乗り切れるのではないでしょうか。
上記以外のMarkdown記法については、使用する際に調べるので問題ないと判断しました。

# を先頭に記述することで「見出し」にすることができます。
Markdown記法ではh1～h6まで記載可能です。

# 見出し１(h1)
## 見出し２(h2)
### 見出し３(h3)
#### 見出し４(h4)
##### 見出し５(h5)
###### 見出し６(h6)

- を先頭に記述することで箇条書きにできます。

- テキスト１
　- テキスト２

|---|---| で区切って記述すればテーブル表記になります。
:--- で左揃え、:---: で中央揃え、---: で右揃えになります。
特に指定しなければ左揃えになります。

|りんご|ごりら|らっぱ|
|:---|:---:|---:|
|パイナップル|ルビィ|イルカ|
|柿|キムチ鍋|ベルギー|
|イカスミ|みんみんぜみ|みみずく|

[リンク名](URL)でリンク表記になります。

[Google](https://www.google.com)

> を先頭に記述することで引用表記になります。

テキスト１

テキスト２

> テキスト１
>> テキスト２

[```]を上下段に記述することでコード表記になります。

console.log(hoge)

Markdown記法ではテキストを装飾する記述がいくつかあります。

*テキスト*
**テキスト**
***テキスト***
~~テキスト~~
<font color="red">テキスト</font>
`テキスト`

入社前に最低限知っておいた方がよさそうなMarkdown記法をまとめてみました。
QiitaではじめてMarkdown記法というものの存在を知ったレベルなので、本当に基礎中の基礎をまとめたような感じです。

業務で使用する中で頻繁に使用するような記法が出てきたら追記しようと思います。
また、間違え等あればご指摘いただけると幸いです。