Typstテンプレートを使用する
はじめに
Typstとは、学術用途のために新たに生まれたマークアップベースの組版システムです。より詳細な概要はこちらをご参照ください。
このTypstのテンプレートはTypst Universeというところで公開でき、この記事では、Typstテンプレートの使用方法について解説します。
この記事で扱う例として、私がよく参加する国内学会の予稿に似せたテンプレートを作成しました。
このテンプレートを用いて、2段組み学会論文風の文書を作成する方法を紹介します。
個人的にお手軽と感じたVS Codeによる方法とTypst CLIによる方法の2つを記載します。どちらかができれば問題ありません。 需要があれば他の方法なども追記しますので、ご要望などいただけますと嬉しいです。
VS Codeを使用する方法
エディターソフトにこだわりがない場合にはVS Code (以降VS Code)を使用すると楽かと思います。
インストール
まずはVS Codeをインストールしてください。
つぎにその拡張機能であるTinymist Typstをインストールしてください。
Tinymist Typstによるテンプレートの使用
-
Ctrl+Shift+P
からtypst template
と検索してTypst: Show Avarable Typst Templates (Gallery) ...
を実行してください。
- テキストボックスで
jaconf-mscs
を検索してください。+
の横の♥
を押すとお気に入り登録ができ、All
の横の♥
で絞り込みができます。
+
でフォルダーを指定することで、フォルダーの選択画面が出ます。適当にフォルダーを作成してSelect folder to initialize
を押してください。そこにmain.typとrefs.ymlが生成されます。
- main.typを開き、ファイルの一番上の行にある
Preview
を押すことで仕上がりを確認しながら執筆できます。完成したらExport PDF
でPDF文書の出力が可能です。
Typst CLIを使用する方法
VS Code以外のエディターソフトを使いたい場合や、コマンドライン操作になれている場合にはこの方法を推奨します。
Typst CLIのインストール
Typstのインストール方法はTypstのGitHubページにある通りですが、簡単にまとめます。
Windows
PowerShellを開き以下のコマンドを入力します。
winget install --id Typst.Typst
winget
コマンドが有効でない場合には、Microsoft Storeからアプリインストーラーをインストールすると使えるようになります。
Mac
-
Homebrewをインストール
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-
以下のコマンドを入力
brew install typst
Linux
Linuxの場合にはディストリビューションごとにインストールコマンドが変わりますが、Rustを通せばどれも同じコマンドとなります。
-
Rustをインストール
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-
以下のコマンドを入力
cargo install --locked typst-cli
Typst CLIによるテンプレートの使用
- 以下のコマンドで、作業ディレクトリを作成します。例として
typst init @preview/jaconf-mscs my-doc
my-doc
というディレクトリを作成しておりますが、ディレクトリ名は適宜変更してください。 - 作成したディレクトリに移り、以下のコマンドで
main.pdf
を生成します。cd my-doc typst compile main.typ
- 編集を検知して自動コンパイルしたい場合には、以下のコマンドが便利です。
typst watch main.typ
テンプレートについて
テンプレートの情報を探すにTypst Universeを見るとよいでしょう。
テンプレートの説明ページに遷移すると、引数などをどのように設定したら良いかなどが記載されています。たとえば今回用いたテンプレートは以下です。
また、このテンプレートで生成されるmain.typには、テンプレートで導入する独自関数の説明だけでなく、Typst自体の使い方についても簡単に記載しております。
main.typの内容やテンプレート自体のご要望については、以下のGitHubリポジトリで募集中です。IssuesやPull requests、Starなどをいただけますと喜びます。
おわりに
本記事では、Typstのインストールからテンプレートの使い方までを解説しました。Typstの日本語ユーザーが増えることでTypstの日本語対応がより発展することをお祈りしております。
Typstドキュメント翻訳プロジェクトも進めております。以下の記事にて紹介しておりますため、もしご興味がありましたらご覧いただけますと幸いです。
Discussion