@astrojs/starlight 0.0.13 → 0.0.14

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @astrojs/starlight
 
+## 0.0.14
+
+### Patch Changes
+
+- [#95](https://github.com/withastro/starlight/pull/95) [`de24b54`](https://github.com/withastro/starlight/commit/de24b54971577912979a3fb67570f4c95efe27a6) Thanks [@delucis](https://github.com/delucis)! - Support translations in sidebar config
+
+- [#97](https://github.com/withastro/starlight/pull/97) [`2d51762`](https://github.com/withastro/starlight/commit/2d517623fb8670d4e7f2656eacff0d5beb27d95a) Thanks [@morinokami](https://github.com/morinokami)! - Add Japanese language support
+
 ## 0.0.13
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",

package/translations/index.ts

@@ -2,9 +2,10 @@ import { i18nSchema } from '../schemas/i18n';
 import en from './en.json';
 import es from './es.json';
 import de from './de.json';
+import ja from './ja.json';
 
 const parse = i18nSchema().required().strict().parse;
 
 export default Object.fromEntries(
-  Object.entries({ en, es, de }).map(([key, dict]) => [key, parse(dict)])
+  Object.entries({ en, es, de, ja }).map(([key, dict]) => [key, parse(dict)])
 );

package/translations/ja.json

@@ -0,0 +1,20 @@
+{
+  "skipLink.label": "コンテンツにスキップ",
+  "search.label": "検索",
+  "search.shortcutLabel": "（/を押して検索）",
+  "search.cancelLabel": "キャンセル",
+  "themeSelect.accessibleLabel": "テーマの選択",
+  "themeSelect.dark": "ダーク",
+  "themeSelect.light": "ライト",
+  "themeSelect.auto": "自動",
+  "languageSelect.accessibleLabel": "言語の選択",
+  "menuButton.accessibleLabel": "メニュー",
+  "sidebarNav.accessibleLabel": "メイン",
+  "tableOfContents.onThisPage": "目次",
+  "tableOfContents.overview": "概要",
+  "i18n.untranslatedContent": "このコンテンツはまだ日本語訳がありません。",
+  "page.editLink": "ページを編集",
+  "page.lastUpdated": "最終更新日:",
+  "page.previousLink": "前へ",
+  "page.nextLink": "次へ"
+}

package/utils/i18n.ts

@@ -0,0 +1,16 @@
+/**
+ * Get the string for the passed language from a dictionary object.
+ *
+ * TODO: Make this clever. Currently a simple key look-up, but should use
+ * BCP-47 mapping so that e.g. `en-US` returns `en` strings, and use the
+ * site’s default locale as a last resort.
+ *
+ * @example
+ * pickLang({ en: 'Hello', fr: 'Bonjour' }, 'en'); // => 'Hello'
+ */
+export function pickLang<T extends Record<string, string>>(
+  dictionary: T,
+  lang: keyof T
+): string | undefined {
+  return dictionary[lang];
+}

package/utils/navigation.ts

@@ -1,8 +1,9 @@
 import { basename, dirname } from 'node:path';
 import config from 'virtual:starlight/user-config';
 import { withBase } from './base';
+import { pickLang } from './i18n';
 import { Route, getLocaleRoutes, routes } from './routing';
-import { slugToPathname } from './slugs';
+import { localeToLang, slugToPathname } from './slugs';
 import type {
   AutoSidebarGroup,
   SidebarItem,
@@ -48,7 +49,7 @@ function configItemToEntry(
   } else {
     return {
       type: 'group',
-      label: item.label,
+      label: pickLang(item.translations, localeToLang(locale)) || item.label,
       entries: item.items.map((i) =>
         configItemToEntry(i, currentPathname, locale, routes)
       ),
@@ -75,7 +76,7 @@ function groupFromAutogenerateConfig(
   const tree = treeify(dirDocs, localeDir);
   return {
     type: 'group',
-    label: item.label,
+    label: pickLang(item.translations, localeToLang(locale)) || item.label,
     entries: sidebarFromDir(tree, currentPathname, locale),
   };
 }
@@ -102,7 +103,8 @@ function linkFromConfig(
     // Inject current locale into link.
     if (locale) href = '/' + locale + href;
   }
-  return makeLink(href, item.label, currentPathname);
+  const label = pickLang(item.translations, localeToLang(locale)) || item.label;
+  return makeLink(href, label, currentPathname);
 }
 
 /** Create a link entry. */

package/utils/user-config.ts

@@ -27,17 +27,20 @@ const LocaleSchema = z.object({
     ),
 });
 
-const SidebarLinkItemSchema = z.object({
+const SidebarBaseSchema = z.object({
   /** The visible label for this item in the sidebar. */
   label: z.string(),
+  /** Translations of the `label` for each supported language. */
+  translations: z.record(z.string()).default({}),
+});
+
+const SidebarLinkItemSchema = SidebarBaseSchema.extend({
   /** The link to this item’s content. Can be a relative link to local files or the full URL of an external page. */
   link: z.string(),
 });
 export type SidebarLinkItem = z.infer<typeof SidebarLinkItemSchema>;
 
-const AutoSidebarGroupSchema = z.object({
-  /** The visible label for this item in the sidebar. */
-  label: z.string(),
+const AutoSidebarGroupSchema = SidebarBaseSchema.extend({
   /** Enable autogenerating a sidebar category from a specific docs directory. */
   autogenerate: z.object({
     /** The directory to generate sidebar items for. */
@@ -49,20 +52,29 @@ const AutoSidebarGroupSchema = z.object({
 });
 export type AutoSidebarGroup = z.infer<typeof AutoSidebarGroupSchema>;
 
-type ManualSidebarGroup = {
-  /** The visible label for this item in the sidebar. */
-  label: string;
+type ManualSidebarGroupInput = z.input<typeof SidebarBaseSchema> & {
   /** Array of links and subcategories to display in this category. */
   items: Array<
-    | SidebarLinkItem
-    | z.infer<typeof AutoSidebarGroupSchema>
-    | ManualSidebarGroup
+    | z.input<typeof SidebarLinkItemSchema>
+    | z.input<typeof AutoSidebarGroupSchema>
+    | ManualSidebarGroupInput
   >;
 };
 
-const ManualSidebarGroupSchema: z.ZodType<ManualSidebarGroup> = z.object({
-  /** The visible label for this item in the sidebar. */
-  label: z.string(),
+type ManualSidebarGroupOutput = z.output<typeof SidebarBaseSchema> & {
+  /** Array of links and subcategories to display in this category. */
+  items: Array<
+    | z.output<typeof SidebarLinkItemSchema>
+    | z.output<typeof AutoSidebarGroupSchema>
+    | ManualSidebarGroupOutput
+  >;
+};
+
+const ManualSidebarGroupSchema: z.ZodType<
+  ManualSidebarGroupOutput,
+  z.ZodTypeDef,
+  ManualSidebarGroupInput
+> = SidebarBaseSchema.extend({
   /** Array of links and subcategories to display in this category. */
   items: z.lazy(() =>
     z
@@ -83,7 +95,11 @@ const SidebarItemSchema = z.union([
 export type SidebarItem = z.infer<typeof SidebarItemSchema>;
 
 const SidebarGroupSchema: z.ZodType<
-  ManualSidebarGroup | z.infer<typeof AutoSidebarGroupSchema>
+  | z.output<typeof ManualSidebarGroupSchema>
+  | z.output<typeof AutoSidebarGroupSchema>,
+  z.ZodTypeDef,
+  | z.input<typeof ManualSidebarGroupSchema>
+  | z.input<typeof AutoSidebarGroupSchema>
 > = z.union([ManualSidebarGroupSchema, AutoSidebarGroupSchema]);
 
 const UserConfigSchema = z.object({