nuitsjp/mdview repository overview

⁠docker-mdview

このリポジトリはMarkdownで記述した文書を、Re:VIEW⁠を利用して書籍にビルドするためのコンテナを提供します。

Re:VIEWのContainerイメージ⁠をベースにmd2review⁠をインストールし、サポートのシェルスクリプトをいくつか用意した形です。

DockerHub⁠に公開していますので、ご自由に利用ください。

⁠仕様

⁠サポートしているタグ

Re:VIEWのバージョン毎にイメージを作成します。 現在存在しているタグは latest, 2.5 です。

$ docker pull nuitsjp/mdview
$ docker pull nuitsjp/mdview:2.5

⁠使い方

こちらにはWindowsのコンソールで実行する場合を記述します。それ以外の環境の場合、以下のドキュメントをご覧ください。

• Windows Power Shell⁠
• Mac or Linux⁠

⁠執筆環境を作成する

ドキュメントを執筆するにあたり、必要な設定ファイルなどを作製します。

docker run --rm -v %cd%:/work nuitsjp/mdview "cd /work && mdview-init.sh document"

mdview-init.shの引数にdocumentを指定しているため、documentというサブディレクトリが作成され、その下に必要ファイルが配置されます。

ホストとゲストでフォルダの共有がうまく行かない場合はこちら⁠を参照。

⁠ドキュメントを記述する

さきに作成したdocumentフォルダの中の「document.md」ファイルを開いて、次のように編集しましょう。

# タイトル

Hello, Re:View!

⁠PDFにビルドする

カレントディレクトリをbookフォルダに移動後、次のコマンドを実行しPDFにビルドします。

docker run --rm -v %cd%:/work nuitsjp/mdview "cd /work && review-pdfmaker.sh config.yml"

実行が完了すると、次のようなPDFが作成されます。

複数のMarkdownファイルを記述して、catalog.ymdに取り込みたいmdファイルを定義することで、一つのPDFを複数のMarkdownから生成することもできますし、生成されるPDFの詳細はパラメーターを制御する事も可能です。

拡張子こそ異なりますが、その辺りはRe:VIEWの仕様に準じていますので、Re:Viewのドキュメント⁠もご覧ください。