Githubで使える記法
他人が使っていて良いなと思った記法は、聞いたり、 edit で書き方を盗み見てぱくってます。
その中でもよく使うものをまとめました。
（随時追加していく）
テーブル
■ 普通の使い方
書き方
|No.|食べ物|値段（円）|
|---|---|---|
|1|りんご|100|
|2|れもん|200|
表示のされ方
| No. | 食べ物 | 値段（円） |
|---|---|---|
| 1 | りんご | 100 |
| 2 | れもん | 200 |
■ 画像を埋め込む使い方
仕事をしていると、スクリーンショットをissueやPRに貼る機会は多いと思いますが、そのまま貼っていくとissueやPRが汚染されます。また、たくさん画像を貼ったりしたら、レビューする人はスクロールしまくる羽目になります。
そこで、テーブルに画像を埋め込むと良い感じにきれいにまとまるので、これはよく使っています。
書き方
|before|after|
|---|---|
|<画像のパス>|<画像のパス>|
表示のされ方
| before | after |
|---|---|
 |
 |
折りたたむ
ログの情報や大量の画像をそのまま書くと、これまたissueやPRが汚染されます。
こういった情報は details タグの中に入れることで、見た目がスッキリします。
特に画像が大量にある場合に有効です。
書き方
<details> タグで囲みます。
<summary> タグで表記を変えます。（デフォルトは「詳細」）
<details>
<summary>押してください</summary>
春はあけぼの。やうやう白くなりゆく山際、少し明かりて、紫だちたる雲の細くたなびきたる。
夏は夜。月のころはさらなり、闇もなほ、蛍の多く飛びちがひたる。また、ただ一つ二つなど、ほのかにうち光て行くもをかし。雨など降るもをかし。
秋は夕暮れ。夕日の差して山の端いと近うなりたるに、烏の寝所へ行くとて、三つ四つ、二つ三つなど飛び急ぐさへあはれなり。まいて雁などの連ねたるが、いと小さく見ゆるは、いとをかし。日入り果てて、風の音、虫の音など、はた言ふべきにあらず。
冬はつとめて。雪の降りたるは言ふべきにもあらず、霜のいと白きも、またさらでもいと寒きに、火など急ぎおこして、炭持て渡るも、いとつきづきし。昼になりて、ぬるくゆるびもていけば、火桶の火も、白き灰がちになりてわろし。
</details>
表示のされ方
押してください
春はあけぼの。やうやう白くなりゆく山際、少し明かりて、紫だちたる雲の細くたなびきたる。 夏は夜。月のころはさらなり、闇もなほ、蛍の多く飛びちがひたる。また、ただ一つ二つなど、ほのかにうち光て行くもをかし。雨など降るもをかし。 秋は夕暮れ。夕日の差して山の端いと近うなりたるに、烏の寝所へ行くとて、三つ四つ、二つ三つなど飛び急ぐさへあはれなり。まいて雁などの連ねたるが、いと小さく見ゆるは、いとをかし。日入り果てて、風の音、虫の音など、はた言ふべきにあらず。 冬はつとめて。雪の降りたるは言ふべきにもあらず、霜のいと白きも、またさらでもいと寒きに、火など急ぎおこして、炭持て渡るも、いとつきづきし。昼になりて、ぬるくゆるびもていけば、火桶の火も、白き灰がちになりてわろし。※書いてて気付いたが、details タグは入れ子にできる
まとめ
今のところはこのくらいですが、便利そうな記法があったらどんどん追加していく予定です。