ITエンジニア/デザイナ向けにオープンソースを毎日紹介

GitHubでリポジトリを公開する際にはREADMEを書くのが基本です。開発者の多くはMarkdownで書いていることでしょう。GitHub上でもHTMLに整形されたREADMEが読めますが、最適化されているとは言いがたいかも知れません。

そこで使ってみたいのがGithub Markdown Readerです。よりREADMEを読みやすくする、そんなリーダーアプリです。

Github Markdown Readerの使い方

リーダーのサンプルです。左側にアウトラインが並びます。

見出しからコンテンツに素早く移動できます。

マウスオーバーでコンテンツが切り替わります。

リストが深くても大丈夫です。

日本語にも対応しています。

Github Markdown Readerは見出しだけを抜き出して表示し、マウスオーバーで素早く辿れるようになっています。任意のリポジトリを指定できますので、Github Markdown Readerを通してREADMEの可読性を高められます。

Github Markdown ReaderはJavaScript製のソフトウェア(ソースコードは公開されていますがライセンスは明記されていません)です。

Github Markdown Reader

u9u/u9u.github.io: Github Markdown Reader

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2