@thedatagrid/docs-kit 0.0.0-stage → 0.1.0

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 (175) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +123 -2
  3. package/dist/code/demoFiles.d.ts +14 -0
  4. package/dist/code/demoFiles.d.ts.map +1 -0
  5. package/dist/code/demoFiles.js +46 -0
  6. package/dist/code/demoFiles.js.map +1 -0
  7. package/dist/code/heights.d.ts +17 -0
  8. package/dist/code/heights.d.ts.map +1 -0
  9. package/dist/code/heights.js +40 -0
  10. package/dist/code/heights.js.map +1 -0
  11. package/dist/code/highlightSpec.d.ts +34 -0
  12. package/dist/code/highlightSpec.d.ts.map +1 -0
  13. package/dist/code/highlightSpec.js +119 -0
  14. package/dist/code/highlightSpec.js.map +1 -0
  15. package/dist/code/imports.d.ts +5 -0
  16. package/dist/code/imports.d.ts.map +1 -0
  17. package/dist/code/imports.js +17 -0
  18. package/dist/code/imports.js.map +1 -0
  19. package/dist/code/index.d.ts +8 -0
  20. package/dist/code/index.d.ts.map +1 -0
  21. package/dist/code/index.js +8 -0
  22. package/dist/code/index.js.map +1 -0
  23. package/dist/code/lineRanges.d.ts +5 -0
  24. package/dist/code/lineRanges.d.ts.map +1 -0
  25. package/dist/code/lineRanges.js +35 -0
  26. package/dist/code/lineRanges.js.map +1 -0
  27. package/dist/code/regions.d.ts +53 -0
  28. package/dist/code/regions.d.ts.map +1 -0
  29. package/dist/code/regions.js +237 -0
  30. package/dist/code/regions.js.map +1 -0
  31. package/dist/code/shiki.d.ts +58 -0
  32. package/dist/code/shiki.d.ts.map +1 -0
  33. package/dist/code/shiki.js +244 -0
  34. package/dist/code/shiki.js.map +1 -0
  35. package/dist/demos/build.d.ts +17 -0
  36. package/dist/demos/build.d.ts.map +1 -0
  37. package/dist/demos/build.js +426 -0
  38. package/dist/demos/build.js.map +1 -0
  39. package/dist/demos/cli.d.ts +3 -0
  40. package/dist/demos/cli.d.ts.map +1 -0
  41. package/dist/demos/cli.js +68 -0
  42. package/dist/demos/cli.js.map +1 -0
  43. package/dist/demos/client.d.ts +27 -0
  44. package/dist/demos/client.d.ts.map +1 -0
  45. package/dist/demos/client.js +61 -0
  46. package/dist/demos/client.js.map +1 -0
  47. package/dist/demos/compile/core.d.ts +64 -0
  48. package/dist/demos/compile/core.d.ts.map +1 -0
  49. package/dist/demos/compile/core.js +174 -0
  50. package/dist/demos/compile/core.js.map +1 -0
  51. package/dist/demos/config.d.ts +108 -0
  52. package/dist/demos/config.d.ts.map +1 -0
  53. package/dist/demos/config.js +4 -0
  54. package/dist/demos/config.js.map +1 -0
  55. package/dist/demos/devEvents.d.ts +13 -0
  56. package/dist/demos/devEvents.d.ts.map +1 -0
  57. package/dist/demos/devEvents.js +45 -0
  58. package/dist/demos/devEvents.js.map +1 -0
  59. package/dist/demos/html.d.ts +21 -0
  60. package/dist/demos/html.d.ts.map +1 -0
  61. package/dist/demos/html.js +57 -0
  62. package/dist/demos/html.js.map +1 -0
  63. package/dist/demos/index.d.ts +8 -0
  64. package/dist/demos/index.d.ts.map +1 -0
  65. package/dist/demos/index.js +6 -0
  66. package/dist/demos/index.js.map +1 -0
  67. package/dist/demos/pages.d.ts +15 -0
  68. package/dist/demos/pages.d.ts.map +1 -0
  69. package/dist/demos/pages.js +71 -0
  70. package/dist/demos/pages.js.map +1 -0
  71. package/dist/demos/runtime/iframe.d.ts +50 -0
  72. package/dist/demos/runtime/iframe.d.ts.map +1 -0
  73. package/dist/demos/runtime/iframe.js +245 -0
  74. package/dist/demos/runtime/iframe.js.map +1 -0
  75. package/dist/demos/runtime/react.d.ts +3 -0
  76. package/dist/demos/runtime/react.d.ts.map +1 -0
  77. package/dist/demos/runtime/react.js +17 -0
  78. package/dist/demos/runtime/react.js.map +1 -0
  79. package/dist/demos/slug.d.ts +3 -0
  80. package/dist/demos/slug.d.ts.map +1 -0
  81. package/dist/demos/slug.js +11 -0
  82. package/dist/demos/slug.js.map +1 -0
  83. package/dist/demos/vendor.d.ts +32 -0
  84. package/dist/demos/vendor.d.ts.map +1 -0
  85. package/dist/demos/vendor.js +127 -0
  86. package/dist/demos/vendor.js.map +1 -0
  87. package/dist/demos/worker/compile.worker.d.ts +2 -0
  88. package/dist/demos/worker/compile.worker.d.ts.map +1 -0
  89. package/dist/demos/worker/compile.worker.js +27 -0
  90. package/dist/demos/worker/compile.worker.js.map +1 -0
  91. package/dist/fork/codesandbox.d.ts +39 -0
  92. package/dist/fork/codesandbox.d.ts.map +1 -0
  93. package/dist/fork/codesandbox.js +156 -0
  94. package/dist/fork/codesandbox.js.map +1 -0
  95. package/dist/fork/index.d.ts +2 -0
  96. package/dist/fork/index.d.ts.map +1 -0
  97. package/dist/fork/index.js +2 -0
  98. package/dist/fork/index.js.map +1 -0
  99. package/dist/react/Demo.d.ts +80 -0
  100. package/dist/react/Demo.d.ts.map +1 -0
  101. package/dist/react/Demo.js +156 -0
  102. package/dist/react/Demo.js.map +1 -0
  103. package/dist/react/DemoIframe.d.ts +22 -0
  104. package/dist/react/DemoIframe.d.ts.map +1 -0
  105. package/dist/react/DemoIframe.js +123 -0
  106. package/dist/react/DemoIframe.js.map +1 -0
  107. package/dist/react/DemoShell.d.ts +47 -0
  108. package/dist/react/DemoShell.d.ts.map +1 -0
  109. package/dist/react/DemoShell.js +341 -0
  110. package/dist/react/DemoShell.js.map +1 -0
  111. package/dist/react/devEvents.d.ts +17 -0
  112. package/dist/react/devEvents.d.ts.map +1 -0
  113. package/dist/react/devEvents.js +30 -0
  114. package/dist/react/devEvents.js.map +1 -0
  115. package/dist/react/editor.d.ts +8 -0
  116. package/dist/react/editor.d.ts.map +1 -0
  117. package/dist/react/editor.js +52 -0
  118. package/dist/react/editor.js.map +1 -0
  119. package/dist/react/fork.d.ts +10 -0
  120. package/dist/react/fork.d.ts.map +1 -0
  121. package/dist/react/fork.js +30 -0
  122. package/dist/react/fork.js.map +1 -0
  123. package/dist/react/index.d.ts +4 -0
  124. package/dist/react/index.d.ts.map +1 -0
  125. package/dist/react/index.js +4 -0
  126. package/dist/react/index.js.map +1 -0
  127. package/dist/react/styles.css +493 -0
  128. package/dist/remark/index.d.ts +3 -0
  129. package/dist/remark/index.d.ts.map +1 -0
  130. package/dist/remark/index.js +3 -0
  131. package/dist/remark/index.js.map +1 -0
  132. package/dist/remark/meta.d.ts +7 -0
  133. package/dist/remark/meta.d.ts.map +1 -0
  134. package/dist/remark/meta.js +20 -0
  135. package/dist/remark/meta.js.map +1 -0
  136. package/dist/remark/remarkDemoFences.d.ts +77 -0
  137. package/dist/remark/remarkDemoFences.d.ts.map +1 -0
  138. package/dist/remark/remarkDemoFences.js +259 -0
  139. package/dist/remark/remarkDemoFences.js.map +1 -0
  140. package/package.json +106 -4
  141. package/src/code/demoFiles.ts +54 -0
  142. package/src/code/heights.ts +47 -0
  143. package/src/code/highlightSpec.ts +139 -0
  144. package/src/code/imports.ts +18 -0
  145. package/src/code/index.ts +46 -0
  146. package/src/code/lineRanges.ts +31 -0
  147. package/src/code/regions.ts +270 -0
  148. package/src/code/shiki.ts +271 -0
  149. package/src/demos/build.ts +477 -0
  150. package/src/demos/cli.ts +64 -0
  151. package/src/demos/client.ts +82 -0
  152. package/src/demos/compile/core.ts +228 -0
  153. package/src/demos/config.ts +106 -0
  154. package/src/demos/devEvents.ts +45 -0
  155. package/src/demos/html.ts +74 -0
  156. package/src/demos/index.ts +25 -0
  157. package/src/demos/pages.ts +79 -0
  158. package/src/demos/runtime/iframe.ts +262 -0
  159. package/src/demos/runtime/react.ts +19 -0
  160. package/src/demos/slug.ts +10 -0
  161. package/src/demos/vendor.ts +142 -0
  162. package/src/demos/worker/compile.worker.ts +35 -0
  163. package/src/fork/codesandbox.ts +189 -0
  164. package/src/fork/index.ts +10 -0
  165. package/src/react/Demo.tsx +250 -0
  166. package/src/react/DemoIframe.tsx +165 -0
  167. package/src/react/DemoShell.tsx +592 -0
  168. package/src/react/devEvents.ts +34 -0
  169. package/src/react/editor.ts +61 -0
  170. package/src/react/fork.ts +31 -0
  171. package/src/react/index.ts +10 -0
  172. package/src/react/styles.css +493 -0
  173. package/src/remark/index.ts +2 -0
  174. package/src/remark/meta.ts +20 -0
  175. package/src/remark/remarkDemoFences.ts +330 -0
