以下のような使い方を想定しています。
notebookディレクトリ以下に自由にnotebookを追加する- notebookをpdf / htmlに変換する
- textlintを使って文字校正を行う
- dropboxに作成したpdfを配置してレビューをし合う
- gitlabにリポジトリを作成した場合はCIが走ってhtml版・pdf版が自動デプロイされる => DL,レビューしやすい
手元でpdf/htmlにビルドしたい場合は以下を実行します
docker build -t ipybook . && docker run -v `pwd`/public:/book/public: -it ipybook makepublic/以下にnotebookをpdfをhtmlで吐き出したものが保存されます。
リポジトリをgitlabに作成した場合、masterにpushすると自動でビルドが走り、pdf・html版が作成されます。
以下のurlから確認とダウンロードができます。
http://{グループ名}.gitlab.io/{リポジトリ名}/
npmのtextlintを使って正しく文章がかかれているかチェックします。
※lintをかけるために実行時にはnotebookを一度markdownに変換します。
docker build -t ipybook . && docker run -v `pwd`/public:/book/public: -it ipybook make textlintspellcheck-tech-word技術用語のチェックno-mix-dearu-desumasu「ですます」と「である」をミックスさせないmax-ten「、」を１文にn個以上出現させない:
他のルールを追加は以下の手順で可能です。
- Dockerfileでルールをinstallする部分を追記
.textlintrcにルールを追記
notebook以下に自由にnotebookを追加して書いてください。
※現在の環境ではnotebook以下にディレクトリを作成してその中にnotebookを配置するとビルドがうまく動きません。
画像はimageフォルダ以下に配置してください。
<img>タグだとpdfに吐き出し出来ないため、notebook内では以下のようにmarkdown形式で画像を記載してください。
