From 60b5e3d27644f4366d4219a407a4ee36a0e35125 Mon Sep 17 00:00:00 2001
From: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com>
Date: Sat, 20 Sep 2025 12:41:24 +0900
Subject: [PATCH] chore: make SSG favicon replaceable

---
 mise.toml                                       |   2 ++
 website/{typst-docs-web/public => }/favicon.png | Bin
 website/typst-docs-web/.gitignore               |   1 +
 website/typst-docs-web/README.md                |   2 ++
 4 files changed, 5 insertions(+)
 rename website/{typst-docs-web/public => }/favicon.png (100%)

diff --git a/mise.toml b/mise.toml
index f2a001f02..d88af2363 100644
--- a/mise.toml
+++ b/mise.toml
@@ -22,6 +22,8 @@ run = [
 
 [tasks.symlink-web-metadata]
 run = [
+    "rm -rf website/typst-docs-web/public/favicon.png",
+    "ln -s ../../favicon.png website/typst-docs-web/public/favicon.png",
     "rm -rf website/typst-docs-web/public/metadata.json",
     "ln -s ../../metadata.json website/typst-docs-web/public/metadata.json",
     "rm -rf website/typst-docs-web/public/translation-status.json",
diff --git a/website/typst-docs-web/public/favicon.png b/website/favicon.png
similarity index 100%
rename from website/typst-docs-web/public/favicon.png
rename to website/favicon.png
diff --git a/website/typst-docs-web/.gitignore b/website/typst-docs-web/.gitignore
index 712814456..8a9d307fe 100644
--- a/website/typst-docs-web/.gitignore
+++ b/website/typst-docs-web/.gitignore
@@ -2,5 +2,6 @@ node_modules/
 dist/
 public/assets
 public/docs.json
+public/favicon.png
 public/metadata.json
 public/translation-status.json
diff --git a/website/typst-docs-web/README.md b/website/typst-docs-web/README.md
index aa37f41de..fcffd0585 100644
--- a/website/typst-docs-web/README.md
+++ b/website/typst-docs-web/README.md
@@ -59,6 +59,8 @@ Create `/public/metadata.json` and describe the metadata for the documentation w
 
 `/public/translation-status.json` is used to manage the translation progress and the classification of original content. This file is automatically updated when running the SSG, so manual editing is not necessary.
 
+The image provided in `public/favicon.png` is used as the favicon for the documentation website. Currently, this image is also used as the OGP `og:image`, so please provide it in PNG format.
+
 ## Commands
 
 After installing dependencies with Bun, the following commands are available: