@openpkg-ts/fumadocs-adapter 0.4.3 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/index.d.ts +1 -3
- package/dist/components/index.js +1 -49
- package/dist/index.d.ts +3 -3
- package/dist/index.js +15 -3
- package/package.json +2 -2
- package/src/styles/docskit.css +2 -0
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { CollapsibleMethod, CollapsibleMethodProps, ExampleBlock, ExampleBlockProps, ExpandableProperty, ExpandablePropertyProps, MemberRow, MemberRowProps, MembersTable, MembersTableProps, NestedProperty, NestedPropertyProps, ParamRow, ParamRowProps, ParamTable, ParamTableProps, Signature, SignatureProps, TypeTable, TypeTableProps } from "@openpkg-ts/doc-generator/react";
|
|
2
|
-
import { APIPage, APIPageProps, ClassPage, ClassPageProps, CodeTabs, CodeTab, CodeTabsProps, EnumPage, EnumPageProps, ExportCard, ExportCardProps, ExportIndexPage, ExportIndexPageProps, FunctionPage, FunctionPageProps, ImportSection, ImportSectionProps, InterfacePage, InterfacePageProps, ParameterItem, NestedPropertyItemProps, ParameterItemProps, VariablePage, VariablePageProps } from "@openpkg-ts/doc-generator/react/styled";
|
|
3
1
|
/**
|
|
4
2
|
* Documentation drift information.
|
|
5
3
|
* Describes a mismatch between docs and code.
|
|
@@ -24,4 +22,4 @@ interface CoverageBadgeProps {
|
|
|
24
22
|
showDrift?: boolean;
|
|
25
23
|
}
|
|
26
24
|
declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps): React.ReactNode;
|
|
27
|
-
export {
|
|
25
|
+
export { DocsMetadata, DocDrift, CoverageBadgeProps, CoverageBadge };
|
package/dist/components/index.js
CHANGED
|
@@ -1,54 +1,6 @@
|
|
|
1
1
|
import {
|
|
2
2
|
CoverageBadge
|
|
3
3
|
} from "../shared/chunk-a91ch1vp.js";
|
|
4
|
-
|
|
5
|
-
// src/components/index.ts
|
|
6
|
-
import {
|
|
7
|
-
CollapsibleMethod,
|
|
8
|
-
ExampleBlock,
|
|
9
|
-
ExpandableProperty,
|
|
10
|
-
MemberRow,
|
|
11
|
-
MembersTable,
|
|
12
|
-
NestedProperty,
|
|
13
|
-
ParamRow,
|
|
14
|
-
ParamTable,
|
|
15
|
-
Signature,
|
|
16
|
-
TypeTable
|
|
17
|
-
} from "@openpkg-ts/doc-generator/react";
|
|
18
|
-
import {
|
|
19
|
-
APIPage,
|
|
20
|
-
ClassPage,
|
|
21
|
-
CodeTabs,
|
|
22
|
-
EnumPage,
|
|
23
|
-
ExportCard,
|
|
24
|
-
ExportIndexPage,
|
|
25
|
-
FunctionPage,
|
|
26
|
-
ImportSection,
|
|
27
|
-
InterfacePage,
|
|
28
|
-
ParameterItem,
|
|
29
|
-
VariablePage
|
|
30
|
-
} from "@openpkg-ts/doc-generator/react/styled";
|
|
31
4
|
export {
|
|
32
|
-
|
|
33
|
-
TypeTable,
|
|
34
|
-
Signature,
|
|
35
|
-
ParameterItem,
|
|
36
|
-
ParamTable,
|
|
37
|
-
ParamRow,
|
|
38
|
-
NestedProperty,
|
|
39
|
-
MembersTable,
|
|
40
|
-
MemberRow,
|
|
41
|
-
InterfacePage,
|
|
42
|
-
ImportSection,
|
|
43
|
-
FunctionPage,
|
|
44
|
-
ExportIndexPage,
|
|
45
|
-
ExportCard,
|
|
46
|
-
ExpandableProperty,
|
|
47
|
-
ExampleBlock,
|
|
48
|
-
EnumPage,
|
|
49
|
-
CoverageBadge,
|
|
50
|
-
CollapsibleMethod,
|
|
51
|
-
CodeTabs,
|
|
52
|
-
ClassPage,
|
|
53
|
-
APIPage
|
|
5
|
+
CoverageBadge
|
|
54
6
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -74,8 +74,8 @@ interface OpenpkgPluginOptions {
|
|
|
74
74
|
*/
|
|
75
75
|
declare function openpkgPlugin(options?: OpenpkgPluginOptions): LoaderPlugin;
|
|
76
76
|
import { DocsInstance as DocsInstance2, LoadOptions, OpenPkg as OpenPkg2, SpecExample, SpecExport as SpecExport2, SpecExportKind as SpecExportKind2, SpecMember, SpecSchema, SpecSignature, SpecSignatureParameter, SpecTag, SpecType, SpecTypeKind, SpecTypeParameter } from "@openpkg-ts/doc-generator";
|
|
77
|
-
import { AlgoliaRecord, buildSignatureString, createDocs, createDocs as createDocs2, DocsInstance as DocsInstance3, ExportMarkdownOptions, exportToMarkdown, formatParameters, formatReturnType, formatSchema, formatTypeParameters, getMethods, getProperties, groupByVisibility, HTMLOptions, isMethod, isProperty, JSONOptions, LoadOptions as LoadOptions2, loadSpec, MarkdownOptions, NavOptions, PagefindRecord, resolveTypeRef, SearchIndex, SearchOptions, SearchRecord,
|
|
78
|
-
import { APIPage, APIPageProps, ClassPage, ClassPageProps, CodeTabs, CodeTab, CodeTabsProps, EnumPage, EnumPageProps, ExportCard, ExportCardProps, ExportIndexPage, ExportIndexPageProps, FunctionPage, FunctionPageProps, ImportSection, ImportSectionProps, InterfacePage, InterfacePageProps, NestedPropertyItemProps, ParameterItem, ParameterItemProps, VariablePage, VariablePageProps } from "@openpkg-ts/doc-generator/react/styled";
|
|
77
|
+
import { AlgoliaRecord, buildSignatureString, createDocs, createDocs as createDocs2, DocsInstance as DocsInstance3, ExportMarkdownOptions, exportToMarkdown, formatParameters, formatReturnType, formatSchema, formatTypeParameters, getMethods, getProperties, groupByVisibility, HTMLOptions, isMethod, isProperty, JSONOptions, LoadOptions as LoadOptions2, loadSpec, MarkdownOptions, NavOptions, PagefindRecord, resolveTypeRef, SearchIndex, SearchOptions, SearchRecord, sortByName, toAlgoliaRecords, toDocusaurusSidebarJS, toFumadocsMetaJSON, toHTML, toJSON, toJSONString, toMarkdown, toNavigation, toPagefindRecords, toSearchIndex, toSearchIndexJSON } from "@openpkg-ts/doc-generator";
|
|
78
|
+
import { APIPage, APIPageProps, ClassPage, ClassPageProps, ClassSection, ClassSectionProps, CodeTabs, CodeTab, CodeTabsProps, EnumPage, EnumPageProps, EnumSection, EnumSectionProps, ExportCard, ExportCardProps, ExportIndexPage, ExportIndexPageProps, ExportSection, ExportSectionProps, FullAPIReferencePage, FullAPIReferencePageProps, FunctionPage, FunctionPageProps, FunctionSection, FunctionSectionProps, ImportSection, ImportSectionProps, InterfacePage, InterfacePageProps, InterfaceSection, InterfaceSectionProps, NestedPropertyItemProps, ParameterItem, ParameterItemProps, VariablePage, VariablePageProps, VariableSection, VariableSectionProps } from "@openpkg-ts/doc-generator/react/styled";
|
|
79
79
|
/**
|
|
80
80
|
* Documentation drift information.
|
|
81
81
|
* Describes a mismatch between docs and code.
|
|
@@ -100,4 +100,4 @@ interface CoverageBadgeProps {
|
|
|
100
100
|
showDrift?: boolean;
|
|
101
101
|
}
|
|
102
102
|
declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps): React.ReactNode;
|
|
103
|
-
export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName,
|
|
103
|
+
export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName, resolveTypeRef, openpkgSource, openpkgPlugin, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs2 as createOpenPkg, createDocs, buildSignatureString, VariableSectionProps, VariableSection, VariablePageProps, VariablePage, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExportKind2 as SpecExportKind, SpecExport2 as SpecExport, SpecExample, SearchRecord, SearchOptions, SearchIndex, ParameterItemProps, ParameterItem, PagefindRecord, OpenpkgPluginOptions, OpenPkgSourceOptions, OpenPkgPageData, LoadOptions as OpenPkgOptions, OpenPkgMetaData, DocsInstance2 as OpenPkgInstance, OpenPkg2 as OpenPkg, NestedPropertyItemProps, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, KindBadgeProps, KindBadge, JSONOptions, InterfaceSectionProps, InterfaceSection, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, HTMLOptions, FunctionSectionProps, FunctionSection, FunctionPageProps, FunctionPage, FullAPIReferencePageProps, FullAPIReferencePage, ExportSectionProps, ExportSection, ExportMarkdownOptions, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, EnumSectionProps, EnumSection, EnumPageProps, EnumPage, DocsMetadata, DocsInstance3 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, CodeTabsProps, CodeTabs, CodeTab, ClassSectionProps, ClassSection, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };
|
package/dist/index.js
CHANGED
|
@@ -148,7 +148,6 @@ import {
|
|
|
148
148
|
isProperty,
|
|
149
149
|
loadSpec,
|
|
150
150
|
resolveTypeRef,
|
|
151
|
-
sortByKindThenName,
|
|
152
151
|
sortByName,
|
|
153
152
|
toAlgoliaRecords,
|
|
154
153
|
toDocusaurusSidebarJS,
|
|
@@ -165,15 +164,22 @@ import {
|
|
|
165
164
|
import {
|
|
166
165
|
APIPage,
|
|
167
166
|
ClassPage,
|
|
167
|
+
ClassSection,
|
|
168
168
|
CodeTabs,
|
|
169
169
|
EnumPage,
|
|
170
|
+
EnumSection,
|
|
170
171
|
ExportCard,
|
|
171
172
|
ExportIndexPage,
|
|
173
|
+
ExportSection,
|
|
174
|
+
FullAPIReferencePage,
|
|
172
175
|
FunctionPage,
|
|
176
|
+
FunctionSection,
|
|
173
177
|
ImportSection,
|
|
174
178
|
InterfacePage,
|
|
179
|
+
InterfaceSection,
|
|
175
180
|
ParameterItem,
|
|
176
|
-
VariablePage
|
|
181
|
+
VariablePage,
|
|
182
|
+
VariableSection
|
|
177
183
|
} from "@openpkg-ts/doc-generator/react/styled";
|
|
178
184
|
export {
|
|
179
185
|
toSearchIndexJSON,
|
|
@@ -188,7 +194,6 @@ export {
|
|
|
188
194
|
toDocusaurusSidebarJS,
|
|
189
195
|
toAlgoliaRecords,
|
|
190
196
|
sortByName,
|
|
191
|
-
sortByKindThenName,
|
|
192
197
|
resolveTypeRef,
|
|
193
198
|
openpkgSource,
|
|
194
199
|
openpkgPlugin,
|
|
@@ -206,17 +211,24 @@ export {
|
|
|
206
211
|
createDocs3 as createOpenPkg,
|
|
207
212
|
createDocs2 as createDocs,
|
|
208
213
|
buildSignatureString,
|
|
214
|
+
VariableSection,
|
|
209
215
|
VariablePage,
|
|
210
216
|
ParameterItem,
|
|
211
217
|
KindBadge,
|
|
218
|
+
InterfaceSection,
|
|
212
219
|
InterfacePage,
|
|
213
220
|
ImportSection,
|
|
221
|
+
FunctionSection,
|
|
214
222
|
FunctionPage,
|
|
223
|
+
FullAPIReferencePage,
|
|
224
|
+
ExportSection,
|
|
215
225
|
ExportIndexPage,
|
|
216
226
|
ExportCard,
|
|
227
|
+
EnumSection,
|
|
217
228
|
EnumPage,
|
|
218
229
|
CoverageBadge,
|
|
219
230
|
CodeTabs,
|
|
231
|
+
ClassSection,
|
|
220
232
|
ClassPage,
|
|
221
233
|
APIPage
|
|
222
234
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openpkg-ts/fumadocs-adapter",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "Fumadocs integration for OpenPkg API documentation",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"typecheck": "tsc --noEmit"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@openpkg-ts/doc-generator": "^0.
|
|
31
|
+
"@openpkg-ts/doc-generator": "^0.5.0"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"fumadocs-core": "^16.0.0",
|
package/src/styles/docskit.css
CHANGED
|
@@ -73,6 +73,7 @@
|
|
|
73
73
|
--api-text-secondary: var(--color-fd-muted-foreground, hsl(0 0% 60%));
|
|
74
74
|
--api-accent: var(--color-fd-primary, hsl(220 70% 55%));
|
|
75
75
|
--api-accent-muted: var(--color-fd-primary, hsl(220 70% 55%) / 0.15);
|
|
76
|
+
|
|
76
77
|
}
|
|
77
78
|
|
|
78
79
|
/* Light mode overrides */
|
|
@@ -93,6 +94,7 @@
|
|
|
93
94
|
--api-text-secondary: var(--color-fd-muted-foreground, hsl(0 0% 45%));
|
|
94
95
|
--api-accent: var(--color-fd-primary, hsl(220 70% 50%));
|
|
95
96
|
--api-accent-muted: var(--color-fd-primary, hsl(220 70% 50%) / 0.1);
|
|
97
|
+
|
|
96
98
|
}
|
|
97
99
|
}
|
|
98
100
|
|