API Blueprint形式でWebAPI仕様書を書いて、 ドキュメントをHTML化するのにaglioを使っています。
ソースの.apibファイルを編集した後、内容を確認する場合、毎回、
aglio -i input.apib -o output.htmlを実行して、HTMLを出力してからブラウザで確認していました。
これが結構面倒だな、なんて思っていたのですが、 実は、aglioにはライブプレビュー機能が備わっていた、という話です。
ライブプレビュー機能を使うのは、とても簡単で、
aglio -i input.apib -sのように-sまたは、--serverオプションを指定して起動するだけ。
これでブラウザからhttp://127.0.0.1:3000にアクセスすると、API仕様書のHTMLが閲覧でき、
ソースの.apibを編集すると自動でリロードしてくれる。
プレビューサーバが待ち受けるアドレスを変更するには、-hまたは--hostオプションを指定する。
プレビューサーバが待ち受けるポートを変更するには、-pまたは--portオプションを指定する。
ドキュメントやhelpをよく読めばすぐにわかったことなのですが・・・ 今日まで気づかずにきた自分を戒めたいと思います。