chore: move SSG root to subdirectory for repository separation

.github/workflows/website.yml

@@ -23,12 +23,12 @@ jobs:
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: build-artifacts
-          path: website/dist
+          path: website/typst-docs-web/dist
       - name: Deploy
         if: github.ref == 'refs/heads/main'
         uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8 # v4.7.3
         with:
-          folder: website/dist # The folder the action should deploy.
+          folder: website/typst-docs-web/dist # The folder the action should deploy.
 
   textlint-md:
     runs-on: ubuntu-24.04
@@ -52,7 +52,7 @@ jobs:
         uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
         with:
           name: build-artifacts
-          path: website/dist
+          path: website/typst-docs-web/dist
       - uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
       - name: Install dependencies
         run: bun install --frozen-lockfile
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-24.04
     defaults:
       run:
-        working-directory: ./website
+        working-directory: website/typst-docs-web
     strategy:
       fail-fast: false
       matrix:

.textlintignore

@@ -1,3 +1,3 @@
 # hayagrivaのsrc/csl/archive.rsで管理されている参考文献フォーマット
-website/dist/reference/model/bibliography/index.html
-website/dist/reference/model/cite/index.html
+website/typst-docs-web/dist/reference/model/bibliography/index.html
+website/typst-docs-web/dist/reference/model/cite/index.html

mise.toml

@@ -17,7 +17,7 @@ run = "cargo run --package typst-docs -- --assets-dir assets --out-file docs.jso
 [tasks.generate-web]
 depends = ["install-website"]
 run = ["bun run build"]
-dir = "./website"
+dir = "./website/typst-docs-web"
 
 [tasks.generate]
 run = [
@@ -27,17 +27,17 @@ run = [
 
 [tasks.install-website]
 run = "bun install --frozen-lockfile"
-dir = "./website"
+dir = "./website/typst-docs-web"
 
 [tasks.dev]
 depends = ["install-website"]
 run = "bun run dev"
-dir = "./website"
+dir = "./website/typst-docs-web"
 
 [tasks.preview]
 depends = ["install-website"]
 run = "bun run preview"
-dir = "./website"
+dir = "./website/typst-docs-web"
 
 [tasks.install-textlint]
 run = "bun install --frozen-lockfile"

package.json

@@ -4,7 +4,7 @@
   "scripts": {
     "textlint-md": "textlint ./docs/",
     "textlint-md:fix": "textlint --fix ./docs/",
-    "textlint-html": "textlint ./website/dist/"
+    "textlint-html": "textlint ./website/typst-docs-web/dist/"
   },
   "devDependencies": {
     "@types/bun": "latest",

website/metadata.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "./metadata.schema.json",
+	"$schema": "./typst-docs-web/metadata.schema.json",
 	"language": "ja-JP",
 	"version": "0.13.1",
 	"typstOfficialUrl": "https://typst.app",
@@ -9,5 +9,7 @@
 	"discordServerUrl": "https://discord.gg/9xF7k4aAuH",
 	"originUrl": "https://typst-jp.github.io/",
 	"basePath": "/docs/",
-	"displayTranslationStatus": true
+	"displayTranslationStatus": true,
+	"docsJsonPath": "../../docs.json",
+	"assetsPath": "../../assets/"
 }

website/translation-status.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "./translation-status.schema.json",
+	"$schema": "./typst-docs-web/translation-status.schema.json",
 	"/docs/": "translated",
 	"/docs/tutorial/": "translated",
 	"/docs/tutorial/writing-in-typst/": "translated",

website/metadata.schema.json → website/typst-docs-web/metadata.schema.json

@@ -49,6 +49,14 @@
 		"displayTranslationStatus": {
 			"type": "boolean",
 			"description": "Indicates whether to display the translation status on the site. Community content is always displayed."
+		},
+		"docsJsonPath": {
+			"type": "string",
+			"description": "The relative path to docs.json from the SSG project root."
+		},
+		"assetsPath": {
+			"type": "string",
+			"description": "The relative path to the assets directory from the SSG project root."
 		}
 	},
 	"required": [
@@ -61,6 +69,8 @@
 		"discordServerUrl",
 		"originUrl",
 		"basePath",
-		"displayTranslationStatus"
+		"displayTranslationStatus",
+		"docsJsonPath",
+		"assetsPath"
 	]
 }

website/src/index.tsx → website/typst-docs-web/src/index.tsx

@@ -2,7 +2,7 @@ import { serveStatic } from "@hono/node-server/serve-static";
 import { Hono } from "hono";
 import { appendTrailingSlash, trimTrailingSlash } from "hono/trailing-slash";
 // Documentation generated by typst-docs.
-import docsJson from "../../docs.json";
+import docsJson from "../public/docs.json";
 import {
 	CategoryTemplate,
 	FuncTemplate,

website/src/metadata.ts → website/typst-docs-web/src/metadata.ts

@@ -1,4 +1,4 @@
-import metadataJson from "../metadata.json";
+import metadataJson from "../../metadata.json";
 
 type Metadata = {
 	language: "ja-JP" | "en-US";
@@ -11,6 +11,8 @@ type Metadata = {
 	originUrl: string;
 	basePath: "/" | `/${string}/`;
 	displayTranslationStatus: boolean;
+	docsJsonPath: string;
+	assetsPath: string;
 };
 
 const metadata = metadataJson as Metadata;
@@ -35,3 +37,7 @@ export const originUrl = metadata.originUrl;
 export const basePath = metadata.basePath;
 /** Indicates whether to display the translation status on the site. Community content is always displayed. */
 export const displayTranslationStatus = metadata.displayTranslationStatus;
+/** The relative path to docs.json from the SSG project root. */
+export const docsJsonPath = metadata.docsJsonPath;
+/** The relative path to the assets directory from the SSG project root. */
+export const assetsPath = metadata.assetsPath;

website/src/utils/translationStatus.ts → website/typst-docs-web/src/utils/translationStatus.ts

@@ -12,7 +12,7 @@ export type TranslationStatusMap = {
 };
 
 const TRANSLATION_STATUS_FILE = path.resolve(
-	process.cwd(),
+	path.dirname(process.cwd()),
 	"translation-status.json",
 );
 

website/vite.config.ts → website/typst-docs-web/vite.config.ts

@@ -6,17 +6,17 @@ import devServer, { defaultOptions } from "@hono/vite-dev-server";
 import ssg from "@hono/vite-ssg";
 import tailwindcss from "@tailwindcss/vite";
 import { defineConfig } from "vite";
-import { basePath, originUrl } from "./src/metadata";
+import { assetsPath, basePath, docsJsonPath, originUrl } from "./src/metadata";
 import { joinPath } from "./src/utils/path";
 
 // Create a symbolic link to the assets generated by typst-docs in ./public/assets/
-const assetsDocsPath = resolve(__dirname, "../assets/");
+const assetsDocsPath = resolve(__dirname, assetsPath);
 const publicAssetsDocsPath = resolve(__dirname, "./public/assets/");
 rmSync(publicAssetsDocsPath, { recursive: true, force: true });
 symlinkSync(assetsDocsPath, publicAssetsDocsPath, "dir");
 
 // Create a symbolic link to the assets generated by typst-docs in ./public/docs.json
-const jsonDocsPath = resolve(__dirname, "../docs.json");
+const jsonDocsPath = resolve(__dirname, docsJsonPath);
 const publicJsonDocsPath = resolve(__dirname, "./public/docs.json");
 rmSync(publicJsonDocsPath, { recursive: true, force: true });
 symlinkSync(jsonDocsPath, publicJsonDocsPath, "file");