diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 842a5aa1b..a5ba22bc1 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)や「[日本語版について](https://typst-jp.github.io/docs/about/)」、[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
@@ -117,7 +115,7 @@ mise run generate-docs
Webサイトの生成にはNode.jsとViteとHonoを使用しています。また、パッケージ管理にBunを使用しています。
-`mise run generate-web`を実行すると、`docs.json`を基にWebサイトのデータが`website/typst-docs-web/dist/`に生成されます。
+`mise run generate-web`を実行すると、`docs.json`をもとにWebサイトのデータが`website/typst-docs-web/dist/`に生成されます。
```sh
mise run generate-web
@@ -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 e99349e8f..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.14.0](https://typst.app/docs/changelog/#v0.14.0) 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 74df318eb..1d59dda64 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,44 @@
-# Typst 日本語ドキュメント (非公式)
+
+
+
Typstドキュメント日本語版
-[](https://github.com/typst-jp/docs/actions/workflows/website.yml)
+ [](https://github.com/typst-jp/docs/actions/workflows/website.yml)
+
-**はじめに: 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 cd69701d9..f2ab68e79 100644
--- a/docs/src/html.rs
+++ b/docs/src/html.rs
@@ -233,6 +233,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 3b6f2a269..3d886283d 100644
--- a/docs/src/lib.rs
+++ b/docs/src/lib.rs
@@ -96,6 +96,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")),
]
}
@@ -263,6 +264,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!("../CONTRIBUTING.md")),
+ md_page(resolver, &base, load!("../TRANSLATING_GUIDELINES.md")),
+ ];
+ page
+}
+
/// Create a page for a category.
#[track_caller]
fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
@@ -1019,6 +1031,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 60abf12dc..61e6c911d 100644
--- a/docs/src/link.rs
+++ b/docs/src/link.rs
@@ -60,6 +60,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 1e704f2d5..9af9f916f 100644
--- a/website/translation-status.json
+++ b/website/translation-status.json
@@ -200,5 +200,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"
}
