@xyd-js/core 0.1.0-xyd.1 → 0.1.0-xyd.10

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# @xyd-js/core
+
+## 0.1.0-xyd.10
+
+### Patch Changes
+
+- refactor, ui tweaks
+
+## 0.1.0-xyd.9
+
+### Patch Changes
+
+- refactor, tweaks and ui changes
+
+## 0.1.0-xyd.8
+
+### Patch Changes
+
+- ui tweaks
+
+## 0.1.0-xyd.7
+
+### Patch Changes
+
+- ui tweaks, and some code refactor
+
+## 0.1.0-xyd.6
+
+### Patch Changes
+
+- use react-router 7.1.1
+
+## 0.1.0-xyd.5
+
+### Patch Changes
+
+- another update
+
+## 0.1.0-xyd.4
+
+### Patch Changes
+
+- initial changeset bump

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 xyd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/dist/index.d.mts

@@ -1,5 +1,8 @@
+import React from 'react';
+
 interface FrontMatter {
     title: string | {
+        title: string;
         code: string;
     };
     group?: string[];
@@ -18,7 +21,7 @@ interface Settings {
 }
 interface Styling {
     name: string;
-    logo?: string | Logo | JSX.Element;
+    logo?: string | Logo | React.JSX.Element;
     favicon?: string;
     colors?: Colors;
     theme?: ThemeType;
@@ -110,7 +113,7 @@ interface CallToAction {
     arrow?: boolean;
 }
 interface Anchor {
-    icon?: string | JSX.Element;
+    icon?: string | React.JSX.Element;
     name?: string;
     url?: string;
 }
@@ -136,6 +139,7 @@ interface API {
     info?: APIInfo;
     openapi?: APIFile;
     graphql?: APIFile;
+    sources?: APIFile;
     match?: {
         graphql?: string;
         openapi?: string;

package/dist/index.d.ts

@@ -1,5 +1,8 @@
+import React from 'react';
+
 interface FrontMatter {
     title: string | {
+        title: string;
         code: string;
     };
     group?: string[];
@@ -18,7 +21,7 @@ interface Settings {
 }
 interface Styling {
     name: string;
-    logo?: string | Logo | JSX.Element;
+    logo?: string | Logo | React.JSX.Element;
     favicon?: string;
     colors?: Colors;
     theme?: ThemeType;
@@ -110,7 +113,7 @@ interface CallToAction {
     arrow?: boolean;
 }
 interface Anchor {
-    icon?: string | JSX.Element;
+    icon?: string | React.JSX.Element;
     name?: string;
     url?: string;
 }
@@ -136,6 +139,7 @@ interface API {
     info?: APIInfo;
     openapi?: APIFile;
     graphql?: APIFile;
+    sources?: APIFile;
     match?: {
         graphql?: string;
         openapi?: string;

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@xyd-js/core",
-  "version": "0.1.0-xyd.1",
+  "version": "0.1.0-xyd.10",
   "description": "",
   "main": "./dist/index.js",
   "dependencies": {},
   "devDependencies": {
-    "tsup": "^8.3.0"
+    "tsup": "^8.3.0",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.5.5"
   },
   "scripts": {
     "clean": "rimraf build",

package/src/types/content.ts

@@ -1,5 +1,6 @@
 export interface FrontMatter {
     title: string | {
+        title: string
         code: string // TODO: in the future mechanism similar to codehike
     }
     group?: string[]

package/src/types/settings.ts

@@ -1,3 +1,5 @@
+import React from "react";
+
 export interface Settings {
     // styling configurations for the documentation
     styling?: Styling
@@ -20,7 +22,7 @@ export interface Styling {
 
     // 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.
     // It does not pixelate and the file size is generally smaller.
-    logo?: string | Logo | JSX.Element
+    logo?: string | Logo | React.JSX.Element
 
     // Path to the favicon image. For example: /path/to/favicon.svg
     favicon?: string;
@@ -222,7 +224,7 @@ export interface CallToAction {
 
 export interface Anchor {
     // The Font Awesome or JSX icon used to feature the anchor.
-    icon?: string | JSX.Element
+    icon?: string | React.JSX.Element
 
     // The name of the anchor label.
     name?: string
@@ -274,7 +276,10 @@ export interface API {
     // A string or an array of strings of URL(s) or relative path(s) pointing to your GraphQL file.
     graphql?: APIFile
 
-    // TODO: better in the future?
+    // A string or an array of strings of URL(s) or relative path(s) pointing to your source code folder.
+    sources?: APIFile
+
+    // TODO: better in the future? -> move outside of API ?
     match?: {
         graphql?: string
         openapi?: string