Skip to content

Typst で日本語論文を書くときのテンプレート

License

Notifications You must be signed in to change notification settings

kimushun1101/typst-jp-conf-template

Repository files navigation

Deploy workflow Deploy workflow

typst-jp-conf-template

このソースコードはTypst version 0.12で作成しました.
Typst で日本語論文を書くときのテンプレートです. Typst の概要について知りたい方は,https://github.com/kimushun1101/How-to-use-typst-for-paper-jp をご覧ください.

vscode-typst.webm
ファイル 意味
main.typ 原稿の Typst ソースコード
refs.*  参考文献ファイル
ディレクトリ 含まれるファイルの種類
figs   論文に使用する画像ファイル
libs   体裁を整えるライブラリファイル

雰囲気を掴みたい場合には こちらの Typst Web Application をお試しください.
コンパイル済みの資料を確認したいだけでしたら こちらの GitHub Pages からお読みできます.

使用方法

GitHub に慣れていない方は,GitHub ページの <>Code▼ から Download ZIP して展開してください.
慣れている方は,git clone したり use this template したり,適宜扱ってください.

VS Code を使用する場合

  1. VS Code をインストール.
  2. VS Code で FileOpen Folder でこのフォルダーを開く.
  3. 推奨拡張機能をインストール.
    Extensions (Ctrl + Shift + X) の Search Extensions in Marketplace のテキストボックスに @recommended と入力すると表示される,以下の拡張機能をinstall をクリック.
  4. Explorer (Ctrl + Shift + E) から main.typ を開いた状態で,画面右上にある Typst Preview の方の view-icon アイコンをクリック ( Ctrl + K のあと V) でプレビューを表示.トップにある動画 の操作です.
  5. Ctrl + S で PDF を生成.

他のエディターで執筆する場合

筆者は試せていませんが,他のエディターでも同様の拡張機能はありそうです.
また,Typst のインストールおよびコンパイルはコマンドラインでも行えます.
お使いの OS によってインストール方法が異なるため,詳細は別ページにまとめました.

Typst Package について

typst.toml には、Typst Packages にある様式の通りにプロパティが登録されています。これは、Typst Universe にテンプレートファイルを公開し、コンパイラが typst init コマンドを実行するためのメタデータです。ただし、現時点では、Typst Universe に当該テンプレートは登録されていません。

このリポジトリの中身を特定のディレクトリ(フォルダ)に配置することで、ユーザのどのディレクトリからでもテンプレートファイルを作成することができます。特定のディレクトリとは以下の通りです。

  • ~/.local/share/typst/packages/local/typst-jp-conf-template/{version} # Linux
  • ~/Library/Application Support/typst/packages/local/typst-jp-conf-template/{version} # macOS (Default Installer)
  • %APPDATA%/typst/packages/local/typst-jp-conf-template/{version} # Windows

上記を適用した状態で、以下のコマンドを入力すると、ディレクトリが初期化されます。

typst init @local/typst-jp-conf-template

参考元

ライセンス

参考元にならってライセンスを付与しています.
Typst ファイル : MIT No Attribution
CSL ファイル : Creative Commons Attribution-ShareAlike 3.0 License

About

Typst で日本語論文を書くときのテンプレート

Resources

License

Stars

Watchers

Forks

Packages

No packages published