You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(docs): escape MDX JSX openers in generated reference tables (#40)
gen:reference emitted description prose like `currency:<CODE>` verbatim into
table cells; MDX parsed `<CODE>` as an unclosed JSX tag and failed the build.
cell() now escapes `<` and `{` alongside the pipe, matching the header
contract. Regenerated manifest.mdx (also picks up stale schema sync).
@@ -119,7 +117,6 @@ range; without it the page opens to all-time.
119
117
|`type`|`string`| yes | The filter kind: `daterange` or `select`. |
120
118
|`label`|`string`| no | Label shown on the control. |
121
119
|`bind`|`object`| yes | A map of dataset name to the column the filter applies to. Each column is validated against the live data. |
122
-
|`default`|`string`| no |`daterange` only: initial period when the URL sets no range, resolved live against today. One of `today`, `last-7-days`, `last-30-days`, `last-90-days`, `this-month`, `last-month`. Omitted means all-time. |
123
120
|`multiple`|`boolean`| no |`select` only: allow several values (`IN`); default single (`=`). |
124
121
|`options`|`array of string`| no |`select` only: explicit choices; when omitted, the bound column's live distinct values are used. |
125
122
@@ -190,7 +187,6 @@ points at.
190
187
|`groupBy`|`array of string`| no | Columns to group by, for aggregate `select` entries. |
191
188
|`orderBy`|`array of object`| no | Sort keys, each `{ field, dir? }` where `dir` is `asc` / `desc` (default `asc`). |
192
189
|`limit`|`number`| no | Max rows returned. |
193
-
|`search`|`object`| no | Make the query a relevance-ranked full-text search over text columns (see query search). |
194
190
|`params`|`object`| no | A map of parameter name to a parameter declaration (see query params). |
195
191
|`description`|`string`| no | Free-form note describing the query. |
196
192
@@ -213,19 +209,6 @@ declared param) or `value` (a literal). The ops are `eq`, `ne`, `lt`, `lte`, `gt
213
209
date), and `in` (a literal `value` array). A filter bound to an **optional** param the
214
210
caller omits is dropped, so the query runs without it.
215
211
216
-
A **query search** (`search`) turns the query into a relevance-ranked full-text (BM25)
217
-
search over text columns, distinct from a `contains` filter's unranked substring match.
218
-
It requires a `source` dataset (not a `sql` transform). An omitted `orderBy` ranks by
219
-
relevance; an explicit `orderBy` overrides it.
220
-
221
-
| Field | Type | Required | Description |
222
-
| --- | --- | --- | --- |
223
-
|`fields`|`array of string`| yes | Text columns to index and search across; each must be a real column of the dataset. |
224
-
|`param`|`string`| yes | Name of a declared `string` param holding the search term. |
|`stopwords`|`"english" \| "none"`| no | Drop common words from the index and term. `english` (default) drops them; `none` keeps them. |
227
-
|`scoreField`|`string`| no | Name a column to expose the BM25 score under; omit to keep the score internal. |
228
-
229
212
## Connectors
230
213
231
214
A **connector** is a vendored integration that syncs a provider's data into `source`
@@ -287,7 +270,7 @@ A single headline number, optionally with a delta vs the previous row or a targe
287
270
|`compareTo`|`string`| no | 'prev', 'none', or a field name |
288
271
|`target`|`string`| no | field holding a target to compare against |
289
272
|`unit`|`string`| no ||
290
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
273
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
291
274
|`color`|`string`| no | 6-digit hex color (e.g. "#22C55E") for the sparkline, overriding the default palette |
292
275
293
276
### `metric.scorecard`
@@ -359,7 +342,7 @@ A dual-axis chart: bars on the primary axis, lines on a secondary axis — use t
359
342
|`stacked`|`boolean`| no | stack the bar series into one bar per category |
360
343
|`colors`|`array of string`| no | CSS colors per series (bars first, then lines), overriding the default palette |
361
344
|`format`|[`value format`](/reference/value-formats)| no | format for the primary (bar) y-axis |
362
-
|`lineFormat`|`"usd" \| "eur" \| "gbp" \| "jpy" \| "int" \| "decimal" \| "pct" \| "compact" \| "kg" \| "bytes" \| "duration" \| "date" \| "datetime" \| "time" \| "month"`| no | format for the secondary (line) y-axis |
345
+
|`lineFormat`|`"usd" \| "eur" \| "gbp" \| "jpy" \| "int" \| "decimal" \| "pct" \| "compact" \| "kg" \| "bytes" \| "duration" \| "date" \| "datetime" \| "time" \| "month" \| string`| no | format for the secondary (line) y-axis |
363
346
364
347
### `waterfall.bars`
365
348
@@ -377,7 +360,7 @@ A waterfall / bridge chart — use for a P&L walk or variance: an opening anchor
377
360
|`value`|`string`| yes | signed delta per step; for a total/anchor row, its absolute level |
378
361
|`kind`|`string`| no | field marking anchor rows: a row whose value here is "total" draws as an absolute bar from zero (opening/closing/subtotal). Omit to make every row a delta. |
379
362
|`colors`|`object`| no | CSS colors per tone, overriding the defaults (increase green, decrease red, total neutral) |
380
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
363
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
381
364
382
365
### `breakdown.treemap`
383
366
@@ -412,7 +395,7 @@ A matrix heatmap — use to show one value across two categorical dimensions (x
412
395
|`y`|`string`| yes | row-category field (y axis) |
413
396
|`value`|`string`| yes | numeric field mapped to each cell's color |
414
397
|`colors`|`array of string`| no | gradient color stops for the scale, overriding the default |
415
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
398
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
416
399
417
400
### `activity.calendar`
418
401
@@ -429,7 +412,7 @@ A calendar heatmap — use to show a daily value over weeks and months, GitHub-c
429
412
|`date`|`string`| yes | date field — any parseable date or timestamp |
430
413
|`value`|`string`| yes | numeric field mapped to the day's color intensity |
431
414
|`colors`|`array of string`| no | gradient color stops, overriding the default |
432
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
415
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
433
416
434
417
### `funnel.steps`
435
418
@@ -447,7 +430,7 @@ A funnel of sequential stages — use for conversion or drop-off; each stage's w
447
430
|`value`|`string`| yes | numeric field — the count at each stage |
448
431
|`sort`|`"none" \| "ascending" \| "descending"`| no | funnel ordering; 'none' keeps the declared row order |
449
432
|`colors`|`array of string`| no | CSS colors per stage, overriding the default palette |
450
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
433
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
451
434
452
435
### `rank.list`
453
436
@@ -467,7 +450,7 @@ A ranked Top-N list with proportional bars — use for leaderboards: top product
467
450
|`sort`|`"descending" \| "ascending"`| no | rank order by value |
468
451
|`secondary`|`string`| no | optional field shown beside each row's value |
469
452
|`color`|`string`| no | CSS color for the bars, overriding the default accent |
470
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
453
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
471
454
472
455
### `compare.radar`
473
456
@@ -485,7 +468,7 @@ A radar (spider) chart — use to compare entities across several metrics at onc
485
468
|`series`|`string`| no | field naming each polygon (one per row); omitted numbers them Series 1, 2, … |
486
469
|`max`|`number`| no | fixed max for every axis; omitted maxes each axis at its metric's peak |
487
470
|`colors`|`array of string`| no | CSS colors per polygon, overriding the default palette |
488
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
471
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
489
472
490
473
### `map.choropleth`
491
474
@@ -503,7 +486,7 @@ A geographic choropleth — use to shade regions (world countries) by a value; r
503
486
|`value`|`string`| yes | numeric field mapped to each region's color |
504
487
|`map`|`string`| no | the registered map name |
505
488
|`colors`|`array of string`| no | gradient color stops, overriding the default |
506
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
489
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
507
490
508
491
### `correlation.scatter`
509
492
@@ -542,7 +525,7 @@ A pie or donut chart of part-to-whole composition — use for one series' share
542
525
|`value`|`string`| yes | numeric field sizing each slice |
543
526
|`donut`|`boolean`| no | render with an inner radius (a donut hole) |
544
527
|`colors`|`array of string`| no | CSS colors per slice (in descending-value order), overriding the default palette |
545
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
528
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
546
529
547
530
### `table.grid`
548
531
@@ -645,7 +628,7 @@ A responsive grid of state tiles — use for service/check health on ops & statu
645
628
|`label`|`string`| yes | field naming each entity (service, check, host) |
646
629
|`state`|`string`| yes | field holding each entity's status value |
647
630
|`value`|`string`| no | optional metric shown under the label |
648
-
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. See the Value formats reference (/reference/value-formats). |
631
+
|`format`|[`value format`](/reference/value-formats)| no | Display format for a value. Currency: usd, eur, gbp, jpy. Number: int, decimal, pct (a 0–1 fraction shown as a %), compact (1.2K). Unit: kg, bytes (1024-scale), duration (a number of seconds → 1h 5m). Date/time: date, datetime, time, month. Omit for a plain number with up to 2 decimals. For any other ISO 4217 currency use 'currency:\<CODE>' (e.g. currency:RSD). See the Value formats reference (/reference/value-formats). |
649
632
|`tones`|`object`| no | map a state value to a tone; unmapped values fall back to a keyword convention (up/ok/healthy/online → success, warn/degraded/pending → warning, down/error/critical/fail → danger, else neutral) |
650
633
651
634
### `search.box`
@@ -717,7 +700,7 @@ A full-page content workspace — browse and edit a directory of markdown files
717
700
718
701
### `form.entry`
719
702
720
-
A data-entry form card bound to a manifest `action` — renders one typed input per action field, with a submit button in the bottom-right that inserts a row; the bound dataset's islands then refresh live. The human-facing mirror of the agent's run_action: it reuses the action's typing and so binds no dataset of its own.
703
+
A data-entry form card bound to a manifest `action` — renders one typed input per action field, with a submit button in the bottom-right that inserts a row; the bound dataset's islands then refresh live. The human-facing mirror of the agent's runActions insert: it reuses the action's typing and so binds no dataset of its own.
721
704
722
705
**Span:** min 3, recommended 5, max 8 (of 12). Omit `span` to render at the recommended width; below min or above max is a named error.
0 commit comments