はじめに
マークダウンの記法について調べる事が多いので、まとめを作りました。
よかったら参考にしてください。
目次
①見出し
②リスト
③番号付きリスト
④改行
⑤インライン表示
⑥リンクの挿入
⑦画像の挿入
⑧コードの挿入
⑨引用
⑩表
解説
①見出し
書き方
# 見出し⑴ ## 見出し⑵ ### 見出し⑶
結果
=> 以下のように、#の数
に応じて見出しの大きさが変わります。
見出し⑴
見出し⑵
見出し⑶
②リスト
書き方
- リスト - リスト - リスト
結果
=> 以下のように、リストにできます。また、Tabキー
を使用すればリストの中にリストを作れます。
- リスト
- リスト
- リスト
③番号付きリスト
書き方
1. リスト 2. リスト 3. リスト
結果
=> 以下のように、番号付きリストにできます。
=> また、Tabキー
を使用すればリストの中にリストを作れます。
=> ただし以下のように、リストの中にリストを作る場合は1から開始になります。
- リスト
- リスト
- リスト
④改行
書き方
1行目__<-(半角スペース2個分) 2行目 <br> 3行目
結果
=> 以下のように、改行するためには半角スペース2個
,<br>
とすることで改行できます。
1行目
2行目
3行目
⑤インライン表示
書き方
`テキスト`
結果
=> 以下のように、インライン表示したい文字列をバッククォーターで囲むことでインライン表示にできます。
=> バッククォーターは「shift + @」
テキスト
⑥リンクの挿入
書き方
[タイトル](URL) [Qiita](https://qiita.com/)
結果
=> 以下のように、[]内に記述した文字がリンクになります。
=> 遷移先は()で指定したURLになります。
⑦画像の挿入
書き方
![代替テキスト](URL "タイトル")
結果
=> [代替テキスト]("タイトル")はなくても構いません。
=> URLには画像のURL
を入れると表示されます。
★Gyazoのgifを貼り付ける際によく使えるので絶対に覚えておいた方が良いです!!
⑧コードの挿入
書き方
```<-(バッククォーター3つ) プログラミング言語:タイトル 挿入したいコード ```<-(バッククォーター3つ)
例
```ruby:タイトル
puts "HelloWorld!"
結果
=> バッククォーター(```)3つで囲むことでコードの挿入ができます。
=> 以下のように、プログラミング言語を指定すると、その言語に応じた色をつけてくれます。
タイトルputs "HelloWorld!"
⑨引用
書き方
>テキスト >>テキスト
結果
=> 以下のように、>
を文頭に入れると、グレーの線が表れ、引用の形にしてくれます。
テキスト
テキスト
⑩表
書き方
|table1 | table2 | table3 | |-------|--------|--------| |column |column |column | |column |column |column |
結果
=>以下のように、表になり表示されます。
★DB設計する際に必要になり、これもとても大事です!
table1 table2 table3 column column column column column column
まとめ
エンジニアならばマークダウンを使う事が多いと思い、大切そうなものを10個まとめました!
もしわからない時は、ぜひご活用ください。