カテゴリ内READMEの表示が変わりました

今回のリリース内容

image.png (248.7 kB)

esaではカテゴリの中にもREADMEを設置することができますが、今回その表示が変わりました。

従来はカテゴリ内のREADMEを表示するために、都度該当カテゴリメニューのすぐ下にある "README" メニューを押す必要がありました。

今回の変更により、対象のカテゴリにアクセスするだけでその中に書かれたREADMEを確認することができるようになります。これによりREADMEへのアクセスの手間が1ステップ省略され、かつREADMEの存在も見落とされにくくなる…とよいなあという狙いがあります。

新しいカテゴリ内README表示は、一定の高さに制限して表示され、スクロールすることで全体を読むことができます。

readme-help2.gif (987.0 kB)

また、左上のREADMEのタイトル表示をクリックすることで、元の記事へもアクセスできます。

image.png (340.6 kB)

docs.esa.io のヘルプページからも実物の様子が確認することができます。

補足

  • 今回の変更の対象はカテゴリ内READMEのみで、ルート階層に書かれた Homeの README については、変更はありません。
  • カテゴリ内READMEについて詳しくは、こちらの記事もご参照ください。

所感

この変更については、Misoca 様の esaトークで言及 して以来、いざ実装しようとすると、本当にこれでいいんだろうか…ほかにもっといい方法ないんだろうか…という堂々巡りの迷いが生じてしまい、だいぶ時間が経ってからのリリースになってしまいました。
この変更がウェルカムな方もいれば、そうでない方もまたいるような気がしているので、恐る恐るのリリースですが、いろんなご意見をいただいて改善していければいいなと思っております。
使ってみていただいて、フィードバックをいただけると大変うれしいです :smiley_cat:


[ProTip] Webhookでdocs.esa.ioの更新通知を受け取れるようになりました!

Enjoy "(\( ⁰⊖⁰)/)"
https://esa.io

END

  • Close