chore: make SSG Git submodule (typst-jp#316)

Co-authored-by: Shunsuke KIMURA <[email protected]>

Author: 3w36zj6

.github/workflows/website.yml

@@ -15,6 +15,8 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
       - uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
       - uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
       - run: mise run generate-docs
@@ -35,6 +37,8 @@ jobs:
     steps:
       - name: Checkout the repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
       - name: Setup tools
         uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
       - name: Install dependencies
@@ -48,6 +52,8 @@ jobs:
     steps:
       - name: Checkout the repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
       - name: Download build artifacts
         uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
         with:
@@ -58,28 +64,3 @@ jobs:
         run: bun install --frozen-lockfile
       - name: Lint HTML using textlint
         run: bun run --bun textlint-html
-
-  website-ci:
-    runs-on: ubuntu-24.04
-    defaults:
-      run:
-        working-directory: website/typst-docs-web
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - task: biome
-            name: "Run Biome CI"
-            command: "bun biome ci ."
-          - task: vitest
-            name: "Run test runner"
-            command: "bun run test"
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: Setup tools
-        uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
-      - name: Install dependencies
-        run: bun install --frozen-lockfile
-      - name: ${{ matrix.name }}
-        run: ${{ matrix.command }}

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "website/typst-docs-web"]
+	path = website/typst-docs-web
+	url = ../../typst-community/typst-docs-web.git

CONTRIBUTING.md

@@ -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を含むため、リポジトリを`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`のコメントを編集してください。

website/README.md

@@ -0,0 +1,15 @@
+# website metadata
+
+このディレクトリでは、ドキュメントのWebサイトの構築に必要なメタデータを管理しています。
+
+また、SSG（静的サイトジェネレーター）の本体は、Git submoduleとして別リポジトリの[typst-docs-web](https://github.com/typst-community/typst-docs-web)で管理されています。
+
+## Git submoduleの初期化について
+
+リポジトリを`git clone`する際に`--recursive`オプションを付けていない場合は、以下のコマンドでsubmoduleを初期化・更新できます。
+
+```sh
+git submodule update --init --recursive
+```
+
+これにより、`typst-docs-web`ディレクトリが正しく取得されます。