@lexibase/rdx-types 2.1.0 → 2.3.0

package/README.md

@@ -1,3 +1,3 @@
-# `@rdx/types`
+# `@lexibase/rdx-types`
 
 Common types for RDX packages.

package/dist/config.d.ts

@@ -27,6 +27,13 @@ export type RDXConfig = {
    * @defaultValue false
    */
   TOC?: boolean
+  /** Link live documentation pages to their source editor. Omit or set false to hide the link. */
+  editPage?:
+    | false
+    | {
+        /** Absolute HTTP(S) edit URL up to the RDX project root, including the branch and any monorepo subdirectory. */
+        baseUrl: string
+      }
   /**
    * Default HTML and social-preview description of the project.
    * This does not replace descriptions authored in documents or the homepage.
@@ -68,12 +75,16 @@ export type RDXConfig = {
      */
     title?: string
     /**
-     * Imported React component accepting an optional className for styling.
-     * Pass the component itself, not JSX or an image path. Defaults to the RDX logo.
+     * Image URL from public/, e.g. '/images/logo.png' or '/images/logo.svg',
+     * or an imported React component accepting className. Pass the component
+     * itself rather than JSX. Defaults to the RDX logo.
+     * Images retain their proportions and original colors in both themes.
+     * @example
+     * logo: '/images/logo.png'
      * @example
      * logo: MyLogo
      */
-    logo?: ComponentType<{ className?: string }>
+    logo?: string | ComponentType<{ className?: string }>
     /** Optional GitHub link and theme toggle. Omitted actions remain hidden. */
     actions?: {
       /** Show the system/light/dark theme switcher in the navbar. */

package/dist/content.d.ts

@@ -1,6 +1,13 @@
+export type RdxPageHighlight = 'important' | 'new'
+
 export type RdxDocFrontmatter = {
   title?: string
   description?: string
+  order?: number
+  navTitle?: string
+  /** Show a semantic highlight next to the page in the sidebar. */
+  highlighting?: RdxPageHighlight
+  /** @deprecated Use order. */
   link_position?: number
   [key: string]: unknown
 }
@@ -8,6 +15,8 @@ export type RdxDocFrontmatter = {
 export type RdxDocPage = {
   slug: string
   title: string
+  navTitle?: string
+  highlighting?: RdxPageHighlight
   description: string
   position: number
   sourcePath: string

package/dist/index.d.ts

@@ -25,6 +25,7 @@ export {
   RdxDocCategory,
   RdxDocFrontmatter,
   RdxDocPage,
+  RdxPageHighlight,
   RdxDocument,
   RdxDocsOptions,
 } from './content'

package/package.json

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