アプリやスクリプトのREADMEをMarkdown形式で書くのですが、どなたでも読みやすいようにPDF形式に変換する'markdown-pdf'を導入しました。
結論から言うと、markdown-pdfに記載の通り、下記コマンドで終わりです。
npm install markdown-pdf
ただ私の場合、npm?ってなったのと、オプション-g
でインストールしたのでその手順を記載します。
環境
- OS : 10.10 (Yosemite)
- パッケージ管理ツール : MacPorts (2.3.4)
- nodejs (4.3.1)
- npm (2.14.19)
(Note1) nodejs, npmはmarkdown-pdf導入にあたってインストールした際のバージョンを示しています。
npmについて
npmは、JavaScriptのためのパッケージ管理ツールです。
gemもしくはpipと同じようなものです。
インストール手順
Node.js
npmは、Node.jsインストール時に付属されているらしいので、
sudo port -d install nodejs
でNode.jsをインストール
npm
上記コマンド実行後、port installed
で確認しました。
しかしnpmは入っていなかったので、port search node
でnpm
が出てきたのを一応確認して、
sudo port -d install npm
でインストールしました。
モジュールのインストール方法は、下記コマンドです。
npm install <モジュール名>
markdown-pdf
npm install markdown-pdf
を実行すると、カレントディレクトリにnode_modules
が生成され、node_modules/markdown-pdf/bin/
にmarkdown-pdf
を確認しました。
ただ、現状だと
./node_modules/markdown-pdf/bin/markdown-pdf -o README.pdf README.md
のような実行方法になっていて、
実行ファイルmarkdown-pdf
までパスを示してあげる必要性があるので、イケてません。
Stand-aloneモード
markdown-pdfのREADMEを最後まで読むと、
To use markdown-pdf as a standalone program from the terminal run
npm install -g markdown-pdf
と書かれていました。
npm install -g markdown-pdf
だとPermission define
と出力されたので、
sudo npm install -g markdown-pdf
で無事完了しました。
使い方は、markdown-pdfのREADMEの最後に記載されています。
PDF変換結果
markdown-pdf -o README.pdf README.md
でPDFに変換すると、下記図のように無事にPDF形式のファイルが出力されました。
(Note2) PDFファイルは添付できなかったので、png形式に変換しました。また、画像の空白部分は切り取っています。