こんにちは。hacknoteのr.katoです。
最近なメモするときもToDo書くときもmarkdown使う様になってきていて
いつのまにかPCのなかがmdファイルだらけになってしまいました笑
見出し、リスト、コードの書き方はMarkdownでイケてるエンジニアになるで紹介されているので参考にしてください。
そんなわけで今回は見出し、リスト、コード以外のmarkdownの書き方を紹介していきます。
基本的なルール
空行、半角スペースを必ず入れ、#(シャープ)などのスタイル変化記号は半角を使う
リストや太字(**太字**)、強調
(`強調`)を除き、基本的に見出しなどの段落が変わるものの行の前後には空行を入れます。
例
(空行) # 見出し1 (空行)
また、太字(**太字**)、強調
(`強調`)の様に文字にスタイルを適応されるもの以外は、#(シャープ)などの記号の後に1つ半角スペースを入れる必要があります。
例
(↓半角スペース) # 見出し1 (↓半角スペース) * リスト1 * リスト2 (↓半角スペース) 1. 数字リスト1 2. 数字リスト2
リンク
markdownはインターネット上のリンク(URL)を貼ることができます。
いくつか方法があるので好みorその状況(記事作成スペースなど)にマッチした方法を使ってください。
- 方法その1
書き方 [hacknote1](https://hacknote.jp)
こうなります→hacknote1
- 方法その2
書き方 [hacknote2] (略) [hacknote2]:https://hacknote.jp
こうなります→hacknote2
- 方法その3
書き方 [hacknote3][1] (略) [1]:https://hacknote.jp
こうなります→hacknote3
- 方法その4-外伝
マウスカーソルを乗せて少し待つと指定した文字が表示されます。
書き方
[r.kato](https://hacknote.jp/archives/author/r-kato/ "r.katoの記事一覧")
こうなります→r.kato
おわりに
空行が…半角スペースが…
と紹介してきましたが、基本的なルールであってmarkdownエディタに依存します。
Qiitaで使われている、エディタでは必要なかったりするみたいですし…
最後に紹介したリンクは方法その1が一番一般的ではないでしょうか?
ただ、方法その1の書き方だと、長い記事を書いた際途中にURLが入り込んでしまい、編集がしにくくなります。
また、なんども同じリンクを使用する際は、方法その2やその3が便利になってきます。
今回紹介した記事以外にも、Markdownを使う際に知っておくと便利なhtmlも読んでおくと、かなり自由度の高いmarkdownでの編集ができる様になるのではないでしょうか?