@umami/shiso 1.16.0 → 1.18.0

package/src/lib/types.ts

@@ -1,3 +1,7 @@
+import type { ThemeLabels, Translations } from '../../types/labels';
+
+export type { ThemeLabels, Translations } from '../../types/labels';
+
 import type { PluggableList } from 'unified';
 
 /* ---------------------------------------------------------------------------
@@ -134,8 +138,10 @@ export interface ShisoConfig {
   contentDir?: string;
   /** Absolute site origin, required for canonical and og:url tags. */
   siteUrl?: string;
-  /** Locale used for deterministic date formatting. */
+  /** Default locale for UI labels and date formatting. */
   locale?: string;
+  /** Partial UI label overrides keyed by BCP 47 locale. */
+  translations?: Translations;
   /** Build-time remark and rehype plugins. */
   mdx?: MdxConfig;
 }
@@ -146,6 +152,7 @@ export interface ResolvedShisoConfig {
   contentDir: string;
   siteUrl?: string;
   locale: string;
+  translations?: Translations;
   /** Build-only compiler hooks. Removed from the virtual browser module. */
   mdx?: MdxConfig;
 }
@@ -211,6 +218,11 @@ export interface StandalonePageItem {
   page: string;
   /** Page title used in the document head. Frontmatter title wins. */
   title?: string;
+  /**
+   * Navigation language this page belongs to, e.g. "ja". Sets the document
+   * language, header navigation, and language selector for the page.
+   */
+  language?: string;
 }
 
 /** Normalized standalone page. */
