Skip to content

Commit 3b5f7b8

Browse files
committed
docs: add TSDoc to metadata
1 parent 704e28a commit 3b5f7b8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

website/src/metadata.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
import { version } from "../package.json";
22

3+
// TODO: The metadata will be configurable via a JSON configuration file.
4+
/** The version of the documentation. */
35
export { version };
6+
/** The official Typst website URL. */
47
export const typstOfficialUrl = "https://typst.app";
8+
/** The official Typst documentation base URL. */
59
export const typstOfficialDocsUrl = "https://typst.app/docs";
10+
/** The GitHub organization URL. */
611
export const githubOrganizationUrl = "https://github.com/typst-jp";
12+
/** The GitHub repository URL. */
713
export const githubRepositoryUrl =
814
"https://github.com/typst-jp/typst-jp.github.io";
15+
/** The Discord server invite URL. */
916
export const discordServerUrl = "https://discord.gg/9xF7k4aAuH";
17+
/** The origin URL of the deployed site. */
1018
export const originUrl = "https://typst-jp.github.io/";
19+
/** The base public path for deployment. This must match the value used in typst-docs. */
1120
export const basePath: string = "/docs/";

0 commit comments

Comments
 (0)