初投稿するハードルの一つであったMarkdown記法についてまとめます。
目次
- Markdown記法とは
- 目次の作り方
- 見出し
- コードの記載
- リンクの貼り方
Markdown記法とは
Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。本来はプレーンテキスト形式で手軽に書いた文書からHTMLを生成するために開発されたものである。しかし、現在ではHTMLのほかパワーポイント形式やLATEX形式のファイルへ変換するソフトウェア(コンバータ)も開発されている。各コンバータの開発者によって多様な拡張が施されるため、各種の方言が存在する。
https://ja.wikipedia.org/wiki/Markdown
(Wikipediaより引用)
要するにいい感じにテキストを見やすくしてくれる、手軽につかえる文法みたいなイメージですかね?そして、いろんな拡張ができるよーといった感じです。
見出し
見出し(この上のアンダーラインと太字表示)をするには、頭に#(シャープ)を付ければOKです。
何個つけるかによってサイズが変わります。
見出しをつけると、サイドに各見出しに飛ばしてくれる便利機能があるので、上手く使うと見やすくなると思います。
記述方法
# いっこ
## にこ
### さんこ
#### よんこ
##### ごこ
###### ろっこ
出力
いっこ
にこ
さんこ
よんこ
ごこ
ろっこ
こんな感じです。
※ここの見出しのサンプルの関係で、サイドの見出しが少しおかしくなっています。
目次の作り方
このぺージの冒頭に作ったような目次です。
記述方法
- title1
- title2
- title3
- etc
出力
- title1
- title2
- title3
- etc
インデントを付ければ、入れ子構造も作れます。
- title1
- title2
- title3
- title2
- etc
コードの記載
前項のように色をつけてコード等を見やすくする方法です。
バッククォート3つで囲めば大丈夫。
記述方法
```
ここにコードをかく
```
出力
ここにコードをかく
たまに予期しない挙動をすることがありますが、スペースとか改行で
だいたい何とかなります。バックスラッシュもうまく使うといいです。
リンクの貼り方
[]
でリンクにしたい文字列を囲み、その後ろに()
でURLを囲めばオッケーです。
記述方法
[google](http://google.com)
実際の表示
まとめ
とりあえず、最低限ここまで覚えておけば記事は書けそうです。
あとは、細かい装飾や画像の貼付、表の挿入などありますが、やっていくうちに覚えられると思います。
また機会があれば、別で作ってアウトプットしてみます。
以下の記事を参考にさせて頂きました。
Qiita記事作成方法 初心者の備忘録 @U-MAさん