shoten8

このリポジトリはRe:VIEWを使って技術書典8用の文書を書くリポジトリです。Re:VIEWバージョン4.0を使っています。

• B5紙面サンプル（PDF）
• A5紙面サンプル（PDF）
• B5紙面電子書籍サンプル（PDF）

使い方は？

提供されている一般的な使い方はテンプレートの使い方を参照してください。

このリポジトリだけの使い方

makeコマンドがあれば以下のコマンドを利用できます。

lint            Execute textlint
fixlint         Fix textlint error
codepen         Execute codepen
build           Build PDF in Docker
help            Show usages

また、エディタにtextlintに対応したプラグインがあればコマンドを実行しなくてもtextlintが表示できます。

• VSCode: テキスト校正くん - Visual Studio Marketplace

PRを作成し、校正チェックが問題なければPDFが生成されます。 PDFのありかはPRにCIからコメントが付きます。

Lintのルールがおかしい・この用語はLintで怒られないようにしてほしい

校正の補助としてtextlintを使っています。ルールの調整は以下のファイルを編集してください。

• .textlintrc

単語や正規表現を用いた許可ルールの追加は以下のファイルを編集してください。

• allow.yml

どちらかのファイルを編集したさいは、その変更だけ先にmasterブランチに入れておいてもらえると、他の人も同じルールで執筆ができます。