@openpkg-ts/fumadocs-adapter 0.2.3 → 0.2.5
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/index.d.ts +2 -2
- package/dist/index.js +10 -0
- package/package.json +2 -2
- package/src/styles/docskit.css +57 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { DocsInstance, LoadOptions, OpenPkg, SpecExample, SpecExport, SpecExportKind, SpecMember, SpecSchema, SpecSignature, SpecSignatureParameter, SpecTag, SpecType, SpecTypeKind, SpecTypeParameter } from "@openpkg-ts/doc-generator";
|
|
2
2
|
import { AlgoliaRecord, buildSignatureString, createDocs, createDocs as createDocs2, DocsInstance as DocsInstance2, ExportMarkdownOptions, exportToMarkdown, formatParameters, formatReturnType, formatSchema, formatTypeParameters, getMethods, getProperties, groupByVisibility, HTMLOptions, isMethod, isProperty, JSONOptions, LoadOptions as LoadOptions2, loadSpec, MarkdownOptions, NavOptions, PagefindRecord, resolveTypeRef, SearchIndex, SearchOptions, SearchRecord, sortByKindThenName, sortByName, toAlgoliaRecords, toDocusaurusSidebarJS, toFumadocsMetaJSON, toHTML, toJSON, toJSONString, toMarkdown, toNavigation, toPagefindRecords, toSearchIndex, toSearchIndexJSON } from "@openpkg-ts/doc-generator";
|
|
3
|
-
import { APIPage, APIPageProps, ClassPage, ClassPageProps, EnumPage, EnumPageProps, FunctionPage, FunctionPageProps, InterfacePage, InterfacePageProps, VariablePage, VariablePageProps } from "@openpkg-ts/doc-generator/react/styled";
|
|
3
|
+
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";
|
|
4
4
|
/**
|
|
5
5
|
* Documentation drift information.
|
|
6
6
|
* Describes a mismatch between docs and code.
|
|
@@ -25,4 +25,4 @@ interface CoverageBadgeProps {
|
|
|
25
25
|
showDrift?: boolean;
|
|
26
26
|
}
|
|
27
27
|
declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps): React.ReactNode;
|
|
28
|
-
export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName, sortByKindThenName, resolveTypeRef, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs2 as createOpenPkg, createDocs, buildSignatureString, VariablePageProps, VariablePage, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExportKind, SpecExport, SpecExample, SearchRecord, SearchOptions, SearchIndex, PagefindRecord, LoadOptions as OpenPkgOptions, DocsInstance as OpenPkgInstance, OpenPkg, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, JSONOptions, InterfacePageProps, InterfacePage, HTMLOptions, FunctionPageProps, FunctionPage, ExportMarkdownOptions, EnumPageProps, EnumPage, DocsMetadata, DocsInstance2 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };
|
|
28
|
+
export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName, sortByKindThenName, resolveTypeRef, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs2 as createOpenPkg, createDocs, buildSignatureString, VariablePageProps, VariablePage, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExportKind, SpecExport, SpecExample, SearchRecord, SearchOptions, SearchIndex, ParameterItemProps, ParameterItem, PagefindRecord, LoadOptions as OpenPkgOptions, DocsInstance as OpenPkgInstance, OpenPkg, NestedPropertyItemProps, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, JSONOptions, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, HTMLOptions, FunctionPageProps, FunctionPage, ExportMarkdownOptions, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, EnumPageProps, EnumPage, DocsMetadata, DocsInstance2 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, CodeTabsProps, CodeTabs, CodeTab, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };
|
package/dist/index.js
CHANGED
|
@@ -36,9 +36,14 @@ import {
|
|
|
36
36
|
import {
|
|
37
37
|
APIPage,
|
|
38
38
|
ClassPage,
|
|
39
|
+
CodeTabs,
|
|
39
40
|
EnumPage,
|
|
41
|
+
ExportCard,
|
|
42
|
+
ExportIndexPage,
|
|
40
43
|
FunctionPage,
|
|
44
|
+
ImportSection,
|
|
41
45
|
InterfacePage,
|
|
46
|
+
ParameterItem,
|
|
42
47
|
VariablePage
|
|
43
48
|
} from "@openpkg-ts/doc-generator/react/styled";
|
|
44
49
|
export {
|
|
@@ -71,10 +76,15 @@ export {
|
|
|
71
76
|
createDocs,
|
|
72
77
|
buildSignatureString,
|
|
73
78
|
VariablePage,
|
|
79
|
+
ParameterItem,
|
|
74
80
|
InterfacePage,
|
|
81
|
+
ImportSection,
|
|
75
82
|
FunctionPage,
|
|
83
|
+
ExportIndexPage,
|
|
84
|
+
ExportCard,
|
|
76
85
|
EnumPage,
|
|
77
86
|
CoverageBadge,
|
|
87
|
+
CodeTabs,
|
|
78
88
|
ClassPage,
|
|
79
89
|
APIPage
|
|
80
90
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openpkg-ts/fumadocs-adapter",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.5",
|
|
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.2.0"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
34
|
"react": "^18 || ^19"
|
package/src/styles/docskit.css
CHANGED
|
@@ -27,9 +27,23 @@
|
|
|
27
27
|
/* Line highlight colors */
|
|
28
28
|
--dk-line-bg: transparent;
|
|
29
29
|
--dk-line-border: transparent;
|
|
30
|
+
|
|
31
|
+
/* API Reference Typography */
|
|
32
|
+
--api-font-mono: var(--font-mono, ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace);
|
|
33
|
+
--api-font-display: var(--font-sans, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif);
|
|
34
|
+
|
|
35
|
+
/* API Reference Colors (dark mode first) */
|
|
36
|
+
--api-bg-primary: var(--color-fd-background, hsl(0 0% 3%));
|
|
37
|
+
--api-bg-secondary: var(--color-fd-muted, hsl(0 0% 10%));
|
|
38
|
+
--api-bg-card: var(--color-fd-card, hsl(0 0% 6%));
|
|
39
|
+
--api-border: var(--color-fd-border, hsl(0 0% 18%));
|
|
40
|
+
--api-text-primary: var(--color-fd-foreground, hsl(0 0% 98%));
|
|
41
|
+
--api-text-secondary: var(--color-fd-muted-foreground, hsl(0 0% 60%));
|
|
42
|
+
--api-accent: var(--color-fd-primary, hsl(220 70% 55%));
|
|
43
|
+
--api-accent-muted: var(--color-fd-primary, hsl(220 70% 55%) / 0.15);
|
|
30
44
|
}
|
|
31
45
|
|
|
32
|
-
/* Light mode overrides
|
|
46
|
+
/* Light mode overrides */
|
|
33
47
|
.light,
|
|
34
48
|
[data-theme="light"] {
|
|
35
49
|
--dk-background: var(--color-fd-card, hsl(0 0% 98%));
|
|
@@ -37,6 +51,16 @@
|
|
|
37
51
|
--dk-tabs-background: var(--color-fd-muted, hsl(0 0% 95%));
|
|
38
52
|
--dk-tab-inactive-foreground: var(--color-fd-muted-foreground, hsl(0 0% 45%));
|
|
39
53
|
--dk-tab-active-foreground: var(--color-fd-foreground, hsl(0 0% 10%));
|
|
54
|
+
|
|
55
|
+
/* API Reference Colors (light mode) */
|
|
56
|
+
--api-bg-primary: var(--color-fd-background, hsl(0 0% 100%));
|
|
57
|
+
--api-bg-secondary: var(--color-fd-muted, hsl(0 0% 96%));
|
|
58
|
+
--api-bg-card: var(--color-fd-card, hsl(0 0% 99%));
|
|
59
|
+
--api-border: var(--color-fd-border, hsl(0 0% 85%));
|
|
60
|
+
--api-text-primary: var(--color-fd-foreground, hsl(0 0% 10%));
|
|
61
|
+
--api-text-secondary: var(--color-fd-muted-foreground, hsl(0 0% 45%));
|
|
62
|
+
--api-accent: var(--color-fd-primary, hsl(220 70% 50%));
|
|
63
|
+
--api-accent-muted: var(--color-fd-primary, hsl(220 70% 50%) / 0.1);
|
|
40
64
|
}
|
|
41
65
|
}
|
|
42
66
|
|
|
@@ -61,6 +85,38 @@
|
|
|
61
85
|
.selection\:bg-dk-selection *::selection {
|
|
62
86
|
background-color: var(--dk-selection);
|
|
63
87
|
}
|
|
88
|
+
|
|
89
|
+
/* API Reference utilities */
|
|
90
|
+
.font-api-mono {
|
|
91
|
+
font-family: var(--api-font-mono);
|
|
92
|
+
}
|
|
93
|
+
.font-api-display {
|
|
94
|
+
font-family: var(--api-font-display);
|
|
95
|
+
}
|
|
96
|
+
.bg-api-primary {
|
|
97
|
+
background-color: var(--api-bg-primary);
|
|
98
|
+
}
|
|
99
|
+
.bg-api-secondary {
|
|
100
|
+
background-color: var(--api-bg-secondary);
|
|
101
|
+
}
|
|
102
|
+
.bg-api-card {
|
|
103
|
+
background-color: var(--api-bg-card);
|
|
104
|
+
}
|
|
105
|
+
.border-api {
|
|
106
|
+
border-color: var(--api-border);
|
|
107
|
+
}
|
|
108
|
+
.text-api-primary {
|
|
109
|
+
color: var(--api-text-primary);
|
|
110
|
+
}
|
|
111
|
+
.text-api-secondary {
|
|
112
|
+
color: var(--api-text-secondary);
|
|
113
|
+
}
|
|
114
|
+
.text-api-accent {
|
|
115
|
+
color: var(--api-accent);
|
|
116
|
+
}
|
|
117
|
+
.bg-api-accent-muted {
|
|
118
|
+
background-color: var(--api-accent-muted);
|
|
119
|
+
}
|
|
64
120
|
}
|
|
65
121
|
|
|
66
122
|
/* CodeHike syntax highlighting theme - github-from-css */
|