@@ -0,0 +1,77 @@
1
+ import { type FenceProps } from './meta.ts';
2
+ export type FenceInfo = {
3
+ lang: string | null;
4
+ meta: string;
5
+ props: FenceProps;
6
+ /** The fence sits inside a `<Demo>` element. */
7
+ inDemo: boolean;
8
+ };
9
+ export type RemarkDemoFencesOptions = {
10
+ /** Absolute path of the content root. */
11
+ contentDir: string;
12
+ /** Content-relative folder of the page being compiled, e.g. `docs/learn/sorting` (slashes are trimmed). */
13
+ folder: string;
14
+ /**
15
+ * Collects the content-relative paths of every source file the page shows
16
+ * (snippets, live demos and their relative imports), for dev reloads.
17
+ */
18
+ dependencies?: Set<string>;
19
+ /**
20
+ * Which fences this plugin owns. Unclaimed fences are left untouched for
21
+ * other plugins (e.g. a legacy pipeline running after this one). Fences
22
+ * inside `<Demo>` are always claimed. Default: every fence.
23
+ */
24
+ claim?: (fence: FenceInfo) => boolean;
25
+ /**
26
+ * `ts`/`tsx`/`js`/`jsx` fences must use `file="..."` so every snippet is
27
+ * type-checked; inline code in those languages throws. Default `true`.
28
+ */
29
+ banInlineCode?: boolean;
30
+ /**
31
+ * How a claimed, non-live, untitled `file=` fence renders:
32
+ * - `shiki-meta` (default): the file's source is inlined into the code node
33
+ * and the highlight/line-number meta is rewritten for `@shikijs/rehype`
34
+ * with `fenceTransformers()` from `/code`;
35
+ * - `card`: a code-only `<Demo>` card (no markdown-level shiki needed).
36
+ */
37
+ staticFences?: 'shiki-meta' | 'card';
38
+ /** File suffixes of live demo entries. Default `['.demo.tsx']`. */
39
+ demoSuffixes?: string[];
40
+ /** MDX component the live/card fences become. Default `Demo`. */
41
+ componentName?: string;
42
+ /** Literal replacements applied to inlined source (see `applySourceReplacements`). */
43
+ sourceReplacements?: Record<string, string>;
44
+ /** `height` of a live fence that doesn't set one. Default `auto` (the card takes the code's height). */
45
+ liveHeight?: string;
46
+ };
47
+ /**
48
+ * Remark plugin for file-based fences.
49
+ *
50
+ * ```tsx file="basic.demo.tsx" live height="large" title="Basic grid"
51
+ * ```
52
+ *
53
+ * - `file="..."` is relative to the page's folder; `file="/docs/x.tsx"` to the
54
+ * content root. A missing file throws at compile time, so a bad reference
55
+ * fails the build.
56
+ * - `live` replaces the fence with `<Demo name="…">` (prebuilt iframe preview
57
+ * + code tabs). The file must be a demo entry (`*.demo.tsx`) inside the
58
+ * content folder. `live=off` shows the code tab first.
59
+ * - `region="name"` shows a `#region name` … `#endregion` slice (dedented).
60
+ * With `live`, the preview runs the whole demo and only the entry's code tab
61
+ * shows the region; editing and forking use full files.
62
+ * - Highlights live in the source as comments, stripped from the shown code:
63
+ * `// #highlight label` … `// #endhighlight`, or a trailing
64
+ * `code // #highlight label` (`{/* #highlight *\/}` in JSX children).
65
+ * `{1-3}` meta highlights are rejected.
66
+ * - `lines` adds a line-number gutter (original line numbers with `region`).
67
+ * - `files=off` hides the file names and tabs of the files the entry imports.
68
+ * - `title="..."` renders a card with the title as the snippet name.
69
+ * - `height="small|default|large|auto|<px>"`; a live fence defaults to
70
+ * `liveHeight` (`auto`).
71
+ *
72
+ * Fences can also live inside `<Demo>`, next to `<DemoTitle>` /
73
+ * `<DemoDescription>`, which render as the card header; the fence's props are
74
+ * hoisted onto the `<Demo>`. A fence without `live` there makes a code-only card.
75
+ */
76
+ export declare function remarkDemoFences(options: RemarkDemoFencesOptions): () => (tree: any) => void;
77
+ //# sourceMappingURL=remarkDemoFences.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"remarkDemoFences.d.ts","sourceRoot":"","sources":["../../src/remark/remarkDemoFences.ts"],"names":[],"mappings":"AASA,OAAO,EAAkB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5D,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,UAAU,CAAC;IAClB,gDAAgD;IAChD,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,2GAA2G;IAC3G,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC3B;;;;OAIG;IACH,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,OAAO,CAAC;IACtC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,MAAM,CAAC;IACrC,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sFAAsF;IACtF,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5C,wGAAwG;IACxG,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAYF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,UAqBjD,MAAM,GAAG,UAoKxB"}
@@ -0,0 +1,259 @@
1
+ import fs from 'node:fs';
2
+ import path from 'node:path';
3
+ import { visit } from 'unist-util-visit';
4
+ import { collectDemoFiles } from "../code/demoFiles.js";
5
+ import { formatHighlightSpec } from "../code/highlightSpec.js";
6
+ import { parseDemoHeight } from "../code/heights.js";
7
+ import { formatLineRanges } from "../code/lineRanges.js";
8
+ import { applySourceReplacements, extractCodeMarkers, sliceRegion, stripCodeMarkers } from "../code/regions.js";
9
+ import { parseFenceMeta } from "./meta.js";
10
+ const TYPECHECKED_LANGS = new Set(['ts', 'tsx', 'js', 'jsx', 'typescript', 'javascript']);
11
+ /**
12
+ * Remark plugin for file-based fences.
13
+ *
14
+ * ```tsx file="basic.demo.tsx" live height="large" title="Basic grid"
15
+ * ```
16
+ *
17
+ * - `file="..."` is relative to the page's folder; `file="/docs/x.tsx"` to the
18
+ * content root. A missing file throws at compile time, so a bad reference
19
+ * fails the build.
20
+ * - `live` replaces the fence with `<Demo name="…">` (prebuilt iframe preview
21
+ * + code tabs). The file must be a demo entry (`*.demo.tsx`) inside the
22
+ * content folder. `live=off` shows the code tab first.
23
+ * - `region="name"` shows a `#region name` … `#endregion` slice (dedented).
24
+ * With `live`, the preview runs the whole demo and only the entry's code tab
25
+ * shows the region; editing and forking use full files.
26
+ * - Highlights live in the source as comments, stripped from the shown code:
27
+ * `// #highlight label` … `// #endhighlight`, or a trailing
28
+ * `code // #highlight label` (`{/* #highlight *\/}` in JSX children).
29
+ * `{1-3}` meta highlights are rejected.
30
+ * - `lines` adds a line-number gutter (original line numbers with `region`).
31
+ * - `files=off` hides the file names and tabs of the files the entry imports.
32
+ * - `title="..."` renders a card with the title as the snippet name.
33
+ * - `height="small|default|large|auto|<px>"`; a live fence defaults to
34
+ * `liveHeight` (`auto`).
35
+ *
36
+ * Fences can also live inside `<Demo>`, next to `<DemoTitle>` /
37
+ * `<DemoDescription>`, which render as the card header; the fence's props are
38
+ * hoisted onto the `<Demo>`. A fence without `live` there makes a code-only card.
39
+ */
40
+ export function remarkDemoFences(options) {
41
+ const { contentDir, dependencies, claim, banInlineCode = true, staticFences = 'shiki-meta', demoSuffixes = ['.demo.tsx'], componentName = 'Demo', sourceReplacements, liveHeight = 'auto', } = options;
42
+ const folder = options.folder.replace(/^\/+|\/+$/g, '');
43
+ const pageDir = path.join(contentDir, folder);
44
+ /** `/docs/x.tsx` is relative to the content root, anything else to the page. */
45
+ const resolveFile = (file) => file.startsWith('/') ? path.join(contentDir, file) : path.resolve(pageDir, file);
46
+ const addDependency = (absPath) => {
47
+ dependencies?.add(path.relative(contentDir, absPath).split(path.sep).join('/'));
48
+ };
49
+ return () => (tree) => {
50
+ visit(tree, 'code', (node, index, parent) => {
51
+ if (index == null || !parent)
52
+ return;
53
+ const inDemo = parent.type === 'mdxJsxFlowElement' && parent.name === componentName;
54
+ const meta = node.meta || '';
55
+ const props = parseFenceMeta(meta);
56
+ if (!inDemo && claim && !claim({ lang: node.lang ?? null, meta, props, inDemo }))
57
+ return;
58
+ const context = `\`\`\`${node.lang ?? ''} ${meta} in "${path.join(path.basename(contentDir), folder)}"`;
59
+ if (/\{[^}]*\}/.test(meta.replace(/"[^"]*"/g, '""'))) {
60
+ throw new Error(`${context}: \`{…}\` line highlights are not supported — mark the lines in the ` +
61
+ `source file with \`// #highlight label\` … \`// #endhighlight\`, or a trailing ` +
62
+ `\`// #highlight label\` on a single line`);
63
+ }
64
+ const file = props.file;
65
+ if (props.live && !('height' in props))
66
+ props.height = liveHeight;
67
+ if ('range' in props) {
68
+ throw new Error(`${context}: \`range\` was renamed to \`region="region-name"\``);
69
+ }
70
+ if (banInlineCode && TYPECHECKED_LANGS.has(node.lang ?? '') && typeof file !== 'string') {
71
+ throw new Error(`${context}: inline ${node.lang} snippets are not allowed — put the code in a ` +
72
+ `co-located *.snippet.tsx (type-checked by tsc) and reference it with ` +
73
+ `\`file="x.snippet.tsx" region="region-name"\``);
74
+ }
75
+ if (!inDemo && typeof file !== 'string' && typeof props.title !== 'string')
76
+ return;
77
+ if ('height' in props) {
78
+ try {
79
+ parseDemoHeight(typeof props.height === 'string' ? props.height : '');
80
+ }
81
+ catch (error) {
82
+ throw new Error(`${context}: ${error instanceof Error ? error.message : String(error)}`);
83
+ }
84
+ }
85
+ let source = node.value ?? '';
86
+ if (typeof file === 'string') {
87
+ const absPath = resolveFile(file);
88
+ if (!fs.existsSync(absPath) || !fs.statSync(absPath).isFile()) {
89
+ throw new Error(`${context}: file not found: ${path.relative(contentDir, absPath)}`);
90
+ }
91
+ source = applySourceReplacements(fs.readFileSync(absPath, 'utf8').trimEnd(), sourceReplacements);
92
+ if (props.live) {
93
+ for (const { filePath } of collectDemoFiles(absPath))
94
+ addDependency(filePath);
95
+ }
96
+ else {
97
+ addDependency(absPath);
98
+ }
99
+ }
100
+ let originalLines;
101
+ if (typeof props.region === 'string') {
102
+ if (typeof file !== 'string')
103
+ throw new Error(`${context}: \`region\` requires \`file="..."\``);
104
+ const sliced = sliceRegion(source, props.region, context);
105
+ source = sliced.source;
106
+ originalLines = sliced.originalLines;
107
+ }
108
+ // Live demos strip markers per file in <Demo>.
109
+ let highlight = null;
110
+ // without `#highlight label` rows: what a card's copy button copies
111
+ let copyCode = null;
112
+ if (typeof file === 'string' && !props.live) {
113
+ const stripped = stripCodeMarkers(source);
114
+ const marked = extractCodeMarkers(source, context, originalLines);
115
+ source = marked.source;
116
+ if (stripped !== source)
117
+ copyCode = stripped;
118
+ if (originalLines)
119
+ originalLines = marked.originalLines;
120
+ if (marked.highlight.lines.length)
121
+ highlight = formatHighlightSpec(marked.highlight);
122
+ }
123
+ const originalLinesAttr = originalLines ? formatLineRanges(originalLines) || null : null;
124
+ if (props.live) {
125
+ if (props.live !== true && props.live !== 'off') {
126
+ throw new Error(`${context}: \`live\` accepts no value (preview shown first) or ` +
127
+ `\`live=off\` (preview available, code shown first)`);
128
+ }
129
+ const suffix = typeof file === 'string' ? demoSuffixes.find((s) => file.endsWith(s)) : undefined;
130
+ const fromRoot = typeof file === 'string' ? path.relative(contentDir, resolveFile(file)) : '..';
131
+ if (typeof file !== 'string' || !suffix || fromRoot.startsWith('..') || path.isAbsolute(fromRoot)) {
132
+ throw new Error(`${context}: live demos must reference a ${demoSuffixes.map((s) => `*${s}`).join(' / ')} ` +
133
+ `file inside the content folder (it has to match a prebuilt demo bundle)`);
134
+ }
135
+ const attrs = { name: file.slice(0, -suffix.length) };
136
+ if (props.live === 'off')
137
+ attrs.startTab = 'code';
138
+ if (props.files === 'off')
139
+ attrs.hideFiles = 'true';
140
+ if (typeof props.region === 'string')
141
+ attrs.region = props.region;
142
+ if (typeof props.height === 'string')
143
+ attrs.height = props.height;
144
+ const heading = inDemo ? demoTitleFromElement(parent) : null;
145
+ if (heading)
146
+ attrs.title = heading;
147
+ else if (typeof props.title === 'string')
148
+ attrs.title = props.title;
149
+ if (props.lines)
150
+ attrs.lines = 'true';
151
+ if (props.edit === 'off')
152
+ attrs.editable = 'false';
153
+ if (inDemo) {
154
+ assertSingleSnippet(parent, context);
155
+ for (const [attrName, value] of Object.entries(attrs))
156
+ setAttribute(parent, attrName, value);
157
+ parent.children.splice(index, 1);
158
+ return index;
159
+ }
160
+ parent.children[index] = element(componentName, attrs);
161
+ return;
162
+ }
163
+ const cardAttrs = (snippetTitle) => {
164
+ const attrs = { code: source, lang: node.lang || 'tsx' };
165
+ if (snippetTitle)
166
+ attrs.codeTitle = snippetTitle;
167
+ if (copyCode)
168
+ attrs.copyCode = copyCode;
169
+ if (typeof props.height === 'string')
170
+ attrs.height = props.height;
171
+ if (highlight)
172
+ attrs.highlight = highlight;
173
+ if (props.lines)
174
+ attrs.lines = 'true';
175
+ if (originalLinesAttr)
176
+ attrs.originalLines = originalLinesAttr;
177
+ return attrs;
178
+ };
179
+ if (inDemo) {
180
+ // Code-only demo: hand the snippet to <Demo> and drop the fence.
181
+ assertSingleSnippet(parent, context);
182
+ const snippetTitle = typeof props.title === 'string' ? props.title : props.files === 'off' ? null : (file ?? null);
183
+ const attrs = cardAttrs(typeof snippetTitle === 'string' ? snippetTitle : null);
184
+ const heading = demoTitleFromElement(parent);
185
+ if (heading)
186
+ attrs.title = heading;
187
+ else if (typeof props.title === 'string')
188
+ attrs.title = props.title;
189
+ for (const [attrName, value] of Object.entries(attrs))
190
+ setAttribute(parent, attrName, value);
191
+ parent.children.splice(index, 1);
192
+ return index;
193
+ }
194
+ if (typeof props.title === 'string' || staticFences === 'card') {
195
+ parent.children[index] = element(componentName, cardAttrs(typeof props.title === 'string' ? props.title : null));
196
+ return;
197
+ }
198
+ // Standalone static snippet: inline the referenced file's source; a
199
+ // markdown-level shiki pipeline highlights it like any code block.
200
+ node.value = source;
201
+ node.meta =
202
+ [
203
+ highlight ? `{${highlight}}` : null,
204
+ props.lines ? 'lines' : null,
205
+ originalLinesAttr ? `originalLines="${originalLinesAttr}"` : null,
206
+ typeof props.height === 'string' ? `height="${props.height}"` : null,
207
+ ]
208
+ .filter(Boolean)
209
+ .join(' ') || null;
210
+ node.data = { ...node.data, docsKit: true };
211
+ });
212
+ };
213
+ }
214
+ function element(name, attrs) {
215
+ return {
216
+ type: 'mdxJsxFlowElement',
217
+ name,
218
+ attributes: Object.entries(attrs).map(([attrName, value]) => ({
219
+ type: 'mdxJsxAttribute',
220
+ name: attrName,
221
+ value,
222
+ })),
223
+ children: [],
224
+ };
225
+ }
226
+ function hasAttribute(el, name) {
227
+ return (el.attributes || []).some((attr) => attr.type === 'mdxJsxAttribute' && attr.name === name);
228
+ }
229
+ /** Adds an attribute unless it's already set on the element in the markdown. */
230
+ function setAttribute(el, name, value) {
231
+ if (hasAttribute(el, name))
232
+ return;
233
+ el.attributes = el.attributes || [];
234
+ el.attributes.push({ type: 'mdxJsxAttribute', name, value });
235
+ }
236
+ function assertSingleSnippet(demoElement, context) {
237
+ if (hasAttribute(demoElement, 'name') || hasAttribute(demoElement, 'code')) {
238
+ throw new Error(`${context}: a <Demo> can contain only one code block`);
239
+ }
240
+ }
241
+ function jsxText(node) {
242
+ if (!node)
243
+ return '';
244
+ if (node.type === 'text' || node.type === 'mdxTextExpression')
245
+ return node.value || '';
246
+ return (node.children || []).map(jsxText).join('');
247
+ }
248
+ /** Plain text of a wrapping `<DemoTitle>`, if the fence lives inside `<Demo>`. */
249
+ function demoTitleFromElement(demoElement) {
250
+ for (const child of demoElement.children || []) {
251
+ if (child.type === 'mdxJsxFlowElement' && child.name === 'DemoTitle') {
252
+ const text = jsxText(child).trim();
253
+ if (text)
254
+ return text;
255
+ }
256
+ }
257
+ return null;
258
+ }
259
+ //# sourceMappingURL=remarkDemoFences.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"remarkDemoFences.js","sourceRoot":"","sources":["../../src/remark/remarkDemoFences.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAChH,OAAO,EAAE,cAAc,EAAmB,MAAM,WAAW,CAAC;AAiD5D,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AAU1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgC;IAC/D,MAAM,EACJ,UAAU,EACV,YAAY,EACZ,KAAK,EACL,aAAa,GAAG,IAAI,EACpB,YAAY,GAAG,YAAY,EAC3B,YAAY,GAAG,CAAC,WAAW,CAAC,EAC5B,aAAa,GAAG,MAAM,EACtB,kBAAkB,EAClB,UAAU,GAAG,MAAM,GACpB,GAAG,OAAO,CAAC;IACZ,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC9C,gFAAgF;IAChF,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE,CACnC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnF,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE;QACxC,YAAY,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC;IAEF,OAAO,GAAG,EAAE,CAAC,CAAC,IAAS,EAAE,EAAE;QACzB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,IAAS,EAAE,KAAyB,EAAE,MAAW,EAAE,EAAE;YACxE,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM;gBAAE,OAAO;YAErC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,KAAK,mBAAmB,IAAI,MAAM,CAAC,IAAI,KAAK,aAAa,CAAC;YACpF,MAAM,IAAI,GAAW,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;YACrC,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBAAE,OAAO;YAEzF,MAAM,OAAO,GAAG,SAAS,IAAI,CAAC,IAAI,IAAI,EAAE,IAAI,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;YAExG,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBACrD,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,sEAAsE;oBAC9E,iFAAiF;oBACjF,0CAA0C,CAC7C,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YACxB,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC;gBAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;YAClE,IAAI,OAAO,IAAI,KAAK,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,qDAAqD,CAAC,CAAC;YACnF,CAAC;YACD,IAAI,aAAa,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACxF,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,YAAY,IAAI,CAAC,IAAI,gDAAgD;oBAC7E,uEAAuE;oBACvE,+CAA+C,CAClD,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;gBAAE,OAAO;YAEnF,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;gBACtB,IAAI,CAAC;oBACH,eAAe,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACxE,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,KAAK,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC3F,CAAC;YACH,CAAC;YAED,IAAI,MAAM,GAAW,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;YACtC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;oBAC9D,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,qBAAqB,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;gBACvF,CAAC;gBACD,MAAM,GAAG,uBAAuB,CAAC,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,kBAAkB,CAAC,CAAC;gBACjG,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;oBACf,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,gBAAgB,CAAC,OAAO,CAAC;wBAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;gBAChF,CAAC;qBAAM,CAAC;oBACN,aAAa,CAAC,OAAO,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;YAED,IAAI,aAAmC,CAAC;YACxC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACrC,IAAI,OAAO,IAAI,KAAK,QAAQ;oBAAE,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,sCAAsC,CAAC,CAAC;gBAChG,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC1D,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBACvB,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;YACvC,CAAC;YAED,+CAA+C;YAC/C,IAAI,SAAS,GAAkB,IAAI,CAAC;YACpC,oEAAoE;YACpE,IAAI,QAAQ,GAAkB,IAAI,CAAC;YACnC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBAC5C,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;gBAClE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBACvB,IAAI,QAAQ,KAAK,MAAM;oBAAE,QAAQ,GAAG,QAAQ,CAAC;gBAC7C,IAAI,aAAa;oBAAE,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;gBACxD,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM;oBAAE,SAAS,GAAG,mBAAmB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACvF,CAAC;YACD,MAAM,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YAEzF,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;gBACf,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;oBAChD,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,uDAAuD;wBAC/D,oDAAoD,CACvD,CAAC;gBACJ,CAAC;gBACD,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACjG,MAAM,QAAQ,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAChG,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAClG,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,iCAAiC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG;wBACxF,yEAAyE,CAC5E,CAAC;gBACJ,CAAC;gBAED,MAAM,KAAK,GAA2B,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9E,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK;oBAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC;gBAClD,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK;oBAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC;gBACpD,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;oBAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAClE,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;oBAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAClE,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7D,IAAI,OAAO;oBAAE,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC;qBAC9B,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;oBAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;gBACpE,IAAI,KAAK,CAAC,KAAK;oBAAE,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;gBACtC,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK;oBAAE,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC;gBAEnD,IAAI,MAAM,EAAE,CAAC;oBACX,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBACrC,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;wBAAE,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;oBAC7F,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACjC,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;gBACvD,OAAO;YACT,CAAC;YAED,MAAM,SAAS,GAAG,CAAC,YAA2B,EAA0B,EAAE;gBACxE,MAAM,KAAK,GAA2B,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC;gBACjF,IAAI,YAAY;oBAAE,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC;gBACjD,IAAI,QAAQ;oBAAE,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBACxC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;oBAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAClE,IAAI,SAAS;oBAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC3C,IAAI,KAAK,CAAC,KAAK;oBAAE,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC;gBACtC,IAAI,iBAAiB;oBAAE,KAAK,CAAC,aAAa,GAAG,iBAAiB,CAAC;gBAC/D,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YAEF,IAAI,MAAM,EAAE,CAAC;gBACX,iEAAiE;gBACjE,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBACrC,MAAM,YAAY,GAChB,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;gBAChG,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAChF,MAAM,OAAO,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;gBAC7C,IAAI,OAAO;oBAAE,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC;qBAC9B,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;oBAAE,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;gBACpE,KAAK,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;oBAAE,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAC7F,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACjC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;gBAC/D,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,OAAO,CAC9B,aAAa,EACb,SAAS,CAAC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAChE,CAAC;gBACF,OAAO;YACT,CAAC;YAED,oEAAoE;YACpE,mEAAmE;YACnE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;YACpB,IAAI,CAAC,IAAI;gBACP;oBACE,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,IAAI;oBACnC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;oBAC5B,iBAAiB,CAAC,CAAC,CAAC,kBAAkB,iBAAiB,GAAG,CAAC,CAAC,CAAC,IAAI;oBACjE,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI;iBACrE;qBACE,MAAM,CAAC,OAAO,CAAC;qBACf,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAY,EAAE,KAA6B;IAC1D,OAAO;QACL,IAAI,EAAE,mBAAmB;QACzB,IAAI;QACJ,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5D,IAAI,EAAE,iBAAiB;YACvB,IAAI,EAAE,QAAQ;YACd,KAAK;SACN,CAAC,CAAC;QACH,QAAQ,EAAE,EAAE;KACb,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,EAAO,EAAE,IAAY;IACzC,OAAO,CAAC,EAAE,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,iBAAiB,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC1G,CAAC;AAED,gFAAgF;AAChF,SAAS,YAAY,CAAC,EAAO,EAAE,IAAY,EAAE,KAAa;IACxD,IAAI,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC;QAAE,OAAO;IACnC,EAAE,CAAC,UAAU,GAAG,EAAE,CAAC,UAAU,IAAI,EAAE,CAAC;IACpC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,mBAAmB,CAAC,WAAgB,EAAE,OAAe;IAC5D,IAAI,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,4CAA4C,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AAED,SAAS,OAAO,CAAC,IAAS;IACxB,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,mBAAmB;QAAE,OAAO,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;IACvF,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,kFAAkF;AAClF,SAAS,oBAAoB,CAAC,WAAgB;IAC5C,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;QAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACrE,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,108 @@
1
1
  {
2
2
  "name": "@thedatagrid/docs-kit",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "description": "Docs tooling: type-checked file snippets with regions and highlights, prebuilt and editable live demos, CodeSandbox forks",
5
+ "type": "module",
6
+ "license": "MIT",
7
+ "author": "TheDataGrid",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/thedatagrid/docs-kit.git",
11
+ "directory": "packages/docs-kit"
12
+ },
13
+ "sideEffects": [
14
+ "*.css"
15
+ ],
16
+ "exports": {
17
+ "./code": {
18
+ "types": "./dist/code/index.d.ts",
19
+ "default": "./dist/code/index.js"
20
+ },
21
+ "./remark": {
22
+ "types": "./dist/remark/index.d.ts",
23
+ "default": "./dist/remark/index.js"
24
+ },
25
+ "./demos": {
26
+ "types": "./dist/demos/index.d.ts",
27
+ "default": "./dist/demos/index.js"
28
+ },
29
+ "./demos/cli": "./dist/demos/cli.js",
30
+ "./demos/client": {
31
+ "types": "./dist/demos/client.d.ts",
32
+ "default": "./dist/demos/client.js"
33
+ },
34
+ "./react": {
35
+ "types": "./dist/react/index.d.ts",
36
+ "default": "./dist/react/index.js"
37
+ },
38
+ "./react/styles.css": "./dist/react/styles.css",
39
+ "./fork": {
40
+ "types": "./dist/fork/index.d.ts",
41
+ "default": "./dist/fork/index.js"
42
+ },
43
+ "./package.json": "./package.json"
44
+ },
45
+ "typesVersions": {
46
+ "*": {
47
+ "demos/client": [
48
+ "dist/demos/client.d.ts"
49
+ ],
50
+ "*": [
51
+ "dist/*/index.d.ts"
52
+ ]
53
+ }
54
+ },
55
+ "bin": {
56
+ "docs-kit": "./dist/demos/cli.js"
57
+ },
58
+ "files": [
59
+ "dist",
60
+ "src",
61
+ "README.md",
62
+ "CHANGELOG.md"
63
+ ],
64
+ "scripts": {
65
+ "build": "rm -rf dist && tsc -p tsconfig.build.json && node scripts/copy-assets.mjs",
66
+ "dev": "tsc -p tsconfig.build.json --watch",
67
+ "typecheck": "tsc -p tsconfig.json --noEmit",
68
+ "test": "vitest run"
69
+ },
70
+ "dependencies": {
71
+ "@codemirror/autocomplete": "^6.20.1",
72
+ "@codemirror/commands": "^6.11.1",
73
+ "@codemirror/lang-css": "^6.3.1",
74
+ "@codemirror/lang-javascript": "^6.2.5",
75
+ "@codemirror/language": "^6.13.1",
76
+ "@codemirror/search": "^6.6.0",
77
+ "@codemirror/state": "^6.7.6",
78
+ "@codemirror/view": "^6.43.15",
79
+ "@lezer/highlight": "^1.2.5",
80
+ "chokidar": "^4.0.3",
81
+ "esbuild": "0.28.2",
82
+ "esbuild-wasm": "0.28.2",
83
+ "lz-string": "^1.5.0",
84
+ "shiki": "^4.6.0",
85
+ "unist-util-visit": "^5.2.0"
86
+ },
87
+ "peerDependencies": {
88
+ "react": ">=18",
89
+ "react-dom": ">=18"
90
+ },
91
+ "devDependencies": {
92
+ "@mdx-js/mdx": "^3.1.1",
93
+ "@types/node": "^22.18.0",
94
+ "@types/react": "^19.2.2",
95
+ "@types/react-dom": "^19.2.1",
96
+ "playwright-core": "1.64.1",
97
+ "react": "^19.2.0",
98
+ "react-dom": "^19.2.0",
99
+ "remark-gfm": "^4.0.1",
100
+ "remark-mdx": "^3.1.1"
101
+ },
102
+ "engines": {
103
+ "node": ">=22.18.0"
104
+ },
105
+ "publishConfig": {
106
+ "access": "public"
107
+ }
108
+ }
@@ -0,0 +1,54 @@
1
+ import fs from 'node:fs';
2
+ import path from 'node:path';
3
+
4
+ const IMPORT_RE =
5
+ /(?:import|export)\s[^'"]*?from\s+['"](\.\.?\/[^'"]+)['"]|import\s*\(?\s*['"](\.\.?\/[^'"]+)['"]/g;
6
+
7
+ export const RESOLVE_EXTENSIONS = ['', '.tsx', '.ts', '.jsx', '.js', '.mjs', '.css', '.json'];
8
+
9
+ function resolveRelativeImport(fromDir: string, specifier: string): string | null {
10
+ const base = path.resolve(fromDir, specifier);
11
+ for (const ext of RESOLVE_EXTENSIONS) {
12
+ const candidate = base + ext;
13
+ if (fs.existsSync(candidate) && fs.statSync(candidate).isFile()) return candidate;
14
+ }
15
+ for (const ext of RESOLVE_EXTENSIONS.slice(1)) {
16
+ const candidate = path.join(base, `index${ext}`);
17
+ if (fs.existsSync(candidate)) return candidate;
18
+ }
19
+ return null;
20
+ }
21
+
22
+ export type DemoSourceFile = {
23
+ /** Absolute path. */
24
+ filePath: string;
25
+ source: string;
26
+ };
27
+
28
+ /**
29
+ * The demo file plus every file it (transitively) pulls in through relative
30
+ * imports, entry first. They are shown as extra tabs in the code view and are
31
+ * the files a browser rebuild and a CodeSandbox fork need.
32
+ */
33
+ export function collectDemoFiles(entryFile: string): DemoSourceFile[] {
34
+ const ordered: DemoSourceFile[] = [];
35
+ const visited = new Set<string>();
36
+
37
+ const visit = (filePath: string) => {
38
+ if (visited.has(filePath)) return;
39
+ visited.add(filePath);
40
+ const source = fs.readFileSync(filePath, 'utf8');
41
+ ordered.push({ filePath, source });
42
+ if (!/\.(?:[cm]?[jt]sx?)$/.test(filePath)) return;
43
+ for (const match of source.matchAll(IMPORT_RE)) {
44
+ const specifier = match[1] ?? match[2];
45
+ const resolved = resolveRelativeImport(path.dirname(filePath), specifier);
46
+ if (resolved) visit(resolved);
47
+ }
48
+ };
49
+
50
+ visit(entryFile);
51
+ return ordered;
52
+ }
53
+
54
+ export { bareImports } from './imports.ts';
@@ -0,0 +1,47 @@
1
+ export type DemoHeights = { small: number; default: number; large: number };
2
+
3
+ /** Preview heights for `height="small" | "default" | "large"`; sites can pass their own. */
4
+ export const DEMO_HEIGHTS: DemoHeights = {
5
+ small: 650,
6
+ default: 850,
7
+ large: 1050,
8
+ };
9
+
10
+ export type DemoHeightName = keyof DemoHeights;
11
+
12
+ /** Pixels, or `auto` — the card takes the natural height of the code. */
13
+ export type DemoHeight = number | 'auto';
14
+
15
+ const NAMES = new Set<string>(['small', 'default', 'large']);
16
+
17
+ function invalid(height: unknown, heights: DemoHeights): Error {
18
+ return new Error(
19
+ `invalid height "${String(height)}" — use "small" (${heights.small}px), ` +
20
+ `"default" (${heights.default}px), "large" (${heights.large}px), "auto", ` +
21
+ `or a number of pixels`,
22
+ );
23
+ }
24
+
25
+ /**
26
+ * Fence `height="small" | "default" | "large" | "auto" | "<px>"` → pixels or
27
+ * `auto`. Omitted → default. With `auto`, the preview is never shorter than
28
+ * `heights.default`, so a short code region still leaves room for the grid.
29
+ */
30
+ export function parseDemoHeight(
31
+ height?: string | number | boolean | null,
32
+ heights: DemoHeights = DEMO_HEIGHTS,
33
+ ): DemoHeight {
34
+ if (height == null) return heights.default;
35
+ if (typeof height === 'number') {
36
+ if (Number.isFinite(height) && height > 0) return height;
37
+ throw invalid(height, heights);
38
+ }
39
+ if (typeof height !== 'string') throw invalid(height, heights);
40
+ const name = height.trim().toLowerCase();
41
+ if (!name) return heights.default;
42
+ if (name === 'auto') return 'auto';
43
+ if (NAMES.has(name)) return heights[name as DemoHeightName];
44
+ const px = /^(\d+)(?:px)?$/.exec(name);
45
+ if (px && Number(px[1]) > 0) return Number(px[1]);
46
+ throw invalid(height, heights);
47
+ }