@lexibase/rdx-types 2.2.0 → 2.4.0

package/README.md

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

package/dist/config.d.ts

@@ -21,12 +21,31 @@ 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.
    * @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.

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/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.2.0",
+  "version": "2.4.0",
   "license": "MIT",
   "description": "Shared TypeScript types for RDX documentation projects.",
   "types": "./dist/index.d.ts",