Update description (#11)

* update font settings Signed-off-by: Shunsuke Kimura <[email protected]> * Update description Signed-off-by: Shunsuke Kimura <[email protected]> * Update all templates Signed-off-by: Shunsuke Kimura <[email protected]> --------- Signed-off-by: Shunsuke Kimura <[email protected]>
kimushun1101 · Jan 4, 2025 · 4ae4ec4 · 4ae4ec4
1 parent f32fb97
commit 4ae4ec4
Show file tree

Hide file tree

Showing 9 changed files with 490 additions and 459 deletions.
diff --git a/README.md b/README.md
@@ -3,72 +3,70 @@
 
 # typst-jp-conf-template
 
-**このソースコードはTypst version 0.12で作成しました．**  
-Typst で日本語論文を書くときのテンプレートです．
-Typst の概要について知りたい方は，https://github.com/kimushun1101/How-to-use-typst-for-paper-jp をご覧ください．
-
+**このソースコードはTypst version 0.12で作成しました。**  
+Typstで日本語論文を書くときのテンプレートです。
+Typstの概要について知りたい方は、https://github.com/kimushun1101/How-to-use-typst-for-paper-jp をご覧ください。
 
 [vscode-typst.webm](https://github.com/kimushun1101/typst-jp-conf-template/assets/13430937/f227b85b-0266-417b-a24a-54f28f9a71b8)
 
-
 | ファイル  | 意味                    |
 | -------- | ----------------------- |
 | main.typ | 原稿の Typst ソースコード |
 | refs.*　 | 参考文献ファイル          |
 
-
 | ディレクトリ | 含まれるファイルの種類          |
 | ------------- | --------------------------- |
 | figs　　      | 論文に使用する画像ファイル    |
 | libs　　      | 体裁を整えるライブラリファイル |
 
-
-雰囲気を掴みたい場合には [こちらの Typst Web Application](https://typst.app/project/wXmeFlJ5bhx1awSRuJRiUf) をお試しください．  
-コンパイル済みの資料を確認したいだけでしたら [こちらの GitHub Pages](https://kimushun1101.github.io/typst-jp-conf-template/typst-jp-conf.pdf) からお読みできます．
+雰囲気を掴みたい場合には [こちらの Typst Web Application](https://typst.app/project/wXmeFlJ5bhx1awSRuJRiUf) をお試しください。  
+コンパイル済みの資料を確認したいだけでしたら [こちらの GitHub Pages](https://kimushun1101.github.io/typst-jp-conf-template/typst-jp-conf.pdf) からお読みできます。
 
 ## 使用方法
-GitHub に慣れていない方は，GitHub ページの `<>Code▼` から `Download ZIP` して展開してください．  
-慣れている方は，`git clone` したり `use this template` したり，適宜扱ってください．
-
-### VS Code を使用する場合
-1. [VS Code](https://code.visualstudio.com/) をインストール．
-2. VS Code で `File`→`Open Folder` でこのフォルダーを開く．  
-3. 推奨拡張機能をインストール．  
-  Extensions (`Ctrl` + `Shift` + `X`) の `Search Extensions in Marketplace` のテキストボックスに `@recommended` と入力すると表示される，以下の拡張機能をinstall をクリック．  
+
+GitHubに慣れていない方は、GitHubページの `<>Code▼` から `Download ZIP` して展開してください。  
+慣れている方は、`git clone` したり `use this template` したり、適宜扱ってください。
+
+### VS Codeを使用する場合
+
+1. [VS Code](https://code.visualstudio.com/) をインストール。
+2. VS Codeで`File`→`Open Folder` でこのフォルダーを開く。  
+3. 推奨拡張機能をインストール。  
+  Extensions (`Ctrl` + `Shift` + `X`) の `Search Extensions in Marketplace` のテキストボックスに `@recommended` と入力すると表示される、以下の拡張機能をinstallをクリック。  
     - [Tinymist Typst](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist)
-4. Explorer (`Ctrl` + `Shift` + `E`) から `main.typ` を開いた状態で，画面右上にある Typst Preview の方の ![view-icon](https://github.com/kimushun1101/typst-jp-conf-template/assets/13430937/a44c52cb-d23a-4fdb-ac9f-dc2b47deb40a) アイコンをクリック (
- `Ctrl` + `K` のあと `V`) でプレビューを表示．[トップにある動画](#typst-jp-conf-template) の操作です．
-5. `Ctrl` + `S` で PDF を生成．
+4. Explorer (`Ctrl` + `Shift` + `E`) から `main.typ` を開いた状態で、画面右上にあるTypst Previewの方の ![view-icon](https://github.com/kimushun1101/typst-jp-conf-template/assets/13430937/a44c52cb-d23a-4fdb-ac9f-dc2b47deb40a) アイコンをクリック (
+ `Ctrl` + `K` のあと `V`) でプレビューを表示。[トップにある動画](#typst-jp-conf-template) の操作です。
+5. `Ctrl` + `S` でPDFを生成。
 
-### 他のエディターで執筆する場合
+### 他の方法で使用する場合
 
-筆者は試せていませんが，他のエディターでも同様の拡張機能はありそうです．  
-また，Typst のインストールおよびコンパイルはコマンドラインでも行えます．  
-お使いの OS によってインストール方法が異なるため，詳細は[別ページ](docs/native-install.md)にまとめました．
+[別ページ](docs/compile.md)をご参照ください。
 
 ## Typst Package について
 
-`typst.toml` には、[Typst Packages](https://github.com/typst/packages) にある様式の通りにプロパティが登録されています。これは、Typst Universe にテンプレートファイルを公開し、コンパイラが `typst init` コマンドを実行するためのメタデータです。ただし、現時点では、Typst Universe に当該テンプレートは登録されていません。
+`typst.toml` には、[Typst Packages](https://github.com/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
 
 上記を適用した状態で、以下のコマンドを入力すると、ディレクトリが初期化されます。
 
-```
+```sh
 typst init @local/typst-jp-conf-template
 ```
 
 ## 参考元
+
 - (unofficial) IFAC Conference Template for Typst : https://github.com/typst/packages/tree/main/packages/preview/abiding-ifacconf/0.1.0
 - charged-ieee : https://github.com/typst/packages/tree/main/packages/preview/charged-ieee/0.1.0
 - IEEE style as per the 2021 guidelines, V 01.29.2021. : https://editor.citationstyles.org/styleInfo/?styleId=http%3A%2F%2Fwww.zotero.org%2Fstyles%2Fieee
-- GitHub Pages へのデプロイ : https://github.com/yukukotani/typst-coins-thesis
+- GitHub Pagesへのデプロイ : https://github.com/yukukotani/typst-coins-thesis
 
 ## ライセンス
-参考元にならってライセンスを付与しています．  
-Typst ファイル : MIT No Attribution  
-CSL ファイル : Creative Commons Attribution-ShareAlike 3.0 License  
+
+参考元にならってライセンスを付与しています。  
+Typstファイル : MIT No Attribution  
+CSLファイル : Creative Commons Attribution-ShareAlike 3.0 License  
diff --git a/docs/compile.md b/docs/compile.md
@@ -0,0 +1,71 @@
+# コンパイル方法
+
+## VS Codeを使用
+
+[README.md](../README.md)をご参照ください。
+
+## Typst app にアップロード
+
+1. [Typst app](https://typst.app/)から `Sign up` でアカウントを作成
+2. `Empty document` から新規プロジェクトを作成
+3. zip展開したファイルおよびフォルダーをアップロード
+4. main.typの目のアイコンが閉じていれば、これ![image](https://github.com/user-attachments/assets/bf5dc1c8-78c4-4bb9-9d78-b8ea93271236)をクリック
+
+## コマンドによるインストール
+
+Typstのインストール方法は、[TypstのGitHubページ](https://github.com/typst/typst) にある通りですが、以下の3つのパターンが簡単かと思われます。
+
+### Windows
+
+PowerShellを開き以下のコマンドを入力する。
+
+```powershell
+winget install --id Typst.Typst
+```
+
+`winget`コマンドが有効でない場合には、Microsoft Storeから[アプリインストーラー](https://apps.microsoft.com/detail/9nblggh4nns1)をインストールすると使えるようになります。
+
+### Mac
+
+1. [Homebrew](https://brew.sh/ja/) をインストール
+
+   ```sh
+   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+   ```
+
+2. 以下のコマンドを入力
+
+   ```sh
+   brew install typst
+   ```
+
+### Rust を通してインストール
+
+Ubuntuの場合などはこの方法をオススメします。
+
+1. [Rust](https://www.rust-lang.org/ja/tools/install) をインストール
+
+   ```sh
+   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+   ```
+
+2. 以下のコマンドを入力する。
+
+   ```sh
+   cargo install --git https://github.com/typst/typst --locked typst-cli
+   ```
+
+## コマンドによるコンパイル
+
+1. 解凍したフォルダーの `main.typ` を編集
+2. PowerShellやターミナルで `main.typ` のあるディレクトリに移り、以下のコマンドで `main.pdf` を生成
+
+   ```sh
+   typst compile main.typ
+   ```
+
+3. 編集しながらコンパイルしたい場合には、以下のコマンドも便利です。
+
+   ```sh
+   typst watch main.typ
+   ```
diff --git a/docs/fonts.md b/docs/fonts.md
@@ -0,0 +1,42 @@
+# フォントの設定
+
+[テンプレート関数の引数](../main.typ#L16-L18)で渡すことができます。
+
+基本的にWindowsではMSフォント、Macではヒラギノフォントが標準でインストールされているはずです。
+それらに変更していただいても問題ありません。
+Linuxでは、ご自身でインストールする必要があるかもしれません。
+たとえばUbuntuの場合には
+
+```sh
+sudo apt-get update
+sudo apt-get install -y fonts-noto fonts-noto-cjk fonts-noto-cjk-extra
+```
+
+でNotoフォントがインストールできます。
+BIZ UDフォントのインストールは以下で行えます。
+
+```sh
+# Install BIZUDGothic
+curl -L https://github.com/googlefonts/morisawa-biz-ud-gothic/releases/latest/download/BIZUDGothic.zip -o BIZUDGothic.zip
+sudo unzip BIZUDGothic.zip -d /usr/local/share/fonts/BIZUDGothic/
+rm -rf BIZUDGothic.zip
+
+# Install BIZUDMincho
+curl -L https://github.com/googlefonts/morisawa-biz-ud-mincho/releases/latest/download/morisawa-biz-ud-mincho-fonts.zip -o morisawa-biz-ud-mincho-fonts.zip
+unzip morisawa-biz-ud-mincho-fonts.zip
+sudo mkdir -p /usr/local/share/fonts/BIZUDMincho
+sudo mv morisawa-biz-ud-mincho-fonts/fonts/ttf/*.ttf /usr/local/share/fonts/BIZUDMincho/
+rm -rf morisawa-biz-ud-mincho-fonts*
+
+# Update fonts cache
+fc-cache -vf
+```
+
+ちなみにGitHub Actionsで自動生成されるPDFは上記の設定を [.github/workflows/gh-pages.yml](../.github/workflows/gh-pages.yml#L22-L23) で行っております。
+
+## フォント選定の考え方
+
+1. できるだけデフォルトで入っている
+2. 入っていない場合にはインストールが簡単
+3. プロポーショナルフォントが望ましい
+4. どのOSでも外観を似せたい
diff --git a/docs/native-install.md b/docs/native-install.md
diff --git a/docs/setting-fonts.md b/docs/setting-fonts.md