@mintlify/msft-sdk 1.1.6 → 1.1.8
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/components/content-components/table/index.js +1 -1
- package/dist/components/content-components/tabs/tabs.js +1 -1
- package/dist/components/content-components/tabs/tabs.js.map +1 -1
- package/dist/components/docsLayout.js +62 -0
- package/dist/components/docsLayout.js.map +1 -0
- package/dist/components/docsPage.js +133 -0
- package/dist/components/docsPage.js.map +1 -0
- package/dist/components/nav-tree/dropdown-menu.js +2 -2
- package/dist/components/nav-tree/dropdown-menu.js.map +1 -1
- package/dist/components/nav-tree/index.js +183 -174
- package/dist/components/nav-tree/index.js.map +1 -1
- package/dist/components/page-context-menu.js +78 -72
- package/dist/components/page-context-menu.js.map +1 -1
- package/dist/components/toc/index.js +10 -10
- package/dist/components/toc/index.js.map +1 -1
- package/dist/index.d.ts +186 -210
- package/dist/index.js +36 -113
- package/dist/index.js.map +1 -1
- package/dist/styles.css +1 -1
- package/package.json +1 -1
- package/dist/components/page.js +0 -120
- package/dist/components/page.js.map +0 -1
- package/dist/plugins/extract-headings.js +0 -28
- package/dist/plugins/extract-headings.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,31 +1,6 @@
|
|
|
1
|
-
import { ClassValue } from 'clsx';
|
|
2
1
|
import { default as default_2 } from 'react';
|
|
3
|
-
import { Element as Element_2 } from 'hast';
|
|
4
|
-
import { Handle } from 'hast-util-to-mdast';
|
|
5
2
|
import { JSX as JSX_2 } from 'react/jsx-runtime';
|
|
6
|
-
import {
|
|
7
|
-
import { Node as Node_2 } from 'unist';
|
|
8
|
-
import { Node as Node_3 } from 'hast';
|
|
9
|
-
import { Plugin as Plugin_2 } from 'unified';
|
|
10
|
-
import * as React_2 from 'react';
|
|
11
|
-
import { Root } from 'mdast';
|
|
12
|
-
import { Root as Root_2 } from 'hast';
|
|
13
|
-
import { State } from 'hast-util-to-mdast';
|
|
14
|
-
import { Text as Text_2 } from 'hast';
|
|
15
|
-
|
|
16
|
-
export declare const allComponents: {
|
|
17
|
-
CodeBlock: typeof CodeBlock;
|
|
18
|
-
Heading: ({ id, level, children, className, }: HeadingProps) => JSX_2.Element;
|
|
19
|
-
Link: typeof Link;
|
|
20
|
-
Callout: typeof Callout;
|
|
21
|
-
ZonePivot: typeof ZonePivot;
|
|
22
|
-
ZoneTarget: typeof ZoneTarget;
|
|
23
|
-
ParamName: typeof ParamName;
|
|
24
|
-
Tabs: typeof Tabs;
|
|
25
|
-
Tab: typeof Tab;
|
|
26
|
-
Details: typeof Details;
|
|
27
|
-
Summary: typeof Summary;
|
|
28
|
-
};
|
|
3
|
+
import { ReactNode } from 'react';
|
|
29
4
|
|
|
30
5
|
export declare interface BottomLinkConfig {
|
|
31
6
|
href: string;
|
|
@@ -35,29 +10,7 @@ export declare interface BottomLinkConfig {
|
|
|
35
10
|
}>;
|
|
36
11
|
}
|
|
37
12
|
|
|
38
|
-
export declare
|
|
39
|
-
|
|
40
|
-
declare interface CalloutProps {
|
|
41
|
-
type: CalloutType;
|
|
42
|
-
children: React.ReactNode;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
declare type CalloutType = "note" | "tip" | "important" | "caution" | "warning" | "nextstepaction";
|
|
46
|
-
|
|
47
|
-
export declare const capitalize: (str: string) => string;
|
|
48
|
-
|
|
49
|
-
export declare function cn(...inputs: ClassValue[]): string;
|
|
50
|
-
|
|
51
|
-
export declare function CodeBlock({ children, className, fileName, language, }: CodeBlockProps): JSX_2.Element;
|
|
52
|
-
|
|
53
|
-
declare interface CodeBlockProps {
|
|
54
|
-
children: default_2.ReactNode;
|
|
55
|
-
className?: string;
|
|
56
|
-
language?: string;
|
|
57
|
-
fileName?: string;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
declare interface ComponentsContextValue {
|
|
13
|
+
export declare interface ComponentsContextValue {
|
|
61
14
|
LinkComponent?: LinkComponent;
|
|
62
15
|
}
|
|
63
16
|
|
|
@@ -66,12 +19,21 @@ export declare function ComponentsProvider({ children, LinkComponent, }: {
|
|
|
66
19
|
LinkComponent?: LinkComponent;
|
|
67
20
|
}): JSX_2.Element;
|
|
68
21
|
|
|
22
|
+
declare type ContextualOption = {
|
|
23
|
+
id: string;
|
|
24
|
+
title: string;
|
|
25
|
+
description: string;
|
|
26
|
+
icon: default_2.ElementType;
|
|
27
|
+
action: () => void;
|
|
28
|
+
externalLink?: boolean;
|
|
29
|
+
};
|
|
30
|
+
|
|
69
31
|
export declare function convertHtmlToMdx(html: string, options?: ConvertOptions): Promise<{
|
|
70
32
|
mdx: string;
|
|
71
33
|
mdxExtracts: MdxExtracts;
|
|
72
34
|
}>;
|
|
73
35
|
|
|
74
|
-
|
|
36
|
+
declare interface ConvertOptions {
|
|
75
37
|
metadata?: Record<string, unknown>;
|
|
76
38
|
mdxExtracts?: MdxExtracts;
|
|
77
39
|
images?: {
|
|
@@ -79,31 +41,126 @@ export declare interface ConvertOptions {
|
|
|
79
41
|
};
|
|
80
42
|
}
|
|
81
43
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
44
|
+
/**
|
|
45
|
+
* DocsLayout component provides a complete documentation layout with sidebar navigation
|
|
46
|
+
* and main content area. It's designed to be scalable, customizable, and tree-shakable.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```tsx
|
|
50
|
+
* <DocsLayout
|
|
51
|
+
* navTree={{ items: [...] }}
|
|
52
|
+
* activeHref="/docs/getting-started"
|
|
53
|
+
* theme="dark"
|
|
54
|
+
* bottomLinks={[
|
|
55
|
+
* { href: "https://blog.com", label: "Blog", icon: BlogIcon }
|
|
56
|
+
* ]}
|
|
57
|
+
* LinkComponent={Link}
|
|
58
|
+
* >
|
|
59
|
+
* <YourPageContent />
|
|
60
|
+
* </DocsLayout>
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
export declare const DocsLayout: ({ navTree, children, activeHref, activeId, theme, className, bottomLinks, dropdown, LinkComponent, localization, telemetry, showSidebar, sidebarClassName, }: DocsLayoutProps) => JSX_2.Element;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Localization strings for DocsLayout
|
|
67
|
+
*/
|
|
68
|
+
export declare interface DocsLayoutLocalization {
|
|
69
|
+
/** Aria label for the sidebar navigation. Default: "Sidebar navigation" */
|
|
70
|
+
sidebarAriaLabel?: string;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Props for the DocsLayout component
|
|
75
|
+
*/
|
|
76
|
+
export declare interface DocsLayoutProps {
|
|
77
|
+
/** Navigation tree data structure */
|
|
78
|
+
navTree: NavTreeData;
|
|
79
|
+
/** The main content to render in the layout */
|
|
80
|
+
children: ReactNode;
|
|
81
|
+
/** Currently active href for navigation highlighting */
|
|
82
|
+
activeHref?: string;
|
|
83
|
+
/** Currently active ID for navigation highlighting */
|
|
84
|
+
activeId?: string;
|
|
85
|
+
/** Theme for the layout */
|
|
86
|
+
theme?: "light" | "dark";
|
|
87
|
+
/** Additional CSS classes for the outer container */
|
|
88
|
+
className?: string;
|
|
89
|
+
/** Bottom links configuration (e.g., blog, GitHub, feedback) */
|
|
90
|
+
bottomLinks?: BottomLinkConfig[];
|
|
91
|
+
/** Dropdown configuration for navigation */
|
|
92
|
+
dropdown?: DropdownConfig;
|
|
93
|
+
/** Custom Link component for navigation (e.g., React Router Link, Next.js Link) */
|
|
93
94
|
LinkComponent?: LinkComponent;
|
|
95
|
+
/** Localization strings */
|
|
96
|
+
localization?: DocsLayoutLocalization;
|
|
97
|
+
/** Telemetry configuration */
|
|
98
|
+
telemetry?: DocsLayoutTelemetry;
|
|
99
|
+
/** Whether to show the sidebar. Default: true */
|
|
100
|
+
showSidebar?: boolean;
|
|
101
|
+
/** Custom className for the sidebar to control responsive behavior.
|
|
102
|
+
* Default: "mint:max-lg:hidden" (hidden below lg breakpoint) */
|
|
103
|
+
sidebarClassName?: string;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Telemetry configuration for DocsLayout
|
|
108
|
+
*/
|
|
109
|
+
export declare interface DocsLayoutTelemetry {
|
|
110
|
+
/** Activity name for bottom link clicks */
|
|
111
|
+
bottomLinkActivity?: string;
|
|
112
|
+
/** Phase for bottom link clicks (e.g., "Start", "Complete") */
|
|
113
|
+
bottomLinkPhase?: string;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* DocsPage component renders a documentation page with MDX content, table of contents,
|
|
118
|
+
* zone pivot selectors, and page context menu. It supports full customization through
|
|
119
|
+
* props for localization, telemetry, and custom components.
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* ```tsx
|
|
123
|
+
* <DocsPage
|
|
124
|
+
* payload={{
|
|
125
|
+
* content: "...",
|
|
126
|
+
* serializedContent: Content,
|
|
127
|
+
* title: "Getting Started",
|
|
128
|
+
* description: "Learn how to get started"
|
|
129
|
+
* }}
|
|
130
|
+
* toc={[{ title: "Introduction", slug: "intro", level: 2 }]}
|
|
131
|
+
* theme="dark"
|
|
132
|
+
* pathname="/docs/getting-started"
|
|
133
|
+
* LinkComponent={Link}
|
|
134
|
+
* localization={{
|
|
135
|
+
* onThisPage: "In this article"
|
|
136
|
+
* }}
|
|
137
|
+
* telemetry={{
|
|
138
|
+
* contextMenuActivity: "DocsPageContextMenu",
|
|
139
|
+
* contextMenuPhase: "Start"
|
|
140
|
+
* }}
|
|
141
|
+
* />
|
|
142
|
+
* ```
|
|
143
|
+
*/
|
|
144
|
+
export declare function DocsPage({ payload, toc, navTree, dropdown, activeHref, theme, className, pathname, markdownContent, allPages, baseUrl, bottomLinks, LinkComponent, localization, telemetry, contextMenu, }: EnhancedDocsPageProps): JSX_2.Element;
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* Localization strings for DocsPage component
|
|
148
|
+
*/
|
|
149
|
+
export declare interface DocsPageLocalization {
|
|
150
|
+
/** Text for "On this page" heading. Default: "On this page" */
|
|
151
|
+
onThisPage?: string;
|
|
152
|
+
/** Loading message. Default: "Loading..." */
|
|
153
|
+
loading?: string;
|
|
154
|
+
/** Error title. Default: "Error" */
|
|
155
|
+
errorTitle?: string;
|
|
156
|
+
/** Generic error message. Default: "Something went wrong" */
|
|
157
|
+
errorMessage?: string;
|
|
158
|
+
/** Not found title. Default: "Page not found" */
|
|
159
|
+
notFoundTitle?: string;
|
|
160
|
+
/** Not found message. Default: "The page you're looking for doesn't exist" */
|
|
161
|
+
notFoundMessage?: string;
|
|
94
162
|
}
|
|
95
163
|
|
|
96
|
-
export declare const defaultComponents: MDXComponents;
|
|
97
|
-
|
|
98
|
-
export declare function Details({ children, open }: DetailsProps): JSX_2.Element;
|
|
99
|
-
|
|
100
|
-
declare interface DetailsProps {
|
|
101
|
-
children: default_2.ReactNode;
|
|
102
|
-
open?: boolean;
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
export declare function DocsPage({ payload, toc, navTree, dropdown, activeHref, theme, className, pathname, markdownContent, allPages, baseUrl, bottomLinks, LinkComponent, }: DocsPageProps): JSX_2.Element;
|
|
106
|
-
|
|
107
164
|
export declare interface DocsPageProps {
|
|
108
165
|
payload: PayloadData;
|
|
109
166
|
toc?: TocItem[];
|
|
@@ -120,6 +177,24 @@ export declare interface DocsPageProps {
|
|
|
120
177
|
LinkComponent?: LinkComponent;
|
|
121
178
|
}
|
|
122
179
|
|
|
180
|
+
/**
|
|
181
|
+
* Telemetry configuration for DocsPage
|
|
182
|
+
*/
|
|
183
|
+
export declare interface DocsPageTelemetry {
|
|
184
|
+
/** Activity name for page context menu interactions */
|
|
185
|
+
contextMenuActivity?: string;
|
|
186
|
+
/** Phase for context menu interactions */
|
|
187
|
+
contextMenuPhase?: string;
|
|
188
|
+
/** Activity name for TOC link clicks */
|
|
189
|
+
tocLinkActivity?: string;
|
|
190
|
+
/** Phase for TOC link clicks */
|
|
191
|
+
tocLinkPhase?: string;
|
|
192
|
+
/** Activity name for zone pivot selector changes */
|
|
193
|
+
zonePivotActivity?: string;
|
|
194
|
+
/** Phase for zone pivot changes */
|
|
195
|
+
zonePivotPhase?: string;
|
|
196
|
+
}
|
|
197
|
+
|
|
123
198
|
export declare interface DropdownConfig {
|
|
124
199
|
title: string;
|
|
125
200
|
description: string;
|
|
@@ -142,53 +217,24 @@ export declare interface DropdownItem {
|
|
|
142
217
|
}>;
|
|
143
218
|
}
|
|
144
219
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
220
|
+
/**
|
|
221
|
+
* Enhanced DocsPageProps with localization and telemetry support
|
|
222
|
+
*/
|
|
223
|
+
export declare interface EnhancedDocsPageProps extends DocsPageProps {
|
|
224
|
+
/** Localization strings */
|
|
225
|
+
localization?: DocsPageLocalization;
|
|
226
|
+
/** Telemetry configuration */
|
|
227
|
+
telemetry?: DocsPageTelemetry;
|
|
228
|
+
/** Context menu configuration */
|
|
229
|
+
contextMenu?: PageContextMenuConfig;
|
|
152
230
|
}
|
|
153
231
|
|
|
154
|
-
export declare type ElementType = {
|
|
155
|
-
type?: string;
|
|
156
|
-
tagName?: string;
|
|
157
|
-
};
|
|
158
|
-
|
|
159
|
-
export declare function extractHeadings(): (tree: Node_2, file: unknown) => void;
|
|
160
|
-
|
|
161
232
|
export declare function generateLlmsFullTxt(pages: LlmsPageConfig[], baseUrl: string): Promise<string>;
|
|
162
233
|
|
|
163
234
|
export declare function generateLlmsTxt(pages: LlmsPageConfig[], baseUrl: string): string;
|
|
164
235
|
|
|
165
|
-
export declare function getClassNames(element: Element_2): string[];
|
|
166
|
-
|
|
167
|
-
export declare const getNodeText: (node: unknown) => string;
|
|
168
|
-
|
|
169
|
-
export declare function getPageMarkdown(pathname: string): Promise<string>;
|
|
170
|
-
|
|
171
|
-
export declare function getTextContent(node: Element_2 | Text_2): string;
|
|
172
|
-
|
|
173
|
-
export declare const Heading: ({ id, level, children, className, }: HeadingProps) => JSX_2.Element;
|
|
174
|
-
|
|
175
|
-
declare interface HeadingProps {
|
|
176
|
-
id: string;
|
|
177
|
-
level: 1 | 2 | 3 | 4 | 5 | 6;
|
|
178
|
-
children: default_2.ReactNode;
|
|
179
|
-
className?: string;
|
|
180
|
-
}
|
|
181
|
-
|
|
182
236
|
export declare const Home: () => JSX_2.Element;
|
|
183
237
|
|
|
184
|
-
export declare function isElement<T extends ElementType = Element_2>(node: ElementType | undefined, key?: keyof T, element?: string): node is T & {
|
|
185
|
-
data?: {
|
|
186
|
-
meta?: unknown;
|
|
187
|
-
};
|
|
188
|
-
};
|
|
189
|
-
|
|
190
|
-
export declare function Link({ href, children, className }: LinkProps): JSX_2.Element;
|
|
191
|
-
|
|
192
238
|
export declare type LinkComponent = default_2.ComponentType<LinkComponentProps>;
|
|
193
239
|
|
|
194
240
|
export declare interface LinkComponentProps extends default_2.AnchorHTMLAttributes<HTMLAnchorElement> {
|
|
@@ -196,12 +242,6 @@ export declare interface LinkComponentProps extends default_2.AnchorHTMLAttribut
|
|
|
196
242
|
className?: string;
|
|
197
243
|
}
|
|
198
244
|
|
|
199
|
-
declare interface LinkProps {
|
|
200
|
-
href?: string;
|
|
201
|
-
children: default_2.ReactNode;
|
|
202
|
-
className?: string;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
245
|
export declare interface LlmsPageConfig {
|
|
206
246
|
title: string;
|
|
207
247
|
slug: string;
|
|
@@ -216,7 +256,7 @@ export declare interface LlmsPageConfig {
|
|
|
216
256
|
};
|
|
217
257
|
}
|
|
218
258
|
|
|
219
|
-
|
|
259
|
+
declare interface MDXComponents {
|
|
220
260
|
h1?: default_2.ComponentType<any>;
|
|
221
261
|
h2?: default_2.ComponentType<any>;
|
|
222
262
|
h3?: default_2.ComponentType<any>;
|
|
@@ -254,8 +294,6 @@ export declare interface MdxExtracts {
|
|
|
254
294
|
pivotTocItems?: Record<string, TocItem[]>;
|
|
255
295
|
}
|
|
256
296
|
|
|
257
|
-
export declare function mdxJsxFlowElementHandler(state: State, node: Element_2): MdxJsxFlowElement;
|
|
258
|
-
|
|
259
297
|
export declare function MDXRenderer({ children, components }: MDXRendererProps): JSX_2.Element;
|
|
260
298
|
|
|
261
299
|
declare interface MDXRendererProps {
|
|
@@ -304,22 +342,43 @@ declare interface NavTreeProps {
|
|
|
304
342
|
bottomLinks?: BottomLinkConfig[];
|
|
305
343
|
}
|
|
306
344
|
|
|
307
|
-
export declare const PageContextMenu: ({ className, pathname, markdownContent, onCopyMarkdown, onViewMarkdown, allPages, baseUrl, }: PageContextMenuProps) => JSX_2.Element;
|
|
345
|
+
export declare const PageContextMenu: ({ className, pathname, markdownContent, onCopyMarkdown, onCopyPage, onViewMarkdown, onViewLlmsTxt, onViewLlmsFullTxt, allPages, baseUrl, customActions, }: PageContextMenuProps) => JSX_2.Element;
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Configuration for the page context menu
|
|
349
|
+
*/
|
|
350
|
+
declare interface PageContextMenuConfig {
|
|
351
|
+
/** Custom actions for the page context menu. If provided, these will replace the default actions. */
|
|
352
|
+
customActions?: ContextualOption[];
|
|
353
|
+
/** Callback fired after markdown is successfully copied */
|
|
354
|
+
onCopyMarkdown?: () => void;
|
|
355
|
+
/** Custom handler for "Copy Page" action. If provided, replaces default copy behavior. */
|
|
356
|
+
onCopyPage?: () => void | Promise<void>;
|
|
357
|
+
/** Custom handler for "View as Markdown" action. If provided, replaces default view behavior. */
|
|
358
|
+
onViewMarkdown?: (pathname: string) => void;
|
|
359
|
+
/** Custom handler for "View llms.txt" action. If provided, replaces default behavior. */
|
|
360
|
+
onViewLlmsTxt?: () => void;
|
|
361
|
+
/** Custom handler for "View llms-full.txt" action. If provided, replaces default behavior. */
|
|
362
|
+
onViewLlmsFullTxt?: () => void;
|
|
363
|
+
}
|
|
308
364
|
|
|
309
365
|
export declare interface PageContextMenuProps {
|
|
310
366
|
className?: string;
|
|
311
367
|
pathname: string;
|
|
312
368
|
markdownContent?: string;
|
|
369
|
+
/** Callback fired after markdown is successfully copied */
|
|
313
370
|
onCopyMarkdown?: () => void;
|
|
371
|
+
/** Custom handler for "Copy Page" action. If provided, replaces default copy behavior. */
|
|
372
|
+
onCopyPage?: () => void | Promise<void>;
|
|
373
|
+
/** Custom handler for "View as Markdown" action. If provided, replaces default view behavior. */
|
|
314
374
|
onViewMarkdown?: (pathname: string) => void;
|
|
375
|
+
/** Custom handler for "View llms.txt" action. If provided, replaces default behavior. */
|
|
376
|
+
onViewLlmsTxt?: () => void;
|
|
377
|
+
/** Custom handler for "View llms-full.txt" action. If provided, replaces default behavior. */
|
|
378
|
+
onViewLlmsFullTxt?: () => void;
|
|
315
379
|
allPages?: LlmsPageConfig[];
|
|
316
380
|
baseUrl?: string;
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
export declare function ParamName({ children }: ParamNameProps): JSX_2.Element;
|
|
320
|
-
|
|
321
|
-
declare interface ParamNameProps {
|
|
322
|
-
children: React.ReactNode;
|
|
381
|
+
customActions?: ContextualOption[];
|
|
323
382
|
}
|
|
324
383
|
|
|
325
384
|
export declare interface PayloadData {
|
|
@@ -344,82 +403,14 @@ export declare interface PlainTextPageProps {
|
|
|
344
403
|
content: string;
|
|
345
404
|
}
|
|
346
405
|
|
|
347
|
-
export declare const rehypeCallouts: Plugin_2<[], Node_3>;
|
|
348
|
-
|
|
349
|
-
export declare const rehypeCodeblocks: Plugin_2<[], Node_3>;
|
|
350
|
-
|
|
351
|
-
export declare const rehypeDetails: Plugin_2<[], Node_3>;
|
|
352
|
-
|
|
353
|
-
export declare const rehypeHeadingIds: Plugin_2<[], Node_3>;
|
|
354
|
-
|
|
355
|
-
export declare const rehypeParamName: Plugin_2<[], Node_3>;
|
|
356
|
-
|
|
357
|
-
export declare function rehypeRemark(): (tree: Root_2) => Root;
|
|
358
|
-
|
|
359
|
-
export declare function rehypeRemoveHtmlComments(): (root: Root_2) => void;
|
|
360
|
-
|
|
361
|
-
export declare const rehypeTabs: Plugin_2<[], Node_3>;
|
|
362
|
-
|
|
363
|
-
export declare const rehypeZonePivots: Plugin_2<[ConvertOptions?], Node_3>;
|
|
364
|
-
|
|
365
|
-
export declare function remarkHeadingIds(): (tree: Root) => void;
|
|
366
|
-
|
|
367
|
-
export declare function removeHtmlComments(root: Root_2): void;
|
|
368
|
-
|
|
369
|
-
export declare const sanitizePreTags: Plugin_2<[], Node_3>;
|
|
370
|
-
|
|
371
406
|
export declare function serializeMdx(mdxString: string): Promise<default_2.ComponentType>;
|
|
372
407
|
|
|
373
|
-
export declare function Summary({ children, isOpen }: SummaryProps): JSX_2.Element;
|
|
374
|
-
|
|
375
|
-
declare interface SummaryProps {
|
|
376
|
-
children: default_2.ReactNode;
|
|
377
|
-
isOpen?: boolean;
|
|
378
|
-
}
|
|
379
|
-
|
|
380
|
-
export declare function Tab({ children }: TabProps): JSX_2.Element;
|
|
381
|
-
|
|
382
|
-
export declare const Table: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableElement> & React_2.RefAttributes<HTMLTableElement>>;
|
|
383
|
-
|
|
384
|
-
export declare const TableBody: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableSectionElement> & React_2.RefAttributes<HTMLTableSectionElement>>;
|
|
385
|
-
|
|
386
|
-
export declare const TableCaption: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableCaptionElement> & React_2.RefAttributes<HTMLTableCaptionElement>>;
|
|
387
|
-
|
|
388
|
-
export declare const TableCell: React_2.ForwardRefExoticComponent<React_2.TdHTMLAttributes<HTMLTableCellElement> & React_2.RefAttributes<HTMLTableCellElement>>;
|
|
389
|
-
|
|
390
|
-
export declare const tableCellHandler: Handle;
|
|
391
|
-
|
|
392
|
-
export declare const TableFooter: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableSectionElement> & React_2.RefAttributes<HTMLTableSectionElement>>;
|
|
393
|
-
|
|
394
|
-
export declare const tableHandler: Handle;
|
|
395
|
-
|
|
396
|
-
export declare const TableHead: React_2.ForwardRefExoticComponent<React_2.ThHTMLAttributes<HTMLTableCellElement> & React_2.RefAttributes<HTMLTableCellElement>>;
|
|
397
|
-
|
|
398
|
-
export declare const TableHeader: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableSectionElement> & React_2.RefAttributes<HTMLTableSectionElement>>;
|
|
399
|
-
|
|
400
408
|
export declare function TableOfContents({ toc }: TableOfContentsProps): JSX_2.Element;
|
|
401
409
|
|
|
402
410
|
declare interface TableOfContentsProps {
|
|
403
411
|
toc: TocItem[];
|
|
404
412
|
}
|
|
405
413
|
|
|
406
|
-
export declare const TableRow: React_2.ForwardRefExoticComponent<React_2.HTMLAttributes<HTMLTableRowElement> & React_2.RefAttributes<HTMLTableRowElement>>;
|
|
407
|
-
|
|
408
|
-
export declare const tableRowHandler: Handle;
|
|
409
|
-
|
|
410
|
-
declare interface TabProps {
|
|
411
|
-
title: string;
|
|
412
|
-
icon?: string;
|
|
413
|
-
children: default_2.ReactNode;
|
|
414
|
-
}
|
|
415
|
-
|
|
416
|
-
export declare function Tabs({ children, defaultTab }: TabsProps): JSX_2.Element;
|
|
417
|
-
|
|
418
|
-
declare interface TabsProps {
|
|
419
|
-
children: default_2.ReactNode;
|
|
420
|
-
defaultTab?: number;
|
|
421
|
-
}
|
|
422
|
-
|
|
423
414
|
export declare interface TocItem {
|
|
424
415
|
title: string;
|
|
425
416
|
slug: string;
|
|
@@ -431,8 +422,6 @@ export declare function useComponents(): ComponentsContextValue;
|
|
|
431
422
|
|
|
432
423
|
export declare function useMarkdownCopy(pathname: string): void;
|
|
433
424
|
|
|
434
|
-
export declare function ZonePivot({ pivot, target, children }: ZonePivotProps): JSX_2.Element | null;
|
|
435
|
-
|
|
436
425
|
export declare interface ZonePivotGroup {
|
|
437
426
|
id: string;
|
|
438
427
|
title: string;
|
|
@@ -443,12 +432,6 @@ export declare interface ZonePivotGroup {
|
|
|
443
432
|
}>;
|
|
444
433
|
}
|
|
445
434
|
|
|
446
|
-
declare interface ZonePivotProps {
|
|
447
|
-
pivot: string;
|
|
448
|
-
target?: string;
|
|
449
|
-
children: default_2.ReactNode;
|
|
450
|
-
}
|
|
451
|
-
|
|
452
435
|
export declare function ZonePivotProvider({ groups, children, defaultPivots, }: ZonePivotProviderProps): JSX_2.Element;
|
|
453
436
|
|
|
454
437
|
declare interface ZonePivotProviderProps {
|
|
@@ -464,11 +447,4 @@ declare interface ZonePivotSelectorProps {
|
|
|
464
447
|
className?: string;
|
|
465
448
|
}
|
|
466
449
|
|
|
467
|
-
export declare function ZoneTarget({ target, children }: ZoneTargetProps): JSX_2.Element;
|
|
468
|
-
|
|
469
|
-
declare interface ZoneTargetProps {
|
|
470
|
-
target: string;
|
|
471
|
-
children: default_2.ReactNode;
|
|
472
|
-
}
|
|
473
|
-
|
|
474
450
|
export { }
|
package/dist/index.js
CHANGED
|
@@ -1,116 +1,39 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import { generateLlmsFullTxt as
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import { extractHeadings as j } from "./plugins/extract-headings.js";
|
|
19
|
-
import { rehypeRemoveHtmlComments as G, removeHtmlComments as K } from "./plugins/sanitize/remove-html-comments.js";
|
|
20
|
-
import { CodeBlock as U } from "./components/content-components/code-block.js";
|
|
21
|
-
import { Heading as W } from "./components/content-components/heading.js";
|
|
22
|
-
import { Link as _ } from "./components/content-components/link.js";
|
|
23
|
-
import { Callout as ee } from "./components/content-components/callouts.js";
|
|
24
|
-
import { ZonePivot as re } from "./components/content-components/zone-pivots/zone-pivot.js";
|
|
25
|
-
import { ZoneTarget as me } from "./components/content-components/zone-pivots/zone-target.js";
|
|
26
|
-
import { ZonePivotProvider as ae } from "./components/content-components/zone-pivots/zone-pivot-context.js";
|
|
27
|
-
import { ZonePivotSelector as fe } from "./components/content-components/zone-pivots/zone-pivot-selector.js";
|
|
28
|
-
import { ParamName as ne } from "./components/content-components/param-name.js";
|
|
29
|
-
import { Tabs as de } from "./components/content-components/tabs/tabs.js";
|
|
30
|
-
import { Tab as Te } from "./components/content-components/tabs/tab.js";
|
|
31
|
-
import { Details as be, Summary as ge } from "./components/content-components/details/details.js";
|
|
32
|
-
import { Table as He, TableBody as ye, TableCaption as ve, TableCell as ce, TableFooter as ue, TableHead as he, TableHeader as Me, TableRow as ke } from "./components/content-components/table/index.js";
|
|
33
|
-
import { allComponents as De } from "./components/content-components/all-components.js";
|
|
34
|
-
import { Home as Re } from "./components/content-components/home.js";
|
|
35
|
-
import { DropdownMenu as ze } from "./components/nav-tree/dropdown-menu.js";
|
|
36
|
-
import { MobileNavTree as Le } from "./components/nav-tree/mobile-nav.js";
|
|
37
|
-
import { rehypeCodeblocks as Ee } from "./plugins/rehype/rehype-code-blocks.js";
|
|
38
|
-
import { remarkHeadingIds as Oe } from "./plugins/remark/remark-heading-ids.js";
|
|
39
|
-
import { sanitizePreTags as Ae } from "./plugins/sanitize/rehype-pre-to-mdx-fence.js";
|
|
40
|
-
import { rehypeCallouts as Xe } from "./plugins/sanitize/rehype-callouts.js";
|
|
41
|
-
import { rehypeParamName as qe } from "./plugins/sanitize/rehype-param-name.js";
|
|
42
|
-
import { rehypeTabs as Ke } from "./plugins/sanitize/rehype-tabs.js";
|
|
43
|
-
import { rehypeDetails as Ue } from "./plugins/sanitize/rehype-details.js";
|
|
44
|
-
import { rehypeHeadingIds as We } from "./plugins/sanitize/rehype-heading-ids.js";
|
|
45
|
-
import { rehypeZonePivots as _e } from "./plugins/sanitize/rehype-zone-pivots.js";
|
|
46
|
-
import { mdxJsxFlowElementHandler as eo, rehypeRemark as oo } from "./plugins/sanitize/rehype-remark.js";
|
|
47
|
-
import { tableCellHandler as to, tableHandler as mo, tableRowHandler as po } from "./plugins/sanitize/rehype-table-align.js";
|
|
1
|
+
import { DocsLayout as r } from "./components/docsLayout.js";
|
|
2
|
+
import { DocsPage as m } from "./components/docsPage.js";
|
|
3
|
+
import { MDXRenderer as p } from "./components/mdx-renderer.js";
|
|
4
|
+
import { PlainTextPage as n } from "./components/plain-text-page.js";
|
|
5
|
+
import { NavTree as l } from "./components/nav-tree/index.js";
|
|
6
|
+
import { TableOfContents as i } from "./components/toc/index.js";
|
|
7
|
+
import { PivotAwareTOC as v } from "./components/toc/pivot-aware-toc.js";
|
|
8
|
+
import { PageContextMenu as d } from "./components/page-context-menu.js";
|
|
9
|
+
import { ComponentsProvider as M, useComponents as g } from "./context/components-context.js";
|
|
10
|
+
import { useMarkdownCopy as c } from "./hooks/useMarkdownCopy.js";
|
|
11
|
+
import { generateLlmsFullTxt as L, generateLlmsTxt as b } from "./utils/generate-llms-txt.js";
|
|
12
|
+
import { convertHtmlToMdx as y } from "./parser/convert-html-to-mdx.js";
|
|
13
|
+
import { serializeMdx as N } from "./parser/serialize-mdx.js";
|
|
14
|
+
import { Home as Z } from "./components/content-components/home.js";
|
|
15
|
+
import { MobileNavTree as z } from "./components/nav-tree/mobile-nav.js";
|
|
16
|
+
import { ZonePivotProvider as F } from "./components/content-components/zone-pivots/zone-pivot-context.js";
|
|
17
|
+
import { ZonePivotSelector as S } from "./components/content-components/zone-pivots/zone-pivot-selector.js";
|
|
48
18
|
export {
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
ye as TableBody,
|
|
69
|
-
ve as TableCaption,
|
|
70
|
-
ce as TableCell,
|
|
71
|
-
ue as TableFooter,
|
|
72
|
-
he as TableHead,
|
|
73
|
-
Me as TableHeader,
|
|
74
|
-
b as TableOfContents,
|
|
75
|
-
ke as TableRow,
|
|
76
|
-
de as Tabs,
|
|
77
|
-
re as ZonePivot,
|
|
78
|
-
ae as ZonePivotProvider,
|
|
79
|
-
fe as ZonePivotSelector,
|
|
80
|
-
me as ZoneTarget,
|
|
81
|
-
De as allComponents,
|
|
82
|
-
Z as capitalize,
|
|
83
|
-
F as cn,
|
|
84
|
-
S as convertHtmlToMdx,
|
|
85
|
-
c as copyMarkdownToClipboard,
|
|
86
|
-
f as createDefaultComponents,
|
|
87
|
-
l as defaultComponents,
|
|
88
|
-
j as extractHeadings,
|
|
89
|
-
k as generateLlmsFullTxt,
|
|
90
|
-
w as generateLlmsTxt,
|
|
91
|
-
B as getClassNames,
|
|
92
|
-
N as getNodeText,
|
|
93
|
-
u as getPageMarkdown,
|
|
94
|
-
E as getTextContent,
|
|
95
|
-
I as isElement,
|
|
96
|
-
eo as mdxJsxFlowElementHandler,
|
|
97
|
-
Xe as rehypeCallouts,
|
|
98
|
-
Ee as rehypeCodeblocks,
|
|
99
|
-
Ue as rehypeDetails,
|
|
100
|
-
We as rehypeHeadingIds,
|
|
101
|
-
qe as rehypeParamName,
|
|
102
|
-
oo as rehypeRemark,
|
|
103
|
-
G as rehypeRemoveHtmlComments,
|
|
104
|
-
Ke as rehypeTabs,
|
|
105
|
-
_e as rehypeZonePivots,
|
|
106
|
-
Oe as remarkHeadingIds,
|
|
107
|
-
K as removeHtmlComments,
|
|
108
|
-
Ae as sanitizePreTags,
|
|
109
|
-
J as serializeMdx,
|
|
110
|
-
to as tableCellHandler,
|
|
111
|
-
mo as tableHandler,
|
|
112
|
-
po as tableRowHandler,
|
|
113
|
-
d as useComponents,
|
|
114
|
-
h as useMarkdownCopy
|
|
19
|
+
M as ComponentsProvider,
|
|
20
|
+
r as DocsLayout,
|
|
21
|
+
m as DocsPage,
|
|
22
|
+
Z as Home,
|
|
23
|
+
p as MDXRenderer,
|
|
24
|
+
z as MobileNavTree,
|
|
25
|
+
l as NavTree,
|
|
26
|
+
d as PageContextMenu,
|
|
27
|
+
v as PivotAwareTOC,
|
|
28
|
+
n as PlainTextPage,
|
|
29
|
+
i as TableOfContents,
|
|
30
|
+
F as ZonePivotProvider,
|
|
31
|
+
S as ZonePivotSelector,
|
|
32
|
+
y as convertHtmlToMdx,
|
|
33
|
+
L as generateLlmsFullTxt,
|
|
34
|
+
b as generateLlmsTxt,
|
|
35
|
+
N as serializeMdx,
|
|
36
|
+
g as useComponents,
|
|
37
|
+
c as useMarkdownCopy
|
|
115
38
|
};
|
|
116
39
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;"}
|