Skip to content

chore: make SSG favicon replaceable #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 21, 2025
+5 −0
Merged

chore: make SSG favicon replaceable #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
0 website/typst-docs-web/public/favicon.png → website/favicon.png
View file
Open in desktop
File renamed without changes
1 change: 1 addition & 0 deletions website/typst-docs-web/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ node_modules/
dist/
public/assets
public/docs.json
public/favicon.png
public/metadata.json
public/translation-status.json
2 changes: 2 additions & 0 deletions website/typst-docs-web/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading