Typst 日本語ドキュメント (非公式)

組版システム Typst の非公式な日本語ドキュメントです。Typst GmbH の許諾を得て作成されています。

このリポジトリは中国語版からフォークして作成され、2024年6月時点での最新版である Typst v0.11.1 の公式ドキュメントを元に日本語訳を行います。

実際に作動している Web 版は、以下の URL から閲覧できます。

https://typst-jp.github.io/docs/

翻訳に参加するには

1. この GitHub リポジトリをフォークします。
2. ドキュメントの実体は、以下の2種類のファイルから構成されています。
   • Typst の言語リファレンスの実体は、./docs/i18n/** 内の Yaml ファイルです。これらを日本語に訳す時は、ファイル名の末尾が -ja.yaml となるようにしてください。 例えば、https://typst.app/docs/reference/model/ を翻訳する際は、./docs/i18n/category/model-en.yaml を ./docs/i18n/category/model-ja.yaml にコピーして翻訳してください。既存の Yaml ファイルを直接書き換えて翻訳してはいけません。
   • Typst のチュートリアルや入門ガイドなど、言語リファレンス以外のページの実体は ./docs 内の Markdown ファイルです。既存の Markdown ファイルを直接書き換えて翻訳してください。
3. 「サードパーティ パッケージ」のページの翻訳を追加する場合は、./static/assets/index2ja.json も編集する必要があります。
4. 翻訳の際は、以下のガイドラインを遵守するようにしてください。
   1. v0.11.1 時点での公式ドキュメントから翻訳すること。
   2. 和文と欧文の間には半角スペースを挿入すること。
   3. 句読点は「, .」ではなく、和文の「、。」を使用すること。
   4. 不明な用語については、用語集または他のページの翻訳も参照すること。必要に応じて、Discord サーバ (後述) や Issue で相談すること。
   5. Typst のコード記述例の中に出てくる英文は、日本語に翻訳する必要はありません。
5. 翻訳作業が終わったら、Pull Request を送信してください。

ご質問などがある場合は、「くみはんクラブ」のDiscordサーバーに参加してご連絡ください。

もちろん、Discord サーバに参加していない方からの Pull Request も大いに歓迎します。

技術的な詳細

中国語版を参照してください。

ローカル環境でドキュメントを生成する

変更した Markdown/Yaml ファイルから、ローカル環境で Web サイトのデータを生成することも可能です。翻訳の際にこの作業は必須ではありませんが、書き換えたファイルが Web ページとして正しく表示されるのか確認するのに役立ちます。

まず、このリポジトリのクローンを作成し、cargo ツールチェーン、Python および Python パッケージの jinja2 と pyyaml をインストールする必要があります。

# `./docs` 以下のディレクトリを変更した場合は、次の 2 行のコマンドを実行する必要があります
cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture
# `./docs/i18n` ディレクトリのみを変更した場合は、このコマンド行を実行するだけで済みます
python ./gen.py

最終的にコンパイルされたファイルは ./dist にあります。

Node.js がインストールされている場合は、npx serve ./dist でプレビューできます。