くりにっき

フルスタックキュアエンジニアです

個人gemのドキュメントを全部GitHub Pagesに移行した

自分が作ってるgemでは https://github.com/lsegal/yard でドキュメントを書くことが多くて、そのドキュメントをホスティングする場所として https://rubydoc.info/ を使っていました。

しかし https://rubydoc.info/ がここ最近ずっと重くて表示するのに十数秒待たされてイラッとすることが多かったので、一念発起して全部GitHub Pagesに移行しました。

3日間で多分30〜40リポジトリくらい作業したと思います。

作業内容はこんな感じ。

github.com

設定ファイルはほぼ全部コピペでいいんだけど、リポジトリ毎にGitHub Pageを有効化したり手元でyardを実行してwarningが出てないかの確認をしてたらそこそこ時間かかりました。

最近だと静的ファイルをgh-pagesブランチとかにコミットにしなくてもGitHub Actionsから直接GitHub Pagesにデプロイできるようになって便利。

github.blog

小ネタですがgemspecに下記のように書いておくと https://rubygems.org/ からリンクが貼られるようになります。

spec.metadata["documentation_uri"] = "https://sue445.github.io/rubicure/"