@lexibase/rdx-types 1.0.0 → 1.1.1

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.
Files changed (2) hide show
  1. package/dist/config.d.ts +15 -7
  2. package/package.json +1 -1
package/dist/config.d.ts CHANGED
@@ -34,8 +34,9 @@ export type RDXConfig = {
34
34
  */
35
35
  description?: string
36
36
  /**
37
- * HTML document language, such as 'en' or 'pt-BR'.
38
- * This does not automatically translate the interface or documentation.
37
+ * HTML document language and built-in interface translations, such as 'en' or 'pt-BR'.
38
+ * Portuguese locales use Brazilian Portuguese labels; unsupported languages use English.
39
+ * Document content and author-provided labels remain as written.
39
40
  * @defaultValue 'en'
40
41
  */
41
42
  lang?: string
@@ -120,7 +121,7 @@ export type RdxHomepage = {
120
121
  }
121
122
 
122
123
  /**
123
- * Portable subset of Next.js metadata, translated by the RDX runtime.
124
+ * Site identity and portable Next.js metadata, translated by the RDX runtime.
124
125
  * Root-relative asset URLs refer to files the project owns in public/.
125
126
  * No asset files, deployment domain or global canonical URL are created here.
126
127
  */
@@ -137,6 +138,13 @@ export type RdxMetadata = {
137
138
  * footer, accessible logo name and built-in homepage fallback.
138
139
  */
139
140
  applicationName: string
141
+ /**
142
+ * Starting year shown in the footer. The CLI fills the project creation year;
143
+ * replace it with an earlier founding year when appropriate. Must be a positive
144
+ * integer no later than the current year. Omit to show only the current year.
145
+ * Equal years are displayed once, e.g. 2026; earlier years form a range.
146
+ */
147
+ since?: number
140
148
  /** Optional people or organizations credited in the document's metadata. */
141
149
  authors?: {
142
150
  /** Author or organization name; independent of the site's applicationName. */
@@ -188,9 +196,9 @@ export type RdxMetadata = {
188
196
  }
189
197
  /** Optional Open Graph link previews. No fixed URL is applied to every page. */
190
198
  openGraph?: {
191
- /** Preview title override; defaults to metadata.applicationName. */
199
+ /** Site preview title; defaults to applicationName. Docs pages use their page title. */
192
200
  title?: string
193
- /** Preview description override; defaults to the root description. */
201
+ /** Site preview description; docs use their page description or the root description. */
194
202
  description?: string
195
203
  /** Optional site name shown by platforms that support it. */
196
204
  siteName?: string
@@ -214,9 +222,9 @@ export type RdxMetadata = {
214
222
  twitter?: {
215
223
  /** Text-oriented summary or a large-image preview card. */
216
224
  card?: 'summary' | 'summary_large_image'
217
- /** Card title override; defaults to metadata.applicationName. */
225
+ /** Site card title; defaults to applicationName. Docs pages use their page title. */
218
226
  title?: string
219
- /** Card description override; defaults to the root description. */
227
+ /** Site card description; docs use their page description or the root description. */
220
228
  description?: string
221
229
  /** Account associated with the site, usually '@account'. */
222
230
  site?: string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lexibase/rdx-types",
3
- "version": "1.0.0",
3
+ "version": "1.1.1",
4
4
  "license": "MIT",
5
5
  "description": "Shared TypeScript types for RDX documentation projects.",
6
6
  "types": "./dist/index.d.ts",