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
32 changes: 15 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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日本語ドキュメント翻訳プロジェクトにご興味をお持ちいただき、どうもありがとうございます。

Expand All @@ -13,17 +16,16 @@ 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種類から構成されています。それぞれ、下記の注意書きに従って翻訳作業をお願いします。
- `./crates/typst-library/src/`内の`.rs`ファイル群は、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を作成して、翻訳の進捗状況を共有することもできます。
Expand All @@ -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:** こちらの説明は要約版です。詳細を知りたい場合は、次以降の見出しを参照してください。

当プロジェクトのルートディレクトリに移動し、以下のコマンドを実行します。このコマンドは初回のみ実行する必要があります。

Expand All @@ -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ソースコードを翻訳した場合
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
17 changes: 0 additions & 17 deletions README.en.md

This file was deleted.

63 changes: 34 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,44 @@
# Typst 日本語ドキュメント (非公式)
<div align="center">
<img src="https://avatars.githubusercontent.com/u/172375917" width="128" height="128" alt="typst-jpのロゴ">
<h1>Typstドキュメント日本語版</h1>

[![CI/CD for website](https://github.com/typst-jp/docs/actions/workflows/website.yml/badge.svg?branch=main&event=push)](https://github.com/typst-jp/docs/actions/workflows/website.yml)
[![CI/CD for website](https://github.com/typst-jp/docs/actions/workflows/website.yml/badge.svg?branch=main&event=push)](https://github.com/typst-jp/docs/actions/workflows/website.yml)
</div>

> [!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.14.0](https://typst.app/docs/changelog/#v0.14.0) の公式ドキュメントを元に日本語訳を行います
本サイトは<https://typst-jp.github.io/docs/>で公開しています。プロジェクトの詳細は、[日本語版について](https://typst-jp.github.io/docs/about/)をご覧ください

実際に作動している Web 版は、以下の URL から閲覧できます。
> https://typst-jp.github.io/docs/
The documentation is available at <https://typst-jp.github.io/docs/>. For project details, please refer to [About the Japanese Edition](https://typst-jp.github.io/docs/about/).

## 翻訳に参加するには
## ライセンス / License

[貢献ガイドライン (CONTRIBUTING.md)](CONTRIBUTING.md) をご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls) を作成してください。[Issue](https://github.com/typst-jp/docs/issues)での質問や議論も歓迎します。
<!-- textlint-disable prh -->

ご質問などがある場合は、[「くみはんクラブ」のDiscordサーバー](https://discord.gg/9xF7k4aAuH)に参加してご連絡ください。
[typst/typst]: https://github.com/typst/typst

## 翻訳参加者
このプロジェクトは[typst/typst]からの派生プロジェクトであり、Apache-2.0 licenseでライセンスされています。

<table cellspacing="0" cellpadding="0">
<tbody>
<tr>
<td align="center"><a href="https://github.com/mkpoli"><img src="https://github.com/mkpoli.png" width="100px" alt="mkpoli"/><br /><sub><b>mkpoli</b></sub></a><br/><code>mkpoli</code><br/>言い出しっぺ<br/>保守者</td>
<td align="center"><a href="https://github.com/3w36zj6"><img src="https://github.com/3w36zj6.png" width="100px" alt="3w36zj6"/><br /><sub><b>3w36zj6</b></sub></a><br/><code>3w36zj6</code><br/>インフラ整備<br/>保守者</td>
<td align="center"><a href="https://github.com/stepney141"><img src="https://github.com/stepney141.png" width="100px" alt="stepney141"/><br /><sub><b>stepney141</b></sub></a><br/><code>stepney141</code><br/>インフラ整備<br/>保守者</td>
<td align="center"><a href="https://github.com/gomazarashi"><img src="https://github.com/gomazarashi.png" width="100px" alt="gomazarashi"/><br /><sub><b>gomazarashi</b></sub></a><br/><code>gomazarashi</code><br/>翻訳者<br/>保守者</td>
<td align="center"><a href="https://github.com/monaqa"><img src="https://github.com/monaqa.png" width="100px" alt="monaqa"/><br /><sub><b>monaqa</b></sub></a><br/><code>monaqa</code><br/>翻訳者<br/>保守者</td>
</tr>
<tr>
<td align="center"><a href="https://github.com/kimushun1101"><img src="https://github.com/kimushun1101.png" width="100px" alt="Shunsuke KIMURA"/><br /><sub><b>Shunsuke KIMURA</b></sub></a><br/><code>kimshun1101</code><br/>翻訳者<br/>保守者</td>
<td align="center"><a href="https://github.com/zr-tex8r"><img src="https://github.com/zr-tex8r.png" width="100px" alt="Takayuki YATO"/><br /><sub><b>Takayuki YATO</b></sub></a><br/><code>zr-tex8r</code><br/>アドバイザー</td>
<td align="center"><a href="https://github.com/m1sk9"><img src="https://github.com/m1sk9.png" width="100px" alt="Sho Sakuma"/><br /><sub><b>Sho Sakuma</b></sub></a><br/><code>m1sk9</code><br/>校正者</td>
<td align="center"><a href="https://github.com/ultimatile"><img src="https://github.com/ultimatile.png" width="100px" alt="ultimatile"/><br /><sub><b>ultimatile</b></sub></a><br/><code>ultimatile</code><br/>翻訳者<br/>保守者</td>
</tr>
</tbody>
</table>
This project is derived from [typst/typst] and is licensed under the Apache-2.0 license.

<!-- textlint-enable -->

## 管理者 / Maintainers

[CODEOWNERS]: https://github.com/typst-jp/docs/blob/main/.github/CODEOWNERS

現在アクティブなレビュワーは[CODEOWNERS]ファイルを参照してください。

Currently active reviewers are listed in [CODEOWNERS] file.

- [@mkpoli](https://github.com/mkpoli)
- [@3w36zj6](https://github.com/3w36zj6)
- [@stepney141](https://github.com/stepney141)
- [@gomazarashi](https://github.com/gomazarashi)
- [@monaqa](https://github.com/monaqa)
- [@kimushun1101](https://github.com/kimushun1101)
- [@zr-tex8r](https://github.com/zr-tex8r)
- [@m1sk9](https://github.com/m1sk9)
- [@ultimatile](https://github.com/ultimatile)
4 changes: 4 additions & 0 deletions TRANSLATING_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: |
翻訳ガイドライン
---
# 翻訳ガイドライン

[JTF日本語標準スタイルガイド 第3.0版]: https://www.jtf.jp/pdf/jtf_style_guide.pdf
Expand Down
47 changes: 47 additions & 0 deletions docs/about/welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
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)の性能が上がっている中で、なぜ人力で翻訳するのですか?

機械翻訳やLLMは近年大きく進歩しており、非常に自然な翻訳が可能になっています。しかし、Typstのような専門性の高い技術文書において、プロジェクト固有の用語の統一や、日本語特有の組版文化への深い理解に基づく微妙なニュアンスの調整には、人間の目による最終確認が不可欠だと考えています。
技術文書においては、わずかな誤訳や曖昧な表現がユーザーの大きな混乱につながる可能性があります。
そのため本プロジェクトでは、AIを強力なツールとして最大限活用しつつも、最終的な品質管理と原文の意図の担保は、人間が責任を持って行っています。

このようにして品質を担保することで、日本語を第一言語とするユーザーが直接正確な情報へアクセスできるようになり、Typstに触れる心理的なハードルが下がります。
結果として日本語ユーザーの増加が期待され、日本語特有の組版機能や利用事例の改善への寄与につながると考えています。

また、この活動を通じて専門用語や表現を統一し、日本語でTypstの情報を共有できる「言葉の基盤」を築くことも重要な目的です。
質問や解説記事などの整合性を保ちやすくなるだけでなく、将来的にLLMがウェブ上の情報を参照して回答を生成する際、整備された質の高い日本語ドキュメントが存在すること自体が、LLMによるTypst関連の回答の質向上にも大きく貢献します。

### 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サイトのデザインは独自のものとなっています。
Loading
Loading