@xyd-js/core 0.1.0-xyd.2 → 0.1.0-xyd.4

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 (6) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/index.d.mts +5 -2
  3. package/dist/index.d.ts +5 -2
  4. package/package.json +1 -1
  5. package/src/types/content.ts +1 -0
  6. package/src/types/settings.ts +4 -2
package/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # @xyd-js/core
2
+
3
+ ## 0.1.0-xyd.4
4
+
5
+ ### Patch Changes
6
+
7
+ - initial changeset bump
package/dist/index.d.mts CHANGED
@@ -1,5 +1,8 @@
1
+ import React from 'react';
2
+
1
3
  interface FrontMatter {
2
4
  title: string | {
5
+ title: string;
3
6
  code: string;
4
7
  };
5
8
  group?: string[];
@@ -18,7 +21,7 @@ interface Settings {
18
21
  }
19
22
  interface Styling {
20
23
  name: string;
21
- logo?: string | Logo | JSX.Element;
24
+ logo?: string | Logo | React.JSX.Element;
22
25
  favicon?: string;
23
26
  colors?: Colors;
24
27
  theme?: ThemeType;
@@ -110,7 +113,7 @@ interface CallToAction {
110
113
  arrow?: boolean;
111
114
  }
112
115
  interface Anchor {
113
- icon?: string | JSX.Element;
116
+ icon?: string | React.JSX.Element;
114
117
  name?: string;
115
118
  url?: string;
116
119
  }
package/dist/index.d.ts CHANGED
@@ -1,5 +1,8 @@
1
+ import React from 'react';
2
+
1
3
  interface FrontMatter {
2
4
  title: string | {
5
+ title: string;
3
6
  code: string;
4
7
  };
5
8
  group?: string[];
@@ -18,7 +21,7 @@ interface Settings {
18
21
  }
19
22
  interface Styling {
20
23
  name: string;
21
- logo?: string | Logo | JSX.Element;
24
+ logo?: string | Logo | React.JSX.Element;
22
25
  favicon?: string;
23
26
  colors?: Colors;
24
27
  theme?: ThemeType;
@@ -110,7 +113,7 @@ interface CallToAction {
110
113
  arrow?: boolean;
111
114
  }
112
115
  interface Anchor {
113
- icon?: string | JSX.Element;
116
+ icon?: string | React.JSX.Element;
114
117
  name?: string;
115
118
  url?: string;
116
119
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyd-js/core",
3
- "version": "0.1.0-xyd.2",
3
+ "version": "0.1.0-xyd.4",
4
4
  "description": "",
5
5
  "main": "./dist/index.js",
6
6
  "dependencies": {},
package/src/types/content.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  export interface FrontMatter {
2
2
  title: string | {
3
+ title: string
3
4
  code: string // TODO: in the future mechanism similar to codehike
4
5
  }
5
6
  group?: string[]
package/src/types/settings.ts CHANGED
@@ -1,3 +1,5 @@
1
+ import React from "react";
2
+
1
3
  export interface Settings {
2
4
  // styling configurations for the documentation
3
5
  styling?: Styling
@@ -20,7 +22,7 @@ export interface Styling {
20
22
 
21
23
  // Path to logo image or object with path to “light” and “dark” mode logo images, and where the logo links to. SVG format is recommended.
22
24
  // It does not pixelate and the file size is generally smaller.
23
- logo?: string | Logo | JSX.Element
25
+ logo?: string | Logo | React.JSX.Element
24
26
 
25
27
  // Path to the favicon image. For example: /path/to/favicon.svg
26
28
  favicon?: string;
@@ -222,7 +224,7 @@ export interface CallToAction {
222
224
 
223
225
  export interface Anchor {
224
226
  // The Font Awesome or JSX icon used to feature the anchor.
225
- icon?: string | JSX.Element
227
+ icon?: string | React.JSX.Element
226
228
 
227
229
  // The name of the anchor label.
228
230
  name?: string