torus-apidoc-cli v1.0.4

Torus-apidoc-cli

Overview

Markdown形式のドキュメントでAPIドキュメントを作成することができるTorus-apidocのコマンドライン版です。

Requirement

このツールは以下のnpmモジュールを使用しています。 package.jsonに記載されているので、まとめてインストールされます。

HTML コンパイル

• ejs
• ejs-cli

Markdown to HTML

• jsdom
• marked

HTML to PDF

• html-pdf

Other

• commander
• ncp

Install

npm install --save torus-apidoc-cli

Usage

Markdownテキストについては、Torus-apidocを見てください。

torus-apidoc-cli -b doc/api.md -o dist/ -s 'Copyright © Example1 Inc.'

--base -b

Markdownが保存されている場所とファイル名です。

--out -o

HTMLとPDFを出力するディレクトリです。

--copyright -t

PDFファイルのフッターにつくコピーライトです。

Licence

MIT

Author

axcelwork