たまにゃんのメモ帳

情報系関連のメモ書きを主に載せていきます。あわよくば他の人の参考になれば...

bootstrap-coffeedoc

CoffeeDoc With Bootstrapテーマ

CoffeeScriptAPI Documentを作るのにどのAPI Document Generatorもあまりデザインが微妙だったのでCoffeeDocを改良してBootstrapのテーマでAPI Documentを作成できるようにしました。 テーマはBootswatchのFlatlyでnpmにbootstrap-coffeedocという名前で公開しました。

  • 使い方
$ npm install -g bootstrap-coffeedoc
$ coffeedoc 
Usage: coffeedoc [options] [targets]

Options:
  --output        Set output directory                                              [default: "docs"]
  --parser        Parser to use. Available parsers: commonjs, requirejs             [default: "commonjs"]
  --renderer      Renderer to use. Available renderers: html, bootstrap, gfm, json  [default: "html"]
  --stdout        Direct all output to stdout instead of files                    
  --ignore        Files or directories to ignore                                  
  --help          Show this help                                                  
  --hide-private  Do not document methods beginning with an underscore 
$ coffeedoc --renderer bootstrap test.coffee