@lexibase/rdx-types 2.3.0 → 2.5.0

package/dist/config.d.ts

@@ -21,6 +21,18 @@ export type RDXConfig = {
    * @defaultValue false
    */
   search?: boolean
+  /** Syntax highlighting for Markdown code blocks. */
+  syntaxHighlighting?: {
+    /** Project-relative TextMate JSON files keyed by the fence language. */
+    languages?: Record<string, string>
+    /** Bundled Shiki theme names for each site appearance. */
+    themes?: {
+      /** @defaultValue 'github-light' */
+      light?: string
+      /** @defaultValue 'github-dark' */
+      dark?: string
+    }
+  }
   /**
    * Enable floating heading navigation on documentation pages.
    * Hidden when a page has too few sections to navigate.
@@ -103,6 +115,14 @@ export type RDXConfig = {
   }
 }
 
+/** Values available to a project-owned homepage. */
+export type RdxHomepageProps = {
+  /** Active language tag, such as 'en' or 'pt-BR'. */
+  lang: string
+  /** Documentation entry point for the active language. */
+  docsHref: string
+}
+
 /** Options for the built-in landing page or a project-owned home.tsx component. */
 export type RdxHomepage = {
   /**
@@ -112,17 +132,17 @@ export type RdxHomepage = {
   enabled?: boolean
   /**
    * Imported React component that owns the homepage body.
-   * The shared navbar remains; built-in title, description and buttons are not
-   * injected into this component. Used only when enabled is true.
+   * The shared navbar remains. Use the lang and docsHref props to localize the
+   * homepage content and navigation. Used only when enabled is true.
    * @example
    * component: Home // import Home from './home'
    */
-  component?: ComponentType
+  component?: ComponentType<RdxHomepageProps>
   /** Built-in homepage heading. Defaults to metadata.applicationName. */
   title?: string
-  /** Optional text below the built-in heading; omitted means no description. */
+  /** Text below the built-in heading. Defaults to the site description. */
   description?: string
-  /** Buttons below the built-in description. The first button is primary. */
+  /** Hero buttons. The first is primary. Defaults to a Docs link; use [] to hide it. */
   buttons?: {
     /** Visible button text and accessible name; must not be empty. */
     label: string

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export { RdxSearchEntry, RdxSearchIndex } from './search'
 export {
   RDXConfig,
   RdxHomepage,
+  RdxHomepageProps,
   RdxMetadata,
   RdxRuntimeConfig,
   ResolvedRdxConfig,

package/dist/plugins.d.ts

@@ -93,8 +93,10 @@ export type RdxProject = {
   config: ResolvedRdxConfig
   sources: RdxContentSource[]
   commands: RdxPluginCommand[]
-  /** Project-relative files plugins need when serving deployed documentation. */
+  /** Project-relative files needed when serving deployed documentation. */
   runtimeFiles: string[]
+  /** Parsed project-owned TextMate grammars, registered under their fence names. */
+  syntaxGrammars?: { name: string; scopeName: string; patterns: unknown[] }[]
   localization?: RdxLocalization
   /** Selected locale on a request-scoped view, never a global mutable setting. */
   locale?: RdxLocale

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-types",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "license": "MIT",
   "description": "Shared TypeScript types for RDX documentation projects.",
   "types": "./dist/index.d.ts",