ブログやメモを Markdown で書けばホットでイケてるナウいエンジニアになれます。
むしろGithubのReadmeはMarkdownで書くべきなので必須かもしれません。最低限これ使えばイイ感じになるよという「見出し」「リスト」「コード」の3つの記法を紹介します。
見出し
# 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5 ###### 見出し6
▼出力結果
見出し1
見出し2
見出し3
見出し4
見出し5
見出し6
こんな感じで見出しで切る
だけで文章の見やすさが格段に上がります。しかし見出しが多すぎても逆に読みづらくなります。コード系記事によくある構成として「目的・手法・結果」ごとに見出しで切ると良いです。
リスト
* リスト1 * リスト2 * リスト3 1. 連番リスト1 2. 連番リスト2 3. 連番リスト3
▼出力結果
- リスト1
- リスト2
- リスト3
- 連番リスト1
- 連番リスト2
- 連番リスト3
コード
``` 複数行コードを「```」で挟む。 ``` 文中に `短いコード` を入れる時は「`」で挟むと目立つ。
▼出力結果
複数行コードを「```」で挟む。
文中に 短いコード
を入れる時は「`」で挟むと目立つ。
まとめ
ひとまず以上のMarkdownが使えるだけであなたの書いたReadmeはグッと読みやすくなります。Markdownに対応したエディタも多く、ただのテキストファイルを書く時も積極的に使ってみてください。