@@ -221,6 +233,13 @@ export interface StandalonePage {
   filePath: string;
   /** Config-level head-title override. */
   title?: string;
+  /** Navigation language the page belongs to; untagged pages use the default language. */
+  language?: string;
+  /**
+   * Language-independent identity: the file slug without its language folder,
+   * so "ja/home" (language "ja") and "home" are the same page in two languages.
+   */
+  key: string;
 }
 
 export interface SeoConfig {
@@ -242,6 +261,22 @@ export interface ErrorsConfig {
   '404'?: Error404Config;
 }
 
+export interface EditLinkConfig {
+  /** HTTP(S) URL template. $file is the encoded source path relative to the project root. */
+  url: string;
+  label?: string;
+}
+
+export interface FeedbackConfig {
+  /** HTTP(S) or site-relative endpoint accepting a JSON POST. */
+  endpoint: string;
+  prompt?: string;
+  helpfulLabel?: string;
+  unhelpfulLabel?: string;
+  successMessage?: string;
+  errorMessage?: string;
+}
+
 export interface MetadataConfig {
   /** Show the last-modified date on all pages. Overridable per page via `timestamp` frontmatter. */
   timestamp?: boolean;
@@ -372,6 +407,8 @@ export interface DocsConfig {
   seo?: SeoConfig;
   errors?: ErrorsConfig;
   metadata?: MetadataConfig;
+  editLink?: false | EditLinkConfig;
+  feedback?: false | FeedbackConfig;
   appearance?: AppearanceConfig;
   styling?: StylingConfig;
   fonts?: FontsConfig;
@@ -532,37 +569,6 @@ export interface NormalizedFooter {
   attribution: boolean;
 }
 
-export interface ThemeLabels {
-  menu: string;
-  documentationNavigation: string;
-  sections: string;
-  tableOfContents: string;
-  tableOfContentsNavigation: string;
-  searchTitle: string;
-  searching: string;
-  searchUnavailable: string;
-  noResults: string;
-  lastUpdated: string;
-  relatedTopics: string;
-  previousPage: string;
-  nextPage: string;
-  notFound: string;
-  dismissBanner: string;
-  toggleTheme: string;
-  moreOptions: string;
-  copied: string;
-  expand: string;
-  collapse: string;
-  copyPage: string;
-  copyPageDescription: string;
-  viewMarkdown: string;
-  viewMarkdownDescription: string;
-  openInChatGPT: string;
-  openInClaude: string;
-  openInPerplexity: string;
-  askQuestionsAboutPage: string;
-}
-
 export interface SiteModel {
   name?: string;
   logo: {
@@ -584,6 +590,8 @@ export interface SiteModel {
   contextualOptions: ContextualOption[];
   error404: Required<Pick<Error404Config, 'redirect'>> & Error404Config;
   showTimestamp: boolean;
+  editLink?: EditLinkConfig | null;
+  feedback?: FeedbackConfig | null;
   drilldown?: boolean;
   locale: string;
   labels: ThemeLabels;
@@ -614,6 +622,10 @@ export interface TocEntry {
 export type RelatedEntry = string | { href: string; title?: string };
 
 export interface DocFrontmatter {
+  /** Override the edit URL, or hide the edit link on this page. */
+  editLink?: string | false;
+  /** Hide the feedback controls on this page. */
+  feedback?: false;
   title?: string;
   description?: string;
   noindex?: boolean;

package/src/styles/global.css

@@ -183,7 +183,7 @@
     border-radius: var(--radius-sm);
     background: color-mix(in srgb, currentColor 4%, transparent);
     padding: 0.1rem 0.3rem;
-    font-size: 0.875rem;
+    font-size: 0.875em;
   }
 
   /* Shared by GFM tables and the PropertiesTable component: rounded outer border,

package/types/config.d.ts

@@ -1,3 +1,7 @@
+import type { Translations } from './labels';
+
+export type { ThemeLabels, Translations } from './labels';
+
 import type { PluggableList } from 'unified';
 
 /** Build-time Markdown and MDX compiler extensions. */
@@ -16,8 +20,10 @@ export interface ShisoConfig {
   contentDir?: string;
   /** Absolute site origin (e.g. "https://docs.example.com") used for canonical URLs, og:url, and the sitemap. */
   siteUrl?: string;
-  /** Locale used for deterministic date formatting. Default "en-US". */
+  /** Default locale for UI labels and date formatting. Default "en-US". */
   locale?: string;
+  /** Partial UI label overrides keyed by BCP 47 locale. */
+  translations?: Translations;
   /** Build-time remark and rehype plugins for Markdown and MDX content. */
   mdx?: MdxConfig;
 }

package/types/labels.d.ts

@@ -0,0 +1,76 @@
+export interface ThemeLabels {
+  menu: string;
+  documentationNavigation: string;
+  sections: string;
+  tableOfContents: string;
+  tableOfContentsNavigation: string;
+  searchTitle: string;
+  searching: string;
+  searchUnavailable: string;
+  noResults: string;
+  lastUpdated: string;
+  relatedTopics: string;
+  previousPage: string;
+  nextPage: string;
+  notFound: string;
+  dismissBanner: string;
+  toggleTheme: string;
+  moreOptions: string;
+  copied: string;
+  expand: string;
+  collapse: string;
+  copyPage: string;
+  copyPageDescription: string;
+  viewMarkdown: string;
+  viewMarkdownDescription: string;
+  openInChatGPT: string;
+  openInClaude: string;
+  openInPerplexity: string;
+  askQuestionsAboutPage: string;
+  searchPlaceholder: string;
+  poweredBy: string;
+  copyCode: string;
+  editPage: string;
+  feedbackPrompt: string;
+  feedbackYes: string;
+  feedbackNo: string;
+  feedbackSuccess: string;
+  feedbackError: string;
+  close: string;
+  filterUpdates: string;
+  clear: string;
+  noUpdates: string;
+  codeSnippets: string;
+  contentTabs: string;
+  fileTree: string;
+  diagram: string;
+  diagramError: string;
+  zoomOut: string;
+  resetView: string;
+  zoomIn: string;
+  viewImage: string;
+  viewNamedImage: string;
+  fullSizeImage: string;
+  diagramSource: string;
+  fieldName: string;
+  fieldType: string;
+  fieldDescription: string;
+  fieldRequired: string;
+  fieldDeprecated: string;
+  fieldDefault: string;
+  fieldOptions: string;
+  allowedTypes: string;
+  properties: string;
+  apiHeaders: string;
+  apiPathParameters: string;
+  apiQueryParameters: string;
+  apiCookieParameters: string;
+  apiRequestBody: string;
+  apiResponses: string;
+  apiCodeSamples: string;
+  apiExampleRequest: string;
+  apiExampleResponse: string;
+  apiCredentials: string;
+}
+
+export type Translations = Record<string, Partial<ThemeLabels>>;