Google+より投稿

good read

=======================================

good read

FlatdocはHTML/JavaScript製、Creative Commonsのオープンソース・ソフトウェアです。ソフトウェアを作るのは好きでも意外と面倒に感じてしまうのがドキュメントです。さらにHTMLで、Webブラウザでも見えるようにしておかないと使ってもらうこともないでしょう。そこでREADMEファイルから見栄えのいいHTMLドキュメントを生成してくれるFlatdocを使ってみましょう。こちらがベースになるテンプレートです。3カラムのシンプルな感じです。そしてこちらがソース。GitHubのユーザ名、リポジトリ名を指定します。そうするとこのようなドキュメントが生成されます。READMEの内容を自動的に読み込んで描画しています。表示についてはオプションを使ってカスタマイズができるようになっています。JavaScriptのフックも使えますのでより広範囲なカスタマイズも可能です。仕組みはGitHubのAPIを使ってリポジトリのREADMEを読み込み、その内容を解析して3カラムに展開して...

https://plus.google.com/106218564410864892476

June 10, 2013 at 11:04PM