fix(docs): localize the docs homepage, nav, and sidebar chrome across 20 languages (#547)

Localize the docs homepage (DocsHome.vue), top nav, and sidebar structural labels into all 20 non-English locales; individual tool names stay English by design. Also derive the homepage tool-count chips from the shared catalog via toolSection() so they no longer drift.
This commit is contained in:
SnapOtter
2026-07-17 09:18:26 +08:00
committed by GitHub
parent fe85dd2b98
commit 9247947704
5 changed files with 1937 additions and 49 deletions
+91 -3
View File
@@ -3,6 +3,7 @@ import llmstxt from "vitepress-plugin-llms";
import { pagefindPlugin } from "vitepress-plugin-pagefind";
import pkg from "../../../package.json";
import { SUPPORTED_LOCALES } from "../../../packages/shared/src/i18n/index.ts";
import { t } from "./i18n/ui.mjs";
const NON_EN = SUPPORTED_LOCALES.filter((l) => l.code !== "en");
const HOSTNAME = "https://docs.snapotter.com";
@@ -20,6 +21,93 @@ function prefixLinks(items: any[], locale: string): any[] {
});
}
// Translate top-level nav labels for a locale via the shared UI catalog. Labels
// with no mapping (e.g. the version item) pass through unchanged. The nav is a
// flat list, so no recursion is needed here.
const NAV_KEY: Record<string, string> = {
Home: "nav.home",
Guide: "nav.guide",
Tools: "nav.tools",
"API Reference": "nav.apiReference",
Changelog: "nav.changelog",
};
// biome-ignore lint/suspicious/noExplicitAny: VitePress nav item trees are recursively typed.
function localizeNav(items: any[], locale: string): any[] {
return (items ?? []).map((it) => {
const next = { ...it };
const key = NAV_KEY[next.text];
if (key) next.text = t(locale, key);
return next;
});
}
// Structural sidebar labels -> UI-catalog key. Individual tool names (the
// /tools/ leaves) are intentionally absent, so they stay in English; the
// acronym-only guide labels (OIDC / SSO, SAML SSO) are absent for the same
// reason. Reuses nav.* / home.mod.* / home.card.* keys where the label matches.
const SIDEBAR_KEY: Record<string, string> = {
Guide: "nav.guide",
Tools: "nav.tools",
Image: "home.mod.image",
Video: "home.mod.video",
Audio: "home.mod.audio",
PDF: "home.mod.pdf",
Files: "home.mod.files",
Essentials: "sidebar.cat.essentials",
Optimization: "sidebar.cat.optimization",
Adjustments: "sidebar.cat.adjustments",
"Watermark & Overlay": "sidebar.cat.watermarkOverlay",
Utilities: "sidebar.cat.utilities",
Layout: "sidebar.cat.layout",
Format: "sidebar.cat.format",
"AI Tools": "sidebar.cat.aiTools",
"API reference": "sidebar.sec.apiReference",
Project: "sidebar.sec.project",
"REST API": "home.card.restApi",
"Image engine": "sidebar.page.imageEngine",
"AI engine": "sidebar.page.aiEngine",
Changelog: "nav.changelog",
"Getting started": "sidebar.guide.gettingStarted",
Architecture: "sidebar.guide.architecture",
Configuration: "sidebar.guide.configuration",
"SCIM Provisioning": "sidebar.guide.scimProvisioning",
"Users, Roles & Permissions": "sidebar.guide.usersRolesPermissions",
Database: "sidebar.guide.database",
"Upgrading from 1.x": "sidebar.guide.upgrading",
Deployment: "sidebar.guide.deployment",
"Security & Hardening": "sidebar.guide.securityHardening",
"What SnapOtter collects": "sidebar.guide.telemetry",
"Supported Formats": "sidebar.guide.supportedFormats",
"Hardware requirements": "sidebar.guide.hardware",
"Docker tags": "sidebar.guide.dockerTags",
"Developer guide": "sidebar.guide.developer",
"Translation guide": "sidebar.guide.translations",
Contributing: "sidebar.guide.contributing",
};
// Translate a locale's sidebar tree. Only "structural" nodes are eligible:
// group headers (anything with child items) and non-tool doc pages (/guide/,
// /api/, /changelog). Tool leaves (/tools/) never qualify, so a tool whose name
// happens to collide with a structural label is still left in English.
// biome-ignore lint/suspicious/noExplicitAny: VitePress sidebar item trees are recursively typed.
function localizeSidebar(items: any[], locale: string): any[] {
return (items ?? []).map((it) => {
const next = { ...it };
const link = typeof next.link === "string" ? next.link : "";
const structural =
Array.isArray(next.items) ||
link.startsWith("/guide/") ||
link.startsWith("/api/") ||
link === "/changelog";
if (structural) {
const key = SIDEBAR_KEY[next.text];
if (key) next.text = t(locale, key);
}
if (Array.isArray(next.items)) next.items = localizeSidebar(next.items, locale);
return next;
});
}
export default defineConfig({
title: "SnapOtter",
description:
@@ -177,11 +265,11 @@ export default defineConfig({
dir: l.dir,
link: `/${l.code}/`,
themeConfig: {
nav: prefixLinks(buildBaseTheme().nav, l.code),
sidebar: prefixLinks(buildBaseTheme().sidebar, l.code),
nav: prefixLinks(localizeNav(buildBaseTheme().nav, l.code), l.code),
sidebar: prefixLinks(localizeSidebar(buildBaseTheme().sidebar, l.code), l.code),
editLink: {
pattern: "https://github.com/snapotter-hq/snapotter/edit/main/apps/docs/:path",
text: "Edit this page on GitHub",
text: t(l.code, "sidebar.editLink"),
},
},
},