Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 9 additions & 68 deletions docs/japanese.md → docs/japanese/articles.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,22 @@
---
description: |
日本語ユーザーガイド
Typstに関する日本語記事のまとめです。
---

# 日本語ユーザーガイド
# 日本語記事

<div class="info-box">
<p>このページの内容は公式ドキュメントには含まれておらず、日本語コミュニティによって独自に追加されたものです。</p>
</div>

このページでは、Typstで日本語組版を行うユーザー向けの情報を提供します。有益な情報をお持ちの方は、ぜひIssueやPull Requestを通じて貢献してください。

ここでは日本語に特化した情報を提供します。日本語だけに限らず、多言語を対象とする情報については、[Awesome Typst](https://github.com/qjcg/awesome-typst)などを参照してください。

## テンプレート

### 一般

- [typst-jp-template](https://github.com/satshi/typst-jp-template) - pLaTeXでのjarticle風のとりあえず日本語で書き始めるためのテンプレート
- [How-to-use-typst-for-paper-jp](https://github.com/kimushun1101/How-to-use-typst-for-paper-jp) - Typstの特徴と使い方、論文を書くときに使えるコード例をまとめた資料
- [typst-jp-conf-template](https://github.com/kimushun1101/typst-jp-conf-template) - Typstで日本語論文を書くときのテンプレート
- [master_thesis_template_for_typst](https://github.com/ut-khanlab/master_thesis_template_for_typst) - 修論用のTypstのテンプレート
- [rinko_template_for_typst](https://github.com/hamataku/rinko_template_for_typst) - 東京大学電気系の輪講資料を作成するためのテンプレート
- [academic-writing-templates](https://github.com/borh-lab/academic-writing-templates) - 大阪大学大学院の中間発表テンプレート

### 学会

#### 公式

- [第12回 制御部門マルチシンポジウム](https://mscs2025.sice-ctrl.jp/)
- [https://mscs2025.sice-ctrl.jp/cfp](https://mscs2025.sice-ctrl.jp/cfp)
- [https://github.com/kimushun1101/mscs2025-typst](https://github.com/kimushun1101/mscs2025-typst)
- [第67回 自動制御連合講演会](https://rengo67.iscie.or.jp/)
- [https://rengo67.iscie.or.jp/info/manuscript_guidelne/](https://rengo67.iscie.or.jp/info/manuscript_guidelne/)
- [https://github.com/kimushun1101/rengo2024-typst](https://github.com/kimushun1101/rengo2024-typst)
- [第42回 日本ロボット学会学術講演会](https://ac.rsj-web.org/2024/)
- [https://ac.rsj-web.org/2024/manuscript.html](https://ac.rsj-web.org/2024/manuscript.html)

#### 非公式

- 情報処理学会
- [ipsj-typst-template](https://github.com/mkpoli/ipsj-typst-template) - 情報処理学会(IPSJ)の研究報告テンプレート
- [ipsj-national-convention-typst-template](https://github.com/kajiLabTeam/ipsj-national-convention-typst-template) - 情報処理学会全国大会テンプレート
- 電気学会
- [Typst 備忘録 -自作書式のサンプル-](https://powercore.hatenablog.com/entry/2023/12/21/114030) - 電気学会全国大会テンプレート

### 試験

- [typst-anshere](https://github.com/1STEP621/typst-anshere) - 試験の解答欄を作るためのテンプレート

### 設計書

- [SoftwareDesignTypst](https://github.com/ctenopoma/SoftwareDesignTypst) - ソフトウェア設計書のテンプレート

### 履歴書

- [typst-ja-resume-template](https://github.com/Nikudanngo/typst-ja-resume-template) - 履歴書のテンプレート

### 請求書

- [inboisu](https://github.com/mkpoli/typst-inboisu) - 日本語の請求書を作成するためのテンプレート

## パッケージ

- [rubby](https://typst.app/universe/package/rubby) - ふりがなを振る
- [roremu](https://typst.app/universe/package/roremu) - 日本語のダミーテキストを生成する

## 記事

Typstに関する日本語の記事は[Zenn](https://zenn.dev/)や[Qiita](https://qiita.com/)に沢山掲載されています。以下のリンクからその一覧が見られます。

- [Typstの記事一覧 | Zenn](https://zenn.dev/topics/typst) - ZennのTypstトピック
- [Typstとは?開発に役立つ使い方、トレンド記事やtips - Qiita](https://qiita.com/tags/typst) - QiitaのTypstタグ

また、個人ブログ・ウィキサイトなどでもまとめられています。様々なプラットフォームから、いくつかピックアップしたものが以下に整理されています。

### 総合入門
## 総合入門

- [Typst入門](https://okumuralab.org/~okumura/misc/241111.html) - LaTeX美文書作成入門の著者として知られる奥村晴彦氏によるTypst入門記事
- [Typstの使い方](https://kumaroot.readthedocs.io/ja/latest/typst/typst-usage.html) -「くまROOT」by Shota TAKAHASHI
Expand All @@ -93,23 +34,23 @@ Typstに関する日本語の記事は[Zenn](https://zenn.dev/)や[Qiita](https:
- [これからLaTeXをするなら Typst はオススメ!](https://zenn.dev/saito_atsushi/articles/2b56f58c4fe3ca) - @saito_atsushi
- [非プログラミング者のためのTypst公式ドキュメント攻略ガイド](https://zrbabbler.hatenablog.com/entry/2024/05/02/125454) - ZR-TeXnobabbler

### 実践事例
## 実践事例

- [学校のレポートをTypstで書こう](https://zenn.dev/1step621/articles/b427a8ee518e26)
- [Typstで試験の解答欄を作ってみた](https://zenn.dev/1step621/articles/df285be712d9d5)
- [Typstでファイルを分割して本を書く](https://zenn.dev/kawaxumax/articles/bf629f56cc2928)
- [Typstでファイルを分割して本を書く](https://zenn.dev/kawaxumax/articles/bf629f56cc2928)
- [Quarto + Typstでアカデミックなスライドを作る](https://zenn.dev/nicetak/articles/quarto-typst-slides)
- [Quarto + TypstでCVを自動で作る](https://zenn.dev/nicetak/articles/quarto-typst-cv)
- [Rust製の組版システムTypstを使ってみた](https://zenn.dev/xbit/articles/bdb59d0081b2d3)
- [polylux ~Typstでスライドを作ろう!!~](https://zenn.dev/k_84mo10/articles/how2use-polylux1)
- [話題の組版エンジン Typst を触ってみた](https://zenn.dev/monaqa/articles/2023-04-19-typst-introduction)

### 環境設定
## 環境設定

- [NeovimでTypstを書くための環境準備](https://zenn.dev/htsulfuric/articles/typst_and_nvim)
- [typst の環境を WSL 上に作る (1)](https://zenn.dev/derwind/articles/dwd-typst-env01)

### 和欧混植
## 和欧混植

- [Typstで日本語文字と英数字のフォントを別々に指定する](https://zenn.dev/mkpoli/articles/6234c1d2a595bd)
- [Typst で和文と欧文の境界に隙間を入れる](https://zenn.dev/saito_atsushi/articles/db7e458fd3f49f)
Expand All @@ -118,7 +59,7 @@ Typstに関する日本語の記事は[Zenn](https://zenn.dev/)や[Qiita](https:
- [Typst最初の段落の字下げの調整方法](https://zenn.dev/mkpoli/articles/34a5ea47468979)
- [Typst で製本用PDF を作りたい](https://zenn.dev/nabetani/articles/c8deca489b4880)

### トリビア
## トリビア

- [Typstにおける番号付け指南:基本から高度なカスタマイズまで](https://zenn.dev/mkpoli/articles/eff001d9e691cb)
- [Typstで現時刻を取得する方法](https://zenn.dev/mkpoli/articles/b0e60a6bc07b10)
Expand All @@ -134,7 +75,7 @@ Typstに関する日本語の記事は[Zenn](https://zenn.dev/)や[Qiita](https:
- [Typstの空白について](https://event.phys.s.u-tokyo.ac.jp/physlab2024/advent-calendar/13/)
- [Typst 便利パッケージと使用例の紹介](https://event.phys.s.u-tokyo.ac.jp/physlab2024/advent-calendar/8/)

### 開発参加
## 開発参加

- [Typstの日本語Lipsumパッケージを作ってみた件](https://zenn.dev/mkpoli/articles/7e54c1c780ff43)
- [Typstのimage関数にrotationパラメタを追加したかった話](https://zenn.dev/htsulfuric/articles/1e7ee5b0ccc223)
Expand Down
13 changes: 13 additions & 0 deletions docs/japanese/packages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
description: |
Typstの日本語向けパッケージのまとめです。
---

# 日本語向けパッケージ

<div class="info-box">
<p>このページの内容は公式ドキュメントには含まれておらず、日本語コミュニティによって独自に追加されたものです。</p>
</div>

- [rubby](https://typst.app/universe/package/rubby) - ふりがなを振る
- [roremu](https://typst.app/universe/package/roremu) - 日本語のダミーテキストを生成する
56 changes: 56 additions & 0 deletions docs/japanese/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
description: |
Typstの日本語テンプレートのまとめです。
---

# 日本語テンプレート

<div class="info-box">
<p>このページの内容は公式ドキュメントには含まれておらず、日本語コミュニティによって独自に追加されたものです。</p>
</div>

## 一般

- [typst-jp-template](https://github.com/satshi/typst-jp-template) - pLaTeXでのjarticle風のとりあえず日本語で書き始めるためのテンプレート
- [How-to-use-typst-for-paper-jp](https://github.com/kimushun1101/How-to-use-typst-for-paper-jp) - Typstの特徴と使い方、論文を書くときに使えるコード例をまとめた資料
- [typst-jp-conf-template](https://github.com/kimushun1101/typst-jp-conf-template) - Typstで日本語論文を書くときのテンプレート
- [master_thesis_template_for_typst](https://github.com/ut-khanlab/master_thesis_template_for_typst) - 修論用のTypstのテンプレート
- [rinko_template_for_typst](https://github.com/hamataku/rinko_template_for_typst) - 東京大学電気系の輪講資料を作成するためのテンプレート
- [academic-writing-templates](https://github.com/borh-lab/academic-writing-templates) - 大阪大学大学院の中間発表テンプレート

## 学会

### 公式

- [第12回 制御部門マルチシンポジウム](https://mscs2025.sice-ctrl.jp/)
- [https://mscs2025.sice-ctrl.jp/cfp](https://mscs2025.sice-ctrl.jp/cfp)
- [https://github.com/kimushun1101/mscs2025-typst](https://github.com/kimushun1101/mscs2025-typst)
- [第67回 自動制御連合講演会](https://rengo67.iscie.or.jp/)
- [https://rengo67.iscie.or.jp/info/manuscript_guidelne/](https://rengo67.iscie.or.jp/info/manuscript_guidelne/)
- [https://github.com/kimushun1101/rengo2024-typst](https://github.com/kimushun1101/rengo2024-typst)
- [第42回 日本ロボット学会学術講演会](https://ac.rsj-web.org/2024/)
- [https://ac.rsj-web.org/2024/manuscript.html](https://ac.rsj-web.org/2024/manuscript.html)

### 非公式

- 情報処理学会
- [ipsj-typst-template](https://github.com/mkpoli/ipsj-typst-template) - 情報処理学会(IPSJ)の研究報告テンプレート
- [ipsj-national-convention-typst-template](https://github.com/kajiLabTeam/ipsj-national-convention-typst-template) - 情報処理学会全国大会テンプレート
- 電気学会
- [Typst 備忘録 -自作書式のサンプル-](https://powercore.hatenablog.com/entry/2023/12/21/114030) - 電気学会全国大会テンプレート

## 試験

- [typst-anshere](https://github.com/1STEP621/typst-anshere) - 試験の解答欄を作るためのテンプレート

## 設計書

- [SoftwareDesignTypst](https://github.com/ctenopoma/SoftwareDesignTypst) - ソフトウェア設計書のテンプレート

## 履歴書

- [typst-ja-resume-template](https://github.com/Nikudanngo/typst-ja-resume-template) - 履歴書のテンプレート

## 請求書

- [inboisu](https://github.com/mkpoli/typst-inboisu) - 日本語の請求書を作成するためのテンプレート
19 changes: 19 additions & 0 deletions docs/japanese/welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
description: Typstの日本語組版のための情報を提供します。
---

# 日本語組版情報

<div class="info-box">
<p>このページの内容は公式ドキュメントには含まれておらず、日本語コミュニティによって独自に追加されたものです。</p>
</div>

このページでは、Typstで日本語組版を行うユーザー向けの情報を提供します。有益な情報をお持ちの方は、ぜひIssueやPull Requestを通じて貢献してください。

ここでは日本語に特化した情報を提供します。日本語だけに限らず、多言語を対象とする情報については、[Awesome Typst](https://github.com/qjcg/awesome-typst)などを参照してください。

## コンテンツ一覧

- [日本語テンプレート]($japanese/templates)
- [日本語向けパッケージ]($japanese/packages)
- [日本語記事]($japanese/articles)
36 changes: 33 additions & 3 deletions docs/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ pub fn provide(resolver: &dyn Resolver) -> Vec<PageModel> {
vec![
md_page(resolver, base, load!("overview.md")).with_route(base),
tutorial_pages(resolver),
md_page(resolver, base, load!("japanese.md")),
reference_pages(resolver),
guide_pages(resolver),
changelog_pages(resolver),
japanese_pages(resolver),
md_page(resolver, base, load!("glossary.md")),
]
}
Expand Down Expand Up @@ -172,6 +172,7 @@ fn reference_pages(resolver: &dyn Resolver) -> PageModel {
fn guide_pages(resolver: &dyn Resolver) -> PageModel {
let mut page = md_page(resolver, resolver.base(), load!("guides/welcome.md"));
let base = format!("{}guides/", resolver.base());
page.title = "ガイド".into();
page.children = vec![
md_page(resolver, &base, load!("guides/guide-for-latex-users.md")),
md_page(resolver, &base, load!("guides/page-setup.md")),
Expand All @@ -184,6 +185,7 @@ fn guide_pages(resolver: &dyn Resolver) -> PageModel {
fn changelog_pages(resolver: &dyn Resolver) -> PageModel {
let mut page = md_page(resolver, resolver.base(), load!("changelog/welcome.md"));
let base = format!("{}changelog/", resolver.base());
page.title = "変更履歴".into();
page.children = vec![
md_page(resolver, &base, load!("changelog/0.12.0.md")),
md_page(resolver, &base, load!("changelog/0.11.1.md")),
Expand All @@ -203,6 +205,18 @@ fn changelog_pages(resolver: &dyn Resolver) -> PageModel {
page
}

/// Build the japanese section.
fn japanese_pages(resolver: &dyn Resolver) -> PageModel {
let mut page = md_page(resolver, resolver.base(), load!("japanese/welcome.md"));
let base = format!("{}japanese/", resolver.base());
page.children = vec![
md_page(resolver, &base, load!("japanese/templates.md")),
md_page(resolver, &base, load!("japanese/packages.md")),
md_page(resolver, &base, load!("japanese/articles.md")),
];
page
}

/// Create a page for a category.
#[track_caller]
fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
Expand Down Expand Up @@ -340,9 +354,22 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
outline.push(OutlineItem::from_name("Shorthands"));
}

let translated_title = match name {
"Foundations" => "基礎",
"Model" => "モデル",
"Text" => "文章",
"Math" => "数式",
"Symbols" => "記号",
"Layout" => "レイアウト",
"Visualize" => "視覚化",
"Introspection" => "内省",
"Data Loading" => "データの読み込み",
_ => name,
};

PageModel {
route,
title: name.into(),
title: translated_title.into(),
description: eco_format!(
"Documentation for functions related to {name} in Typst."
),
Expand Down Expand Up @@ -749,7 +776,6 @@ pub fn urlify(title: &str) -> EcoString {
"書式を設定する" => "formatting".into(),
"高度なスタイリング" => "advanced-styling".into(),
"テンプレートを作成する" => "making-a-template".into(),
"日本語ユーザーガイド" => "japanese".into(),
"リファレンス" => "reference".into(),
"構文" => "syntax".into(),
"スタイル設定" => "styling".into(),
Expand All @@ -761,6 +787,10 @@ pub fn urlify(title: &str) -> EcoString {
"更新日志" => "changelog".into(),
"路线图" => "roadmap".into(),
"社区" => "community".into(),
"日本語組版情報" => "japanese".into(),
"日本語テンプレート" => "templates".into(),
"日本語向けパッケージ" => "packages".into(),
"日本語記事" => "articles".into(),
"用語集" => "glossary".into(),
_ => title
.chars()
Expand Down
1 change: 1 addition & 0 deletions docs/src/link.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ fn resolve_known(head: &str, base: &str) -> Option<String> {
"$context" => format!("{base}reference/context"),
"$guides" => format!("{base}guides"),
"$changelog" => format!("{base}changelog"),
"$japanese" => format!("{base}japanese"),
"$universe" => "https://typst.app/universe".into(),
_ => return None,
})
Expand Down