この記事は、技術同人誌執筆の軌跡 Advent Calendar 2025の12/6分の記事になります。
今年は、ひとりアドベントカレンダーに挑戦してみたく、このネタで25日まで書いていきますので、よろしくお願い致します。
Re:View で技術書を「読みやすく、美しく」仕上げる方法
技術同人誌を書くうえで欠かせないのが、挿絵・図表・コードの扱いです。Re:Viewでは、これらを“文章と一体化した形”で綺麗に管理できるのが大きな魅力です。
今日は、実際にどんな記法で書くのかをまとめます。
画像（挿絵）を挿入する
Re:View の画像挿入はとてもシンプル。
//image 命令にファイル名を書くだけで、キャプション番号も自動で付きます。
例：画像を挿入する
#@# 挿絵の例
//image[chairing001][チェアリング風景][scale=0.9]
パラメータの説明
・chairing001 → 画像のファイル名で、拡張子は不要です。
・チェアリング風景 → キャプション
・scale=0.9 → 任意オプションで幅調整です。横幅に対して、何%の割合にするかを指定します。
【ポイント】画像を入れる場合の注意点
画像はできるだけ横長にして挿入するようにしましょう。ワードのように、画像に対して回り込みの処理などがRe:Viewではできません。よって、縦長の画像を挿入すると両サイドに空白が出来てしまい、ページを開いた際に情報量が少ない状態になってしまいます。
ではどうするのか？
👇詳細はこちらの記事を参考にしてください。
https://note.com/kerdy/n/nb29c521d0cd4?magazine_key=m9905c84a81ca
・縦長の画像を横長にする
・図内の文字は、印刷文字と同じ程度の大きさに
・ツールのサイドバー等は縦長になることが多いので、重要な部分のみにする
特にノーコード、ローコード系ツールの画面は縦長になりがちで、左右の余白がきになってしまいますので、自分としてはこの辺りを気を付けています。
図表の扱い（テーブル）
テーブルは //table を使います。
例：シンプルな表
#@# 表の例
//table[spec001][サンプルテーブル]
項目{tab}内容
-----------
種類{tab}コーヒー
温度{tab}85℃
Re:Viewでは表をタブ区切り（{tab}）で表現します。これが結構VSCodeと相性が悪く……VSCodeはデフォルト設定で、{tab}は半角スペース4つに自動的に置き換えられます。
下記の設定をOFFにしてあげれば、半角スペースに置き換わることはないのですが、これがいつのまにか戻ります💦
ということで、自分はRe:View上でTabを入力する際は、メモ帳などでTab文字をコピーし、VSCodeに貼り付けしてます。
半角スペース4つも、Tab文字も通常では違いがわからないのですが、このように反転させてあげると違いがわかります（わかりますよね？笑）。
ということで、表は若干扱いにくいところではありますね。
コードブロックを書く
コードについては、いくつか命令形態があります。
listnum
#@# コードの例
//listnum[python001][サンプルPythonコード][python]
def hello():
print("Hello, Chairing!")
こちらは、以下のように行番号付の出力になります。
01:def hello():
02: print("Hello, Chairing!")
2-3 サンプルPythonコード
list
#@# コードの例
//list[python001][サンプルPythonコード][python]
def hello():
print("Hello, Chairing!")
こちらは行番号が付かない出力。
def hello():
print("Hello, Chairing!")
2-3 サンプルPythonコード
emlist / emlistnum
#@# コードの例
//emlistlist[サンプルPythonコード][python]
def hello():
print("Hello, Chairing!")
emlist/emlistnumはIDが付きません。list/listnumは文中でIDを使ってコードを参照させることができるのですが、emlist/emlistnumの場合はIDが無いためそれができません。
文中でコードを指定する必要がなければ、list/listnumを使えばOKです。
【ポイント】コードのはみ出しに注意
list/listnum/emlist/emlistnum共に、コードの自動改行設定はされておりません。はみ出した分は、そのままはみ出します💦
ので、実際にPDFを出力してみて、はみ出しているようであれば、手動で折り返す必要があります。
まとめ
執筆に集中していると、文字ばかりの書面が完成してしまい、非常に読むのが疲れる本になってしまいます。
適度に、図や表、コードを挿入することで、読み手が心地よくペースを保ちながら読めるようになります。