GitHub にもドキュメントがあり、README.md のように記述しないといけない、したほうがよいものがあります。
ドキュメントですが、基本となる markdown の機能に加えて+α の便利な拡張機能があります。忘れがちですが押さえておくと、すこしリッチなドキュメントを作成することが可能です。
引用文の特殊な機能 (Warning, Note)
> **Note** > ブログで公開したサンプルなどをまとめています。自由に再利用可能です。 > **Warning** > 利用により発生した損害全てに対し、いかなる責任をも負えません。詳細はライセンスをご確認ください。
まだ beta 機能かもしれないので、見え方が変わったり変更があるかもしれないです。
リストの特殊な機能(チェックリスト)
- [x] テキスト1 - [ ] テキスト2
絵文字
:+1:
のグッドマーク👍 :-1:
のバッドマーク👎は、よく使われるので押さえておくと便利です。
よく使う絵文字は、短い代替テキストが用意されていたりします。