From 964e501b9781100c9b609b13fc539a8ca0c5058c Mon Sep 17 00:00:00 2001
From: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
Date: Thu, 2 Oct 2025 21:33:10 +0900
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=97=A5=E6=9C=AC=E8=AA=9E=E7=89=88?=
=?UTF-8?q?=E3=81=AB=E3=81=A4=E3=81=84=E3=81=A6=E3=81=AE=E3=82=BB=E3=82=AF?=
=?UTF-8?q?=E3=82=B7=E3=83=A7=E3=83=B3=E3=82=92=E8=BF=BD=E5=8A=A0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
CONTRIBUTING.md | 30 ++++++++++----------
README.en.md | 17 -----------
README.md | 42 ++++++++++------------------
TRANSLATING_GUIDELINES.md | 4 +++
docs/about/contributing.md | 1 +
docs/about/translating_guidelines.md | 1 +
docs/about/welcome.md | 37 ++++++++++++++++++++++++
docs/overview.md | 10 +------
docs/src/html.rs | 1 +
docs/src/lib.rs | 15 ++++++++++
docs/src/link.rs | 1 +
website/translation-status.json | 3 ++
12 files changed, 92 insertions(+), 70 deletions(-)
delete mode 100644 README.en.md
create mode 120000 docs/about/contributing.md
create mode 120000 docs/about/translating_guidelines.md
create mode 100644 docs/about/welcome.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 407285d4c..900fb0bfa 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,10 @@
+---
+description: |
+ 貢献ガイドライン
+---
# 貢献ガイドライン
-> [!NOTE]
-> 当プロジェクトの[README](./README.md)や「[はじめに：Typst Japanese Communityより](https://typst-jp.github.io/docs/)」、[Typst公式](https://typst.app/)の[ライセンス](https://github.com/typst/typst/blob/main/LICENSE)や[コントリビューション・ガイド](https://github.com/typst/typst/blob/main/CONTRIBUTING.md)も併せてご参照ください。
+**Note:** 当プロジェクトの[README](https://github.com/typst-jp/docs/blob/main/README.md)や「[はじめに：Typst Japanese Communityより](https://typst-jp.github.io/docs/)」、[Typst公式](https://typst.app/)の[ライセンス](https://github.com/typst/typst/blob/main/LICENSE)や[コントリビューション・ガイド](https://github.com/typst/typst/blob/main/CONTRIBUTING.md)も併せてご参照ください。
Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ちいただき、どうもありがとうございます。
@@ -13,8 +16,7 @@ Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ち
### 翻訳提案の手順
-> [!WARNING]
-> ここに記載されている内容は改訂中です。現在の手順は最新の[Pull Request](https://github.com/typst-jp/docs/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen)を参照してください。
+**Warning:** ここに記載されている内容は改訂中です。現在の手順は最新の[Pull Request](https://github.com/typst-jp/docs/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen)を参照してください。
1. このGitHubリポジトリをフォークします。Git submoduleを含むため、リポジトリを`git clone`する際に`--recursive`オプションを付けてください。
2. ドキュメントの実体は、主にMarkdownファイルおよびコンパイラのソースコード内のコメントの2種類から構成されています。それぞれ、下記の注意書きに従って翻訳作業をお願いします。
@@ -22,8 +24,8 @@ Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ち
- 例1：[Reference > Foundations](https://typst.app/docs/reference/foundations/)を翻訳する際は、`./crates/typst-library/src/foundations/mod.rs`のコメントを編集してください。
- 例2：[Reference > Foundations > Arguments](https://typst.app/docs/reference/foundations/arguments/)を翻訳する際は、`./crates/typst-library/src/foundations/args.rs`のコメントを編集してください。
- `./docs`内のMarkdownファイル群は、Typstのチュートリアルや入門ガイドなど、言語リファレンス以外のページの本体です。**既存のMarkdownファイルを直接書き換えて翻訳してください**。
- - 上記いずれの場合においても、[website/translation-status.json](/website/translation-status.json)の該当箇所を`"translated"`に変更してください。
-3. 翻訳の際の文体や表記は[翻訳ガイドライン](./TRANSLATING_GUIDELINES.md)を参照してください。
+ - 上記いずれの場合においても、[website/translation-status.json](https://github.com/typst-jp/docs/blob/main/website/translation-status.json)の該当箇所を`"translated"`に変更してください。
+3. 翻訳の際の文体や表記は[翻訳ガイドライン](https://github.com/typst-jp/docs/blob/main/TRANSLATING_GUIDELINES.md)を参照してください。
- 翻訳ガイドラインに最低限沿っているかを確認する補助ツールとしてtextlintを導入しております。Pull Requestが作成されると、GitHub Actionsにてtextlintによる確認が入ります。textlintの処理が警告無く完了するように翻訳文を[文章校正](#文章校正)してください。
- ドキュメントの最新バージョンへの追従は管理者が一括で行っているため、日本語ドキュメントと公式ドキュメントのバージョンが異なる場合でも、日本語ドキュメントで管理されている原文を優先してください。
4. 翻訳作業の途中でも、Draft Pull Requestを作成して、翻訳の進捗状況を共有することもできます。
@@ -43,14 +45,11 @@ Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ち
コマンドラインでの操作を避けたい方や[Docker](https://docs.docker.com/)で作業したい方へ向けて、[Dev Containerの環境](#dev-containerによる開発環境のセットアップ)もご用意しております。
-> [!NOTE]
-> Windowsのネイティブ環境で実行する場合には、[開発者モード](https://learn.microsoft.com/ja-jp/windows/apps/get-started/enable-your-device-for-development)に設定する必要があります。
-> その他Windowsに起因する潜在的なトラブルを回避するため、Windowsユーザーには[WSL](https://learn.microsoft.com/ja-jp/windows/wsl/install)やDev Containerの使用を推奨します。
+**Note:** Windowsのネイティブ環境で実行する場合には、[開発者モード](https://learn.microsoft.com/ja-jp/windows/apps/get-started/enable-your-device-for-development)に設定する必要があります。その他Windowsに起因する潜在的なトラブルを回避するため、Windowsユーザーには[WSL](https://learn.microsoft.com/ja-jp/windows/wsl/install)やDev Containerの使用を推奨します。
#### TL;DR
-> [!NOTE]
-> こちらの説明は要約版です。詳細を知りたい場合は、次以降の見出しを参照してください。
+**Note:** こちらの説明は要約版です。詳細を知りたい場合は、次以降の見出しを参照してください。
当プロジェクトのルートディレクトリに移動し、以下のコマンドを実行します。このコマンドは初回のみ実行する必要があります。
@@ -71,7 +70,7 @@ Webサイトをローカルサーバーでプレビューするには、以下
mise run preview
```
-[翻訳ガイドライン](./TRANSLATING_GUIDELINES.md)に従った体裁になっているかどうかを確認するには、以下のコマンドを実行します。
+[翻訳ガイドライン](https://github.com/typst-jp/docs/blob/main/TRANSLATING_GUIDELINES.md)に従った体裁になっているかどうかを確認するには、以下のコマンドを実行します。
```sh
mise run textlint-html # Rustソースコードを翻訳した場合
@@ -80,12 +79,11 @@ mise run textlint-md # Markdownファイルを翻訳した場合
#### miseによる開発環境のセットアップ
-> [!NOTE]
-> 以下の内容はmise v2025.5.6に基づいています。内容の不備を発見した場合は、Issueを立ててください。
+**Note:** 以下の内容はmise v2025.5.6に基づいています。内容の不備を発見した場合は、Issueを立ててください。
miseが導入されている環境で初めて当プロジェクトのルートディレクトリに移動すると、以下のように構成ファイルを信頼することを求められます。
-```plaintext
+```txt
mise ERROR Config file /path/to/typst-jp.github.io/mise.toml is not trusted.
Trust it with `mise trust`.
mise ERROR Run with --verbose or MISE_VERBOSE=1 for more information
@@ -139,7 +137,7 @@ mise run generate
#### 文章校正
-[翻訳ガイドライン](./TRANSLATING_GUIDELINES.md)に従った体裁へと校正するための補助ツールとしてtextlintの設定も整備しております。
+[翻訳ガイドライン](https://github.com/typst-jp/docs/blob/main/TRANSLATING_GUIDELINES.md)に従った体裁へと校正するための補助ツールとしてtextlintの設定も整備しております。
`mise run textlint-html`を実行すると、生成されたWebサイトのHTMLコードをtextlintで校正します。
```sh
diff --git a/README.en.md b/README.en.md
deleted file mode 100644
index b2b7edfb6..000000000
--- a/README.en.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# Typst Japanese Documentation (Unofficial)
-
-> [!NOTE]
-> 日本語版は[README.md](README.md)を参照してください。
-
-This is an unofficial Japanese translation of the documentation for the typesetting system [Typst](https://typst.app/docs). It has been created with the permission of [Typst GmbH](https://typst.app/legal/).
-
-The repository was forked from the [Chinese version](https://github.com/typst-doc-cn/typst-doc-cn.github.io) and is translated into Japanese based on the official documentation of [Typst v0.13.1](https://typst.app/docs/changelog/#v0.13.1) as of October 2024.
-
-The actual working web version can be viewed at the following URL.
-> https://typst-jp.github.io/docs/
-
-## How to participate in translation
-
-Please refer to the [Translation Guidelines (CONTRIBUTING.md)](CONTRIBUTING.md) and create a [Pull Request](https://github.com/typst-jp/docs/pulls). Questions and discussions are also welcome in [Issues](https://github.com/typst-jp/docs/issues).
-
-Also, feel free to join our Discord server [Kumihan Club](https://discord.gg/9xF7k4aAuH) to get in touch with us directly.
diff --git a/README.md b/README.md
index be970c1de..f4fdcd263 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,25 @@
-# Typst 日本語ドキュメント (非公式)
+# Typstドキュメント日本語版
[](https://github.com/typst-jp/docs/actions/workflows/website.yml)
-> [!NOTE]
-> For English version, please refer to [README.en.md](README.en.md).
+[Typst Documentation](https://typst.app/docs/)のコミュニティ主導の日本語版。
-組版システム [Typst](https://typst.app/docs) の非公式な日本語ドキュメントです。[Typst GmbH](https://typst.app/legal/) の許諾を得て作成されています。
+A community-driven Japanese translation of the [Typst Documentation](https://typst.app/docs/).
-このリポジトリは[中国語版](https://github.com/typst-doc-cn/typst-doc-cn.github.io)からフォークして作成され、2024年10月時点での最新版である [Typst v0.13.1](https://typst.app/docs/changelog/#v0.13.1) の公式ドキュメントを元に日本語訳を行います。
+https://typst-jp.github.io/docs/
-実際に作動している Web 版は、以下の URL から閲覧できます。
-> https://typst-jp.github.io/docs/
+プロジェクトの詳細は、[日本語版について](https://typst-jp.github.io/docs/about/)をご覧ください。
-## 翻訳に参加するには
+For project details, please refer to [About the Japanese version](https://typst-jp.github.io/docs/about/).
-[貢献ガイドライン (CONTRIBUTING.md)](CONTRIBUTING.md) をご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls) を作成してください。[Issue](https://github.com/typst-jp/docs/issues)での質問や議論も歓迎します。
+## 謝辞
-ご質問などがある場合は、[「くみはんクラブ」のDiscordサーバー](https://discord.gg/9xF7k4aAuH)に参加してご連絡ください。
+このプロジェクトは、上流の[typst/typst](https://github.com/typst/typst)を含めた全ての貢献者によって支えられています。
-## 翻訳参加者
+This project is supported by all contributors, including upstream [typst/typst](https://github.com/typst/typst).
-
+
+ 
+
+
+Made with [contrib.rocks](https://contrib.rocks).
diff --git a/TRANSLATING_GUIDELINES.md b/TRANSLATING_GUIDELINES.md
index 76bbd941d..13995bca8 100644
--- a/TRANSLATING_GUIDELINES.md
+++ b/TRANSLATING_GUIDELINES.md
@@ -1,3 +1,7 @@
+---
+description: |
+ 翻訳ガイドライン
+---
# 翻訳ガイドライン
[JTF日本語標準スタイルガイド 第3.0版]: https://www.jtf.jp/pdf/jtf_style_guide.pdf
diff --git a/docs/about/contributing.md b/docs/about/contributing.md
new file mode 120000
index 000000000..f939e75f2
--- /dev/null
+++ b/docs/about/contributing.md
@@ -0,0 +1 @@
+../../CONTRIBUTING.md
\ No newline at end of file
diff --git a/docs/about/translating_guidelines.md b/docs/about/translating_guidelines.md
new file mode 120000
index 000000000..b1401fa8c
--- /dev/null
+++ b/docs/about/translating_guidelines.md
@@ -0,0 +1 @@
+../../TRANSLATING_GUIDELINES.md
\ No newline at end of file
diff --git a/docs/about/welcome.md b/docs/about/welcome.md
new file mode 100644
index 000000000..08bf33a10
--- /dev/null
+++ b/docs/about/welcome.md
@@ -0,0 +1,37 @@
+---
+description: Typstドキュメント日本語版について
+---
+
+# 日本語版について
+
+[Typst Japanese Community]: https://github.com/typst-jp/
+[Typstドキュメント日本語版]: https://typst-jp.github.io/docs/
+[くみはんクラブ]: https://discord.gg/9xF7k4aAuH
+[Typst Documentation]: https://typst.app/docs/
+
+「[Typstドキュメント日本語版]」は、組版全般の日本語での議論や情報交換のためのDiscordサーバー「[くみはんクラブ]」の有志によって構成された「[Typst Japanese Community]」が、[Typst GmbH](https://typst.app/legal/) の許諾を得た上でメンテナンスしている、Typstの公式ドキュメント「[Typst Documentation]」のコミュニティ主導の日本語版です。
+
+本プロジェクトは現在進行中のため、未翻訳の箇所や誤訳が残っている場合があります。また、情報が古くなることもあるため、バージョン情報にはご注意ください。ご利用の際は[Typst Documentation]の最新情報とあわせてご参照ください。
+
+さらに、本Webサイトでは公式ドキュメントにはない、日本語の組版に特化した情報や独自コンテンツを提供しています。
+
+本サイトの情報が、皆様のTypst利用の一助となれば幸いです。
+
+## 貢献する
+
+本Webサイトはオープンソースで、どなたでもメンテナンスにご参加いただけます。翻訳の提案や誤字脱字の修正、Typstに関する日本語記事の追加など、さまざまな形での貢献を歓迎しています。詳しくは下記ガイドラインをご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls)の作成をお願いします。[Issue](https://github.com/typst-jp/docs/issues)でのご質問やご意見もお待ちしています。
+
+- [貢献ガイドライン]($about/contributing)
+- [翻訳ガイドライン]($about/translating-guidelines)
+
+ご不明な点があれば、[くみはんクラブ]のDiscordサーバーにてお気軽にご連絡ください。
+
+## FAQ
+
+### 機械翻訳やLLMの性能が上がっている中で、なぜ人力で翻訳するのですか？
+
+### Webサイトの生成ツールはOSSですか？
+
+はい。Webサイトの生成ツールは[typst-community/typst-docs-web](https://github.com/typst-community/typst-docs-web)で配布されており、Apache-2.0 licenseで利用可能です。
+
+TypstのコンパイラとドキュメントはOSSですが、WebサイトはOSSではありません。そこで、コミュニティ主導でドキュメントのWebサイトの生成ツールを開発する必要がありました。OSSではないWebサイトのアセットを含まないため、Webサイトのデザインは独自のものとなっています。
diff --git a/docs/overview.md b/docs/overview.md
index 9afe778c9..5c888e1fd 100644
--- a/docs/overview.md
+++ b/docs/overview.md
@@ -7,18 +7,10 @@ description: |
-**はじめに: Typst Japanese Communityより**
-
-日本語版Typstのドキュメントへようこそ！ [Typst](https://typst.app/) はアカデミック・ライティング用途を念頭に開発された、TeXなどの今までのシステムを覆しうる革新的で多機能な組版エンジンです。もちろん、学術論文に限らず、雑誌や書籍の組版にも適しています。
-
-このWebサイトは、[Typst GmbH](https://typst.app/legal/) の許諾を得て、非公式日本語コミュニティ「[Typst Japanese Community](https://github.com/typst-jp/)」のボランティアたちが[公式ドキュメント](https://typst.app/docs/)を翻訳したものです。まだ翻訳途上ですので、翻訳されていない部分や誤訳などがたくさんあり、また情報が古くなる可能性もあるため、ご了承ください。最新の情報は[公式ドキュメント](https://typst.app/docs/)をご覧ください。ただし、本Webサイトには、公式ドキュメントにはない日本語の組版に特化した情報やコンテンツも掲載される予定です。
-
-皆様がTypstをご利用になる上で、本サイトの情報が一助になれば幸いです。
+「Typstドキュメント日本語版」のプロジェクトの詳細は、[日本語版について]($about)をご覧ください。
-----
-
Typstは、学術用途のために新たに生まれたマークアップベースの組版システムです。LaTeXのような高度なツールや、WordあるいはGoogleドキュメントのような手軽なツールの両方に取って代わるものとして設計されています。私たちがTypstを通して目指しているのは、高機能 _かつ_ 使っていて楽しくなるような組版ツールを作ることです。
このドキュメントは、2つの部分に分かれています：実際の使用例を通じてTypstの使い方を学べる、初心者にやさしいチュートリアル。そして、Typstのあらゆる仕様・機能を扱った包括的なリファレンスです。
diff --git a/docs/src/html.rs b/docs/src/html.rs
index 2e4e638d7..7daec64a5 100644
--- a/docs/src/html.rs
+++ b/docs/src/html.rs
@@ -229,6 +229,7 @@ impl<'a> Handler<'a> {
ty,
md::LinkType::Inline
| md::LinkType::Reference
+ | md::LinkType::Shortcut
| md::LinkType::ShortcutUnknown
| md::LinkType::Autolink
),
diff --git a/docs/src/lib.rs b/docs/src/lib.rs
index 26c01f71e..effd583af 100644
--- a/docs/src/lib.rs
+++ b/docs/src/lib.rs
@@ -92,6 +92,7 @@ pub fn provide(resolver: &dyn Resolver) -> Vec {
guide_pages(resolver),
changelog_pages(resolver),
japanese_pages(resolver),
+ about_pages(resolver),
md_page(resolver, base, load!("glossary.md")),
]
}
@@ -231,6 +232,17 @@ fn japanese_pages(resolver: &dyn Resolver) -> PageModel {
page
}
+/// Build the about section.
+fn about_pages(resolver: &dyn Resolver) -> PageModel {
+ let mut page = md_page(resolver, resolver.base(), load!("about/welcome.md"));
+ let base = format!("{}about/", resolver.base());
+ page.children = vec![
+ md_page(resolver, &base, load!("about/contributing.md")),
+ md_page(resolver, &base, load!("about/translating_guidelines.md")),
+ ];
+ page
+}
+
/// Create a page for a category.
#[track_caller]
fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
@@ -850,6 +862,9 @@ pub fn urlify(title: &str) -> EcoString {
"日本語テンプレート" => "templates".into(),
"日本語向けパッケージ" => "packages".into(),
"日本語記事" => "articles".into(),
+ "日本語版について" => "about".into(),
+ "貢献ガイドライン" => "contributing".into(),
+ "翻訳ガイドライン" => "translating-guidelines".into(),
"用語集" => "glossary".into(),
_ => title
.chars()
diff --git a/docs/src/link.rs b/docs/src/link.rs
index 463acafd0..6588ac78b 100644
--- a/docs/src/link.rs
+++ b/docs/src/link.rs
@@ -49,6 +49,7 @@ fn resolve_known(head: &str, base: &str) -> Option {
"$guides" => format!("{base}guides"),
"$changelog" => format!("{base}changelog"),
"$japanese" => format!("{base}japanese"),
+ "$about" => format!("{base}about"),
"$universe" => "https://typst.app/universe".into(),
_ => return None,
})
diff --git a/website/translation-status.json b/website/translation-status.json
index f84c854a9..e9ff0b6f5 100644
--- a/website/translation-status.json
+++ b/website/translation-status.json
@@ -191,5 +191,8 @@
"/docs/japanese/templates/": "community",
"/docs/japanese/packages/": "community",
"/docs/japanese/articles/": "community",
+ "/docs/about/": "community",
+ "/docs/about/contributing/": "community",
+ "/docs/about/translating-guidelines/": "community",
"/docs/glossary/": "community"
}
