@veluai/velu 0.1.13 → 0.1.15

package/schema/velu.schema.json

@@ -1,167 +1,281 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://veludocs.com/velu.schema.json",
-  "title": "Velu project configuration",
-  "description": "Configuration for a Velu documentation project (velu.json). This schema is defined internally during iteration; it will be hosted at the $id URL so editors can validate + autocomplete velu.json files.",
-  "type": "object",
-  "required": ["name"],
-  "additionalProperties": false,
-  "properties": {
-    "$schema": {
-      "type": "string",
-      "description": "URL of this JSON Schema, enabling editor validation + autocomplete."
-    },
-    "name": {
-      "type": "string",
-      "description": "Project name; usually the folder name it's contained in.",
-      "minLength": 1
-    },
-    "colors": {
-      "type": "object",
-      "description": "Accent colors. Maps onto the --accent-color token in base.css.",
-      "additionalProperties": false,
-      "required": ["primary"],
-      "properties": {
-        "primary": {
-          "type": "string",
-          "description": "The accent color used across the UI (--accent-color)."
-        },
-        "light": {
-          "type": "string",
-          "description": "Light-mode accent override. Defaults to `primary`."
-        },
-        "dark": {
-          "type": "string",
-          "description": "Dark-mode accent override. Defaults to `primary`."
-        }
-      }
-    },
-    "favicon": {
-      "type": "string",
-      "description": "Path to the favicon, relative to the project root."
-    },
-    "font": {
-      "type": "object",
-      "description": "Typography. Maps onto the --font-sans token in base.css.",
-      "additionalProperties": false,
-      "required": ["family"],
-      "properties": {
-        "family": {
-          "type": "string",
-          "description": "Google Font family to use (--font-sans)."
-        }
-      }
-    },
-    "navigation": {
-      "$ref": "#/$defs/navContainer",
-      "description": "Site navigation. Mintlify-compatible: products > versions > languages > tabs > groups > pages. Switchable axes (product/version/language) become URL path prefixes; the default value of each is unprefixed. Dropdowns are intentionally unsupported."
-    }
-  },
-  "$defs": {
-    "navContainer": {
-      "type": "object",
-      "additionalProperties": false,
-      "description": "A navigation container. Higher-precedence keys nest the lower ones (products contain versions contain languages contain tabs contain groups/pages).",
-      "properties": {
-        "products": { "type": "array", "items": { "$ref": "#/$defs/product" } },
-        "versions": { "type": "array", "items": { "$ref": "#/$defs/version" } },
-        "languages": { "type": "array", "items": { "$ref": "#/$defs/language" } },
-        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
-        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
-        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
-        "pages": { "$ref": "#/$defs/pages" }
-      }
-    },
-    "pages": {
-      "type": "array",
-      "description": "Ordered list of page paths (no extension, relative to the project root) and/or nested groups.",
-      "items": {
-        "oneOf": [
-          { "type": "string" },
-          { "$ref": "#/$defs/group" }
-        ]
-      }
-    },
-    "group": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["group"],
-      "properties": {
-        "group": { "type": "string", "description": "Sidebar section heading." },
-        "icon": { "type": "string", "description": "lucide icon id." },
-        "expanded": { "type": "boolean", "description": "Start expanded." },
-        "root": { "type": "string", "description": "Landing page path for the group." },
-        "pages": { "$ref": "#/$defs/pages" }
-      }
-    },
-    "tab": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["tab"],
-      "properties": {
-        "tab": { "type": "string", "description": "Tab label (top nav)." },
-        "icon": { "type": "string" },
-        "href": { "type": "string", "description": "External/override link instead of in-site pages." },
-        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
-        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
-        "pages": { "$ref": "#/$defs/pages" }
-      }
-    },
-    "anchor": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["anchor", "href"],
-      "properties": {
-        "anchor": { "type": "string", "description": "Anchor label (pinned sidebar link)." },
-        "icon": { "type": "string" },
-        "href": { "type": "string" },
-        "color": { "type": "string" }
-      }
-    },
-    "product": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["product"],
-      "properties": {
-        "product": { "type": "string", "description": "Product id (used for the URL slug)." },
-        "name": { "type": "string", "description": "Display name; defaults to `product`." },
-        "icon": { "type": "string" },
-        "color": { "type": "string" },
-        "default": { "type": "boolean", "description": "The default product is unprefixed in URLs." },
-        "versions": { "type": "array", "items": { "$ref": "#/$defs/version" } },
-        "languages": { "type": "array", "items": { "$ref": "#/$defs/language" } },
-        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
-        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
-        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
-        "pages": { "$ref": "#/$defs/pages" }
-      }
-    },
-    "version": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["version"],
-      "properties": {
-        "version": { "type": "string", "description": "Version label (used for the URL slug)." },
-        "default": { "type": "boolean", "description": "The default version is unprefixed in URLs." },
-        "languages": { "type": "array", "items": { "$ref": "#/$defs/language" } },
-        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
-        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
-        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
-        "pages": { "$ref": "#/$defs/pages" }
-      }
-    },
-    "language": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["language"],
-      "properties": {
-        "language": { "type": "string", "description": "Language code (used for the URL slug)." },
-        "default": { "type": "boolean", "description": "The default language is unprefixed in URLs." },
-        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
-        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
-        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
-        "pages": { "$ref": "#/$defs/pages" }
-      }
-    }
-  }
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://veludocs.com/velu.schema.json",
+  "title": "Velu project configuration",
+  "description": "Configuration for a Velu documentation project (velu.json). This schema is defined internally during iteration; it will be hosted at the $id URL so editors can validate + autocomplete velu.json files.",
+  "type": "object",
+  "required": ["name"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "URL of this JSON Schema, enabling editor validation + autocomplete."
+    },
+    "name": {
+      "type": "string",
+      "description": "Project name; usually the folder name it's contained in.",
+      "minLength": 1
+    },
+    "colors": {
+      "type": "object",
+      "description": "Accent colors. Maps onto the --accent-color token in base.css.",
+      "additionalProperties": false,
+      "required": ["primary"],
+      "properties": {
+        "primary": {
+          "type": "string",
+          "description": "The accent color used across the UI (--accent-color)."
+        },
+        "light": {
+          "type": "string",
+          "description": "Light-mode accent override. Defaults to `primary`."
+        },
+        "dark": {
+          "type": "string",
+          "description": "Dark-mode accent override. Defaults to `primary`."
+        }
+      }
+    },
+    "favicon": {
+      "type": "string",
+      "description": "Path to the favicon, relative to the project root."
+    },
+    "logo": {
+      "description": "Site logo shown in the header, replacing the name wordmark. A single path used in both themes, or per-theme light/dark images with an optional click-through href. Paths are relative to the project root.",
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1,
+          "description": "Logo path used in both light and dark mode."
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["light", "dark"],
+          "properties": {
+            "light": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Logo shown in light mode."
+            },
+            "dark": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Logo shown in dark mode."
+            },
+            "href": {
+              "type": "string",
+              "description": "Where clicking the logo links. Defaults to the site root."
+            }
+          }
+        }
+      ]
+    },
+    "navbar": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The header's top-right area: secondary links plus a primary CTA button.",
+      "properties": {
+        "links": {
+          "type": "array",
+          "description": "Secondary header links (to the left of the primary CTA).",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["href"],
+            "properties": {
+              "label": { "type": "string", "description": "Link text." },
+              "href": { "type": "string", "description": "Link URL." },
+              "icon": { "type": "string", "description": "lucide icon id." }
+            }
+          }
+        },
+        "primary": {
+          "description": "The prominent CTA button at the far right.",
+          "oneOf": [
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["type", "label", "href"],
+              "properties": {
+                "type": { "const": "button" },
+                "label": { "type": "string", "description": "Button text." },
+                "href": { "type": "string", "description": "Button URL." }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["type", "href"],
+              "properties": {
+                "type": { "const": "github" },
+                "href": { "type": "string", "description": "GitHub repository URL." },
+                "label": { "type": "string", "description": "Button text (default \"GitHub\")." }
+              }
+            }
+          ]
+        }
+      }
+    },
+    "footer": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "Site footer. With `links`, a full footer section renders; with only `socials`, the icons sit next to the \"Powered by\" line instead.",
+      "properties": {
+        "socials": {
+          "type": "object",
+          "description": "Social links as platform → URL. Recognized icons: github, x (or twitter), youtube, linkedin.",
+          "additionalProperties": { "type": "string" }
+        },
+        "links": {
+          "type": "array",
+          "description": "Footer link columns (max 4).",
+          "maxItems": 4,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["header", "items"],
+            "properties": {
+              "header": { "type": "string", "description": "Column heading." },
+              "items": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "additionalProperties": false,
+                  "required": ["label", "href"],
+                  "properties": {
+                    "label": { "type": "string", "description": "Link text." },
+                    "href": { "type": "string", "description": "Link URL." }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "font": {
+      "type": "object",
+      "description": "Typography. Maps onto the --font-sans token in base.css.",
+      "additionalProperties": false,
+      "required": ["family"],
+      "properties": {
+        "family": {
+          "type": "string",
+          "description": "Google Font family to use (--font-sans)."
+        }
+      }
+    },
+    "navigation": {
+      "$ref": "#/$defs/navContainer",
+      "description": "Site navigation. Mintlify-compatible: products > versions > languages > tabs > groups > pages. Switchable axes (product/version/language) become URL path prefixes; the default value of each is unprefixed. Dropdowns are intentionally unsupported."
+    }
+  },
+  "$defs": {
+    "navContainer": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "A navigation container. Higher-precedence keys nest the lower ones (products contain versions contain languages contain tabs contain groups/pages).",
+      "properties": {
+        "products": { "type": "array", "items": { "$ref": "#/$defs/product" } },
+        "versions": { "type": "array", "items": { "$ref": "#/$defs/version" } },
+        "languages": { "type": "array", "items": { "$ref": "#/$defs/language" } },
+        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
+        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
+        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
+        "pages": { "$ref": "#/$defs/pages" }
+      }
+    },
+    "pages": {
+      "type": "array",
+      "description": "Ordered list of page paths (no extension, relative to the project root) and/or nested groups.",
+      "items": {
+        "oneOf": [
+          { "type": "string" },
+          { "$ref": "#/$defs/group" }
+        ]
+      }
+    },
+    "group": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["group"],
+      "properties": {
+        "group": { "type": "string", "description": "Sidebar section heading." },
+        "icon": { "type": "string", "description": "lucide icon id." },
+        "expanded": { "type": "boolean", "description": "Start expanded." },
+        "root": { "type": "string", "description": "Landing page path for the group." },
+        "pages": { "$ref": "#/$defs/pages" }
+      }
+    },
+    "tab": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["tab"],
+      "properties": {
+        "tab": { "type": "string", "description": "Tab label (top nav)." },
+        "icon": { "type": "string" },
+        "href": { "type": "string", "description": "External/override link instead of in-site pages." },
+        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
+        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
+        "pages": { "$ref": "#/$defs/pages" }
+      }
+    },
+    "anchor": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["anchor", "href"],
+      "properties": {
+        "anchor": { "type": "string", "description": "Anchor label (pinned sidebar link)." },
+        "icon": { "type": "string" },
+        "href": { "type": "string" },
+        "color": { "type": "string" }
+      }
+    },
+    "product": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["product"],
+      "properties": {
+        "product": { "type": "string", "description": "Product id (used for the URL slug)." },
+        "name": { "type": "string", "description": "Display name; defaults to `product`." },
+        "icon": { "type": "string" },
+        "color": { "type": "string" },
+        "default": { "type": "boolean", "description": "The default product is unprefixed in URLs." },
+        "versions": { "type": "array", "items": { "$ref": "#/$defs/version" } },
+        "languages": { "type": "array", "items": { "$ref": "#/$defs/language" } },
+        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
+        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
+        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
+        "pages": { "$ref": "#/$defs/pages" }
+      }
+    },
+    "version": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version"],
+      "properties": {
+        "version": { "type": "string", "description": "Version label (used for the URL slug)." },
+        "default": { "type": "boolean", "description": "The default version is unprefixed in URLs." },
+        "languages": { "type": "array", "items": { "$ref": "#/$defs/language" } },
+        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
+        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
+        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
+        "pages": { "$ref": "#/$defs/pages" }
+      }
+    },
+    "language": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["language"],
+      "properties": {
+        "language": { "type": "string", "description": "Language code (used for the URL slug)." },
+        "default": { "type": "boolean", "description": "The default language is unprefixed in URLs." },
+        "tabs": { "type": "array", "items": { "$ref": "#/$defs/tab" } },
+        "anchors": { "type": "array", "items": { "$ref": "#/$defs/anchor" } },
+        "groups": { "type": "array", "items": { "$ref": "#/$defs/group" } },
+        "pages": { "$ref": "#/$defs/pages" }
+      }
+    }
+  }
+}