Skip to content

Commit 76c9646

Browse files
authored
chore: make SSG favicon replaceable (typst-jp#315)
1 parent 43ca3e3 commit 76c9646

File tree

4 files changed

+5
-0
lines changed

4 files changed

+5
-0
lines changed

mise.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ run = [
2222

2323
[tasks.symlink-web-metadata]
2424
run = [
25+
"rm -rf website/typst-docs-web/public/favicon.png",
26+
"ln -s ../../favicon.png website/typst-docs-web/public/favicon.png",
2527
"rm -rf website/typst-docs-web/public/metadata.json",
2628
"ln -s ../../metadata.json website/typst-docs-web/public/metadata.json",
2729
"rm -rf website/typst-docs-web/public/translation-status.json",
File renamed without changes.

website/typst-docs-web/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@ node_modules/
22
dist/
33
public/assets
44
public/docs.json
5+
public/favicon.png
56
public/metadata.json
67
public/translation-status.json

website/typst-docs-web/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ Create `/public/metadata.json` and describe the metadata for the documentation w
5959

6060
`/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.
6161

62+
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.
63+
6264
## Commands
6365

6466
After installing dependencies with Bun, the following commands are available:

0 commit comments

Comments
 (0)