Skip to content

refactor: use metadata constants for absolute URLs in website #266

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 2 commits into from
Aug 18, 2025
Merged

refactor: use metadata constants for absolute URLs in website #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f4379b
use metadata.ts
Its-Just-Nans Aug 15, 2025
bf45a04
refactor: use metadata constants for all absolute URLs
3w36zj6 Aug 16, 2025
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
20 changes: 9 additions & 11 deletions website/src/components/templates/BaseTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { FC, PropsWithChildren } from "hono/jsx";
import { baseUrl, typstOfficialUrl } from "../../metadata";
import type { Page } from "../../types/model";
import { getTranslationStatus } from "../../utils/translationStatus";
import {
Expand Down Expand Up @@ -41,6 +42,9 @@ export const BaseTemplate: FC<BaseTemplateProps> = ({
const route = page.route;
const outline = page.outline;
const translationStatus = getTranslationStatus(route);
const absoluteRouteUrl = new URL(route, baseUrl).toString();
const faviconUrl = new URL("/assets/favicon.png", baseUrl).toString();
const typstOfficialRouteUrl = new URL(route, typstOfficialUrl).toString();
return (
<html lang="ja" class="scroll-pt-24">
<head>
Expand All @@ -49,26 +53,20 @@ export const BaseTemplate: FC<BaseTemplateProps> = ({
<meta name="description" content={description} />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta name="theme-color" content="#239dad" />
<meta
property="og:url"
content={`https://typst-jp.github.io${route}`}
/>
<meta property="og:url" content={absoluteRouteUrl} />
<meta
property="og:title"
content={`${title} – Typstドキュメント日本語版`}
/>
<meta property="og:site_name" content="Typst" />
<meta property="og:description" content={description} />
<meta property="og:type" content="" />
<meta
property="og:image"
content="https://typst-jp.github.io/assets/favicon.png"
/>
<meta property="og:image" content={faviconUrl} />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta name="twitter:site" content="@typstapp" />
<meta name="twitter:card" content="summary_large_image" />
<link rel="canonical" href={`https://typst-jp.github.io${route}`} />
<link rel="canonical" href={absoluteRouteUrl} />
<meta name="robots" content="index, follow" />
<link rel="sitemap" type="application/xml" href="/sitemap.xml" />
<meta
Expand Down Expand Up @@ -184,7 +182,7 @@ export const BaseTemplate: FC<BaseTemplateProps> = ({
{translationStatus !== "community" && (
<div class="flex">
<a
href={`https://typst.app${route}`}
href={typstOfficialRouteUrl}
target="_blank"
rel="noopener noreferrer"
class="inline-flex items-center text-sm underline text-gray-400 hover:text-gray-600 transition-colors"
Expand All @@ -203,7 +201,7 @@ export const BaseTemplate: FC<BaseTemplateProps> = ({

{translationStatus !== "community" && (
<a
href={`https://typst.app${route}`}
href={typstOfficialRouteUrl}
target="_blank"
rel="noopener noreferrer"
class="group inline-flex items-center px-3 py-2 rounded-md border border-gray-200 bg-white hover:border-gray-500 hover:bg-gray-50 transition-all duration-200 w-fit"
Expand Down
1 change: 1 addition & 0 deletions website/src/metadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ export const githubOrganizationUrl = "https://github.com/typst-jp";
export const githubRepositoryUrl =
"https://github.com/typst-jp/typst-jp.github.io";
export const discordServerUrl = "https://discord.gg/9xF7k4aAuH";
export const baseUrl = "https://typst-jp.github.io/";
7 changes: 5 additions & 2 deletions website/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import devServer from "@hono/vite-dev-server";
import ssg from "@hono/vite-ssg";
import tailwindcss from "@tailwindcss/vite";
import { defineConfig } from "vite";
import { baseUrl } from "./src/metadata";

// typst-docsが生成したドキュメントのアセットをassets/docsにシンボリックリンクする
const assetsDocsPath = resolve(__dirname, "../assets/docs/");
Expand All @@ -15,17 +16,19 @@ const publicAssetsDocsPath = resolve(__dirname, "./public/assets/docs/");
rmSync(publicAssetsDocsPath, { recursive: true, force: true });
symlinkSync(assetsDocsPath, publicAssetsDocsPath, "dir");

const sitemapUrl = new URL("/sitemap.xml", baseUrl).href;

export default defineConfig({
plugins: [
tailwindcss(),
ssg({
plugins: [
sitemapPlugin({
baseUrl: "https://typst-jp.github.io/",
baseUrl,
}),
robotsTxtPlugin({
rules: [{ userAgent: "*", allow: ["/"] }],
sitemapUrl: "https://typst-jp.github.io/sitemap.xml",
sitemapUrl,
}),
],
}),
Expand Down