Posted at

GitHubのREADMEの目次を作ったりするChrome extension

More than 1 year has passed since last update.

GitHubで長いREADMEをじっくり読み込むとき、目次が欲しくなることがしばしばあります。なのでChrome extensionを作ってみました。

https://github.com/y-takey/kukkoro


機能

機能はシンプルですが2つあります。

1つ目は、↓のようにページ右部にREADMEの目次を表示します。h1 - h5タグをみて見出しの収集&インデントを付けているだけです。

image.png

2つ目は、ソースコードを読む際のブックマーク的なものです。行番号をクリックすると、その行が履歴に溜まっていきます。たとえば関数や変数の宣言場所をブックマークして、行き来しやすくすることが目的です。(ちなみに最初は、それらの場所を正規表現で抜き出して、あらかじめ表示しようかと思いましたがパターンが多くて断念しました。。。)

image.png


インストール

以下のwebstoreから追加してください。

https://chrome.google.com/webstore/detail/kukkoro/dngmmnfbdkjdnblljongbpjcldpafbli