コード閲覧に適したテーマ「Codeviewer」をオープンソースで公開

ユニコーンリサーチ株式会社(代表取締役中馬崇尋)は、サイトジェネレータ「hugo」向けのレイアウトテーマ「Codeviewer」を開発し、5月26日よりGitHubにて公開しました。

https://github.com/uniqrn/codeviewer

Codeviewerは MIT License に基くオープンソースとして配布され、誰でも自由に利用できます。

Codeviewerテーマの特徴

従来より、各開発言語にはドキュメントジェネレータが存在していますが、ソースコード閲覧のサポートはツールによりまちまちです。

Codeviewerは、シンタックス・ハイライトに highlight.js を採用しているため、191言語・97スタイルに及ぶ多彩なコード装飾が可能です。

また、ソースコードを hugo のコンテンツに変換する簡易スクリプト「code2md」を同梱しており、プロジェクトのコードディレクトリをWebコンテンツに一括変換できます。

これにより、言語を問わずブラウザからコード閲覧する環境を手軽に整備できます。

代表コメント

「現在、ソフトウェア開発では多種多様な開発言語を扱う機会が増えています。基本的には開発と並行してドキュメントを整備した方が良いのですが、xDocツールは相互に挙動が異なるため導入できずに終わることがあります。

そこで、コードそのものを読める環境を整備しようと考え、Codeviewerを作成しました。highlight.jsは洗練されており、config類を含めて驚くほど多彩な言語をサポートしています。
スマートデバイスが普及したため、ブラウザからコード閲覧可能な環境を整備すると非常に便利だと実感しています。

任意のセキュリティ水準を実装可能な点も、クライアントベースのソリューションより有利な点ではないかと思います。

今後ともコードは増え続けるため、Codeviewerを初歩的なTI実装として活用していきます。」