Re:VIEW執筆環境

Re:VIEWによる日本語の技術書の執筆環境です．
開発環境とソースコードがこのリポジトリ1つにまとまっているため，すぐに執筆を開始できます．

Dockerイメージ（ghcr.io/vvakame/review）と、テンプレート（articles）は TechBooster/ReVIEW-Template から流用しています．

必要なもの

• Git
• Docker
• Visual Studio Code
  • Dev Containers plugin (ms-vscode-remote.remote-containers)
  • （リモートのDocker daemonを使用する場合）Remote - SSH (ms-vscode-remote.remote-ssh)

特徴

• Docker上で動作するため，ローカルの環境を汚さずに使用できる
• VS CodeのDev Containerを使うので，GUIで直感的に編集できる
• textlintによる文書校正が利用できる

使い方

1. （リモートのDocker daemonを使用する場合）Remote - SSH: Conntect to Host...でリモートPCに入る
2. Git: Cloneなどで任意のフォルダにダウンロード
3. File: Open Folderでダウンロードしたreview-templateフォルダを開く
4. Dev Containers: Reopen in ContainerでDev Containerを起動
5. articles/article.reを開いて編集
   review: Show previewコマンドでプレビューを見ながら編集できます．
6. Ctrl + Shift + Bまたは⌘ + Shift + Bでビルド
   articlesディレクトリ配下にbook.pdf（圧縮なし），book.min.pdf（圧縮あり，軽量）が生成されます．VSCodeで開くとプレビューできます．

構成

• articles：Re:VIEWのソースコード
• .textlintrc.yml：textlintのルール定義
• allow.yml：textlintで無視したいパターン定義
• prh.yml：prhのルール定義