Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 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
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "website/typst-docs-web"]
path = website/typst-docs-web
url = ../typst-docs-web.git
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ち
> [!WARNING]
> ここに記載されている内容は改訂中です。現在の手順は最新の[Pull Request](https://github.com/typst-jp/docs/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen)を参照してください。

1. このGitHubリポジトリをフォークします。
1. このGitHubリポジトリをフォークします。Git submoduleを含むため、必ず`--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`のコメントを編集してください。
Expand Down
15 changes: 15 additions & 0 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# website metadata

このディレクトリでは、ドキュメントのWebサイトの構築に必要なメタデータを管理しています。

また、SSG(静的サイトジェネレーター)の本体は、Git submoduleとして別リポジトリの[typst-docs-web](https://github.com/typst-jp/typst-docs-web)で管理されています。

## Git submoduleの初期化について

リポジトリを`git clone`する際に`--recursive`オプションを付けていない場合は、以下のコマンドでsubmoduleを初期化・更新できます。

```sh
git submodule update --init --recursive
```

これにより、`typst-docs-web`ディレクトリが正しく取得されます。
1 change: 1 addition & 0 deletions website/typst-docs-web
Submodule typst-docs-web added at 8d3d83
13 changes: 0 additions & 13 deletions website/typst-docs-web/.editorconfig

This file was deleted.

2 changes: 0 additions & 2 deletions website/typst-docs-web/.env.example

This file was deleted.

7 changes: 0 additions & 7 deletions website/typst-docs-web/.gitignore

This file was deleted.

117 changes: 0 additions & 117 deletions website/typst-docs-web/README.md

This file was deleted.

40 changes: 0 additions & 40 deletions website/typst-docs-web/biome.jsonc

This file was deleted.

Loading
Loading