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

PaigeはコードやREADMEからGitHub向けの静的なHTMLファイルを生成するソフトウェアです。

インストールは簡単で「npm install paige」のみです。実行は「paige path/to/config」になります。


実際にPaigeを使って作られたインデックスページです。


元になっているのはREADMEファイルです。Markdown記述のファイル(恐らくそれ以外も可)からHTMLを生成しています。


ソースファイルごとに説明ページが生成されます。左に説明、右にソースコードが表示されます。結構見やすいです。


元になったコードです。コメントがそのままテキストとして説明文に使われている形になります。


このような設定を記述する必要があります。

この手のジェネレータは色々ありますが、Paigeはかなりシンプルに使える印象です。GitHub向けと銘打たれている通り、GitHub向けのファイル配置(READMEなど)をしている場合にうまく出力されるようになっています。

PaigeはJavaScript製、node.jsを使ったソフトウェアですが、ライセンスは明記されていませんのでご注意ください。


MOONGIFTはこう見る

オープンソース・ソフトウェアとしてはコードとライセンスだけで十分と思われがちですが、やはりこうしたドキュメントや見栄えにこだわる工夫が必要だと思います。しかしただデザインすれば良いというわけではなく、Paigeのようにプログラミングで解決してしまうのがクールです。

Paigeが面白いのはGitHubに最適化されているということでしょう。GitHubの登録者数は100万人を越え、リポジトリサービスとして大きな存在になってきています。プログラマーであればGitHub向けのサービスを作れば、開発者の注目を集められるでしょう。

via Paige - Site generator for GitHub pages powered by Docco and Node.js - The Changelog - Open Source moves fast. Keep up.

Paige.js

rthauby/Paige - GitHub

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2