Skip to content

Commit e0f6a40

Browse files
committed
chore: add metadata JSON file for website configuration
1 parent 18f7590 commit e0f6a40

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

website/metadata.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"$schema": "./metadata.schema.json",
3+
"version": "0.13.1",
4+
"typstOfficialUrl": "https://typst.app",
5+
"typstOfficialDocsUrl": "https://typst.app/docs/",
6+
"githubOrganizationUrl": "https://github.com/typst",
7+
"githubRepositoryUrl": "https://github.com/typst/typst",
8+
"discordServerUrl": "https://discord.gg/typst",
9+
"originUrl": "https://typst.app",
10+
"basePath": "/",
11+
"displayTranslationStatus": true
12+
}

website/metadata.schema.json

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema#",
3+
"type": "object",
4+
"properties": {
5+
"version": {
6+
"type": "string",
7+
"description": "The version of the documentation, without a leading 'v'."
8+
},
9+
"typstOfficialUrl": {
10+
"type": "string",
11+
"format": "uri",
12+
"description": "The official Typst website URL."
13+
},
14+
"typstOfficialDocsUrl": {
15+
"type": "string",
16+
"description": "The official Typst documentation base URL.",
17+
"pattern": "^https?://.+/$"
18+
},
19+
"githubOrganizationUrl": {
20+
"type": "string",
21+
"format": "uri",
22+
"description": "The GitHub organization URL."
23+
},
24+
"githubRepositoryUrl": {
25+
"type": "string",
26+
"format": "uri",
27+
"description": "The GitHub repository URL."
28+
},
29+
"discordServerUrl": {
30+
"type": "string",
31+
"format": "uri",
32+
"description": "The Discord server invite URL."
33+
},
34+
"originUrl": {
35+
"type": "string",
36+
"format": "uri",
37+
"description": "The origin URL of the deployed site, used for metadata. Note that the base path should not be included."
38+
},
39+
"basePath": {
40+
"type": "string",
41+
"description": "The base public path for deployment. This must match the value used in typst-docs.",
42+
"pattern": "^/$|^/[^/]+/$"
43+
},
44+
"displayTranslationStatus": {
45+
"type": "boolean",
46+
"description": "Indicates whether to display the translation status on the site. Community content is always displayed."
47+
}
48+
},
49+
"required": [
50+
"version",
51+
"typstOfficialUrl",
52+
"typstOfficialDocsUrl",
53+
"githubOrganizationUrl",
54+
"githubRepositoryUrl",
55+
"discordServerUrl",
56+
"originUrl",
57+
"basePath",
58+
"displayTranslationStatus"
59+
]
60+
}

0 commit comments

Comments
 (0)