普段技術書展とかに行って本を買うのが好きですが、自分でも書いてみたいなと思うようになりました。
技術書を書く際によく使われるのがRe:VIEWというLaTeXベースのものらしく、ここでは初期セットアップを行った際の備忘録を残しておきます。
ちなみに私はLaTeXは大学生時代に少し使っていたくらいなので、だいぶ久しぶりに触るような状態です。
RE:VIEWの初期設定方法
RE:VIEWを使った環境の構築には大きく分けて3種類ありそうです。
RE:VIEWの公式サイトからインストール
RE:VIEWの公式サイトからインストールする方法です。
↓こちらが公式サイト
メリットとしては余計な設定がなく、一から自分好みに設定できることです。逆にデメリットはシンプルな見栄え過ぎて初心者には設定が大変かもしれないです。LaTeXを使いこなせている人はこちらの方法でインストールでいいと思います。
また、公式サイトを見るとLinux/Unix 互換システムで動作するということで、何個か記事を見るとWindowsは少し大変そうな雰囲気?でした。(公式サイトにはWindowsでも動作可能です。という文言があるため楽にできるのかもしれないですが。)
https://github.com/kmuto/review/blob/master/doc/quickstart.ja.md
また、ナレッジベースもあるため、こちらを見ながらもセットアップができると思います。
https://review-knowledge-ja.readthedocs.io/ja/latest/index.html#
RE:VIEW STARTER
一つはRE:VIEW STARTERと呼ばれるもので、特徴としてはGUIでセッティングできるみたいです。詳細は下記サイトを参照お願いします。
https://kauplan.org/reviewstarter/
メリットは一番簡単にセッティングができることですが、デメリットとしてはRE:VIEWのバージョンが2.5で固定されており、最新のRE:VIEWを使うことが出来ません。(2026/01/27時点での最新は5.10です。)
RE:VIEW Template
VS CodeにRE:VIEWのプラグインをいれる
Windows10でVisual Studio Codeの環境構築
拡張機能を押下して、language reviewで検索すると下記Re:VIEWの拡張機能がヒットするのでこちらをインストールします。
ローカルでRe:VIEWの環境を構築する
Re:VIEWの環境構築には大きく分けてDockerを使うのとRubyなどをインストールしてローカルで環境構築をする2種類がありそうです。Dockerで環境構築をするのが一般的みたいですが、今回はローカルで環境構築を実施する手法を取りたいと思います。
Rubyのインストール
まず初めにRubyをインストールします。Rubyのインストールについては下記記事にメモを残したので、まだインストールしてない人は参照お願いします。
Windows 11でRubyの環境構築を行うRubyをインストールしたらコマンドプロンプトを起動して下記コマンドを入力してRe:VIEWをインストールします。
gem install review
gitのインストール
続いてGitHubに上がっているテンプレートファイルを持ってくるためにgitをインストールします。gitのインストールの仕方は下記記事にまとめました。まだ入ってない方は参考にして下さい。
Node.jsをインストールする
続いてNode.jsをインストールをします。こちらも下記記事にまとめたのでまだ入ってない方は参考にしてください。
Windows 11でNode.jsをインストールする以上で事前準備は完了です。
テンプレートファイルをローカルに持ってきてビルドしてみる
これで事前準備が終わったのでローカルに持ってきてビルドをしてみます。gem install bundler
GitHubからテンプレートファイルをCloneする
次にGitHubからtemplateファイルを持ってきます。再度コマンドプロンプトで下記コマンドを入力します。
git clone git@github.com:TechBooster/ReVIEW-Template.git
上記コマンドを打った後、私の環境では下記のメッセージが出てきました。
The authenticity of host 'github.com (20.27.177.113)' can't be established.
ED25519 key fingerprint is: SHA256:+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU
This key is not known by any other names.
Are you sure you want to continue connecting (yes/no/[fingerprint])?
ざっくりいうと初めてこのサーバーにアクセスするけど本当に信用してもいいですかという確認で、SSHで初めて使う場合に必ず1度だけ出てくるみたいです。
ここでyesを入力したのですが、下記エラーメッセージが出てしまいました。
Please make sure you have the correct access rights
and the repository exists.
こちらはざっくりいうとアクセス権がないというメッセージです。SSHの設定をしておらず、鍵がないことが原因でアクセスが出来てないと思われます。gitのSSHの設定については下記参照お願いします。
https://4ag4126.blogspot.com/2026/02/windows11git.html#toc_headline_2
SSHの設定を終わった後再度コマンドを実行すると問題なく、Cloneすることが出来ました。この設定を通してGit Cloneする際にローカルに秘密鍵を保存したフォルダーにアクセスして照合しているということを初めて知りました。
もし、うまくいかない人がいる場合は秘密鍵を保存するフォルダが悪いかもしれないため、設定を見直しした方がいいと思います。
テンプレートファイルをPDF化する
Cloneが終わったらテンプレートファイルをPDF化していきます。ディレクトリをReVIEW-Templateに変更するために下記コマンドをコマンドプロンプトで入力します。
cd ReVIEW-Template
そのあと、下記二つのコマンドを入力します。
npm install
npm run pdf
私の環境の場合一つ目のコマンドは成功したのですが、2つ目のコマンドで失敗してしまいました。
エラーメッセージを確認すると"Could not find gem 'review (= 5.9.0)"という文字があり、私のPCに入っているReviewが5.10.0に対してテンプレート側が5.9.0だったため、NGが起きたみたいです。
このエラーを解決するために下記コマンドを入力してupdateを実施します。
bundle install
この後再度 npm run pdf コマンドを入力したのですが、今度はnkfが入ってないというエラーが出てきました。
調べてみるとこれはRuby 3.3までは標準で入っていたそうなのですが、Ruby 3.4からは標準から外れてしまったみたいで手動でインストールする必要がありそうです。下記コマンドを入力してnkfをインストールします。
gem install nkf
またこのままだとGemfileに追加が出来てないため、下記コマンドを打ってGemfileにnkfを追加し、書き換え内容を反映します。
echo gem 'nkf' >> Gemfile
bundle install
この後再度run pdfコマンドを打って、これでいけるかと思いましたが、今度はcsvがないというエラーが出てしまったので、同様の手順でCSVを追加していきます。流れは先ほどと同じなので、詳しくは書きませんが下記コマンドを順番に打っていきました。
gem install csv
echo gem 'csv' >> Gemfile
bundle install
この状態で再度 run pdfを実行したところ問題なくDoneの文字がみえました。
正しく出力されているか確認する
最後に正しく出力されているか確認します。出力されたPDFは私の環境では下記フォルダの中に出力されておりました。(.reファイルがあるのがこのフォルダだからだと思います。)
C:\Users\ユーザー名\ReVIEW-Template\articles
このフォルダの中にReVIEW-Template.pdfというものがあるので、更新日時がコンパイルした日時になっていることを確認し、開きます。問題なくテンプレートファイルが表示されたら成功です。
これでRe:Viewを使ったコンパイルができるようになりました。
まとめ
今回はRe:Viewを使うためのTemplateファイルをコンパイルするための準備を実施しました。Dockerを使った環境構築をすればもう少し早く環境構築ができたかもしれないですが、ローカル環境を一から構築するのはだいぶ大変でした。
0 件のコメント:
コメントを投稿