@lexibase/rdx-types 1.0.0-beta.3 → 1.0.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/config.d.ts +13 -1
- package/dist/index.d.ts +1 -0
- package/dist/search.d.ts +13 -0
- package/package.json +3 -3
package/dist/config.d.ts
CHANGED
|
@@ -3,6 +3,8 @@ import type { RdxPlugin } from './plugins'
|
|
|
3
3
|
|
|
4
4
|
/** @deprecated Legacy development website config. New projects use RdxConfig. */
|
|
5
5
|
export type RDXConfig = {
|
|
6
|
+
search?: boolean
|
|
7
|
+
TOC?: boolean
|
|
6
8
|
/**
|
|
7
9
|
* The title of the documentation site.
|
|
8
10
|
* Displayed in the navbar and browser tab.
|
|
@@ -108,12 +110,18 @@ export type RDXConfig = {
|
|
|
108
110
|
/** Public configuration shared by the CLI, runtime, and plugins. */
|
|
109
111
|
export type RdxHomepage = {
|
|
110
112
|
enabled?: boolean
|
|
113
|
+
/** Custom project-owned homepage, e.g. import Home from './home'. */
|
|
114
|
+
component?: ComponentType
|
|
111
115
|
title?: string
|
|
112
116
|
description?: string
|
|
113
117
|
buttons?: { label: string; href: string }[]
|
|
114
118
|
}
|
|
115
119
|
|
|
116
120
|
export type RdxConfig = {
|
|
121
|
+
/** Local documentation search. Defaults to false. */
|
|
122
|
+
search?: boolean
|
|
123
|
+
/** Floating table of contents for documentation pages. Defaults to false. */
|
|
124
|
+
TOC?: boolean
|
|
117
125
|
title: string
|
|
118
126
|
description?: string
|
|
119
127
|
lang?: string
|
|
@@ -125,7 +133,9 @@ export type RdxConfig = {
|
|
|
125
133
|
}
|
|
126
134
|
navbar?: {
|
|
127
135
|
title?: string
|
|
136
|
+
logo?: ComponentType<{ className?: string }>
|
|
128
137
|
actions?: {
|
|
138
|
+
showToggleMode?: boolean
|
|
129
139
|
github?: {
|
|
130
140
|
visible: boolean
|
|
131
141
|
url: string
|
|
@@ -139,8 +149,10 @@ export type RdxRuntimeConfig = RdxConfig
|
|
|
139
149
|
|
|
140
150
|
export type ResolvedRdxConfig = Omit<
|
|
141
151
|
RdxConfig,
|
|
142
|
-
'description' | 'lang' | 'docsDir' | 'theme' | 'plugins'
|
|
152
|
+
'description' | 'lang' | 'docsDir' | 'theme' | 'plugins' | 'TOC' | 'search'
|
|
143
153
|
> & {
|
|
154
|
+
search: boolean
|
|
155
|
+
TOC: boolean
|
|
144
156
|
description: string
|
|
145
157
|
lang: string
|
|
146
158
|
docsDir: string
|
package/dist/index.d.ts
CHANGED
package/dist/search.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/** Public text only: never serialize filesystem paths or raw MDX. */
|
|
2
|
+
export interface RdxSearchEntry {
|
|
3
|
+
href: string
|
|
4
|
+
title: string
|
|
5
|
+
category: string
|
|
6
|
+
section: string
|
|
7
|
+
text: string
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export interface RdxSearchIndex {
|
|
11
|
+
schemaVersion: 1
|
|
12
|
+
entries: RdxSearchEntry[]
|
|
13
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lexibase/rdx-types",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.5",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Shared TypeScript types for RDX documentation projects.",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -26,10 +26,10 @@
|
|
|
26
26
|
},
|
|
27
27
|
"homepage": "https://github.com/lexibase/rdx#readme",
|
|
28
28
|
"peerDependencies": {
|
|
29
|
-
"react": "^19.1
|
|
29
|
+
"react": "^19.3.1"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@types/react": "19.
|
|
32
|
+
"@types/react": "19.3.0",
|
|
33
33
|
"@rdx/typescript-config": "1.0.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|