@veluai/velu 0.2.13 → 0.2.15

package/templates/starter/essentials/markdown.mdx

@@ -1,25 +1,25 @@
----
-title: Markdown
-description: Author with Markdown and components.
----
-
-Standard Markdown works everywhere: **bold**, _italic_, `inline code`,
-[links](https://veludocs.com), lists, and tables.
-
-## Components
-
-Drop a component tag right into your Markdown:
-
-<Callout type="warning">
-  Callouts come in `note`, `tip`, `warning`, and `danger` styles.
-</Callout>
-
-<Accordion title="How does MDX work?">
-  Each page compiles to a component that renders identically on the
-  server and the client, so there's no flash of unstyled content.
-</Accordion>
-
-## Headings
-
-Use `##` and `###` for sections — they populate the on-page table of
-contents on the right automatically.
+---
+title: Markdown
+description: Author with Markdown and components.
+---
+
+Standard Markdown works everywhere: **bold**, _italic_, `inline code`,
+[links](https://veludocs.com), lists, and tables.
+
+## Components
+
+Drop a component tag right into your Markdown:
+
+<Callout type="warning">
+  Callouts come in `note`, `tip`, `warning`, and `danger` styles.
+</Callout>
+
+<Accordion title="How does MDX work?">
+  Each page compiles to a component that renders identically on the
+  server and the client, so there's no flash of unstyled content.
+</Accordion>
+
+## Headings
+
+Use `##` and `###` for sections — they populate the on-page table of
+contents on the right automatically.

package/templates/starter/essentials/navigation.mdx

@@ -1,39 +1,39 @@
----
-title: Navigation
-description: Organize your docs with tabs, groups, and pages.
----
-
-`navigation` in `velu.json` is a tree. The pieces, outermost to
-innermost:
-
-- **tabs** — top-level sections in the header (e.g. Guides, API).
-- **groups** — sidebar sections within a tab.
-- **pages** — the page paths in a group; a page may also be a nested
-  group.
-- **anchors** — pinned links (often external) shown above the groups.
-
-```json
-{
-  "navigation": {
-    "tabs": [
-      {
-        "tab": "Guides",
-        "groups": [
-          { "group": "Getting Started", "pages": ["index", "quickstart"] }
-        ]
-      }
-    ]
-  }
-}
-```
-
-<Callout type="note">
-  Sidebar labels come from each page's frontmatter `title` — you don't
-  repeat them in `navigation`.
-</Callout>
-
-## Multiple products, versions, languages
-
-Wrap your tabs in `products`, `versions`, or `languages` to offer a
-switcher. The active non-default choice becomes a URL prefix
-(`/v2/...`, `/fr/...`).
+---
+title: Navigation
+description: Organize your docs with tabs, groups, and pages.
+---
+
+`navigation` in `velu.json` is a tree. The pieces, outermost to
+innermost:
+
+- **tabs** — top-level sections in the header (e.g. Guides, API).
+- **groups** — sidebar sections within a tab.
+- **pages** — the page paths in a group; a page may also be a nested
+  group.
+- **anchors** — pinned links (often external) shown above the groups.
+
+```json
+{
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Guides",
+        "groups": [
+          { "group": "Getting Started", "pages": ["index", "quickstart"] }
+        ]
+      }
+    ]
+  }
+}
+```
+
+<Callout type="note">
+  Sidebar labels come from each page's frontmatter `title` — you don't
+  repeat them in `navigation`.
+</Callout>
+
+## Multiple products, versions, languages
+
+Wrap your tabs in `products`, `versions`, or `languages` to offer a
+switcher. The active non-default choice becomes a URL prefix
+(`/v2/...`, `/fr/...`).

package/templates/starter/essentials/settings.mdx

@@ -1,30 +1,30 @@
----
-title: Settings
-description: Theme your site through velu.json.
----
-
-Your site's look comes from a few top-level keys in `velu.json`.
-
-```json
-{
-  "name": "Acme Docs",
-  "colors": { "primary": "#16a34a", "light": "#07c983", "dark": "#15803d" },
-  "favicon": "/favicon.svg",
-  "font": { "family": "Inter" }
-}
-```
-
-## Colors
-
-`colors.primary` sets the accent used across the UI. `light` and
-`dark` override it per theme; both default to `primary`.
-
-## Font
-
-`font.family` is any Google Font family — it's loaded automatically and
-applied as the body font.
-
-<Callout type="tip">
-  `favicon` is a path relative to your project root, e.g.
-  `/favicon.svg`.
-</Callout>
+---
+title: Settings
+description: Theme your site through velu.json.
+---
+
+Your site's look comes from a few top-level keys in `velu.json`.
+
+```json
+{
+  "name": "Acme Docs",
+  "colors": { "primary": "#16a34a", "light": "#07c983", "dark": "#15803d" },
+  "favicon": "/favicon.svg",
+  "font": { "family": "Inter" }
+}
+```
+
+## Colors
+
+`colors.primary` sets the accent used across the UI. `light` and
+`dark` override it per theme; both default to `primary`.
+
+## Font
+
+`font.family` is any Google Font family — it's loaded automatically and
+applied as the body font.
+
+<Callout type="tip">
+  `favicon` is a path relative to your project root, e.g.
+  `/favicon.svg`.
+</Callout>

package/templates/starter/favicon.svg

@@ -1,6 +1,6 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
-  <rect width="32" height="32" rx="7" fill="#dc143c" />
-  <g transform="translate(5.6 8.2) scale(0.65)" fill="#ffffff">
-    <path fill-rule="evenodd" clip-rule="evenodd" d="M29.6564 14.1534C29.5739 14.5616 29.3507 14.9288 29.0248 15.1926C28.699 15.4565 28.2907 15.6007 27.8694 15.6006H21.3702C20.5341 15.6006 19.8051 16.1627 19.6031 16.9638L18.1671 22.6368C18.0685 23.0263 17.8409 23.372 17.5205 23.619C17.2002 23.866 16.8054 24.0001 16.399 24H10.4378C10.1609 24.0001 9.88759 23.9378 9.63868 23.8179C9.38976 23.6979 9.1718 23.5235 9.00135 23.3079C8.8309 23.0923 8.71245 22.8412 8.65499 22.5736C8.59754 22.306 8.6026 22.029 8.66978 21.7636L10.1888 15.7636C10.2874 15.3743 10.5148 15.0287 10.835 14.7817C11.1551 14.5347 11.5496 14.4005 11.9559 14.4004H18.3931C19.2621 14.4004 20.0101 13.7949 20.1801 12.9532L22.3882 2.04774C22.4705 1.63945 22.6936 1.27198 23.0195 1.00793C23.3453 0.74388 23.7538 0.599578 24.1752 0.599605H30.1774C30.4471 0.599529 30.7134 0.658587 30.9572 0.772515C31.201 0.886444 31.4161 1.0524 31.5871 1.25842C31.758 1.46443 31.8806 1.70537 31.9458 1.96383C32.0111 2.2223 32.0175 2.49185 31.9645 2.75305L29.6564 14.1534ZM9.61081 13.5538C9.52825 13.962 9.30507 14.3292 8.97924 14.593C8.65341 14.857 8.24508 15.0011 7.82375 15.001H1.82257C1.55289 15.0011 1.28656 14.942 1.04279 14.8281C0.79902 14.7141 0.583892 14.5482 0.412928 14.3422C0.241965 14.1362 0.11943 13.8952 0.0541639 13.6368C-0.0111017 13.3783 -0.0174699 13.1087 0.0355186 12.8475L2.34359 1.44715C2.42614 1.03904 2.64933 0.671798 2.97516 0.407944C3.30099 0.144089 3.70932 -0.00007 4.13064 0H10.1318C10.4015 -0.00008 10.6678 0.0589818 10.9116 0.172911C11.1554 0.286839 11.3705 0.453799 11.5415 0.659813C11.7124 0.864828 11.835 1.10576 11.9002 1.36423C11.9655 1.62269 11.9719 1.89225 11.9189 2.15344L9.61081 13.5538Z" />
-  </g>
-</svg>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
+  <rect width="32" height="32" rx="7" fill="#dc143c" />
+  <g transform="translate(5.6 8.2) scale(0.65)" fill="#ffffff">
+    <path fill-rule="evenodd" clip-rule="evenodd" d="M29.6564 14.1534C29.5739 14.5616 29.3507 14.9288 29.0248 15.1926C28.699 15.4565 28.2907 15.6007 27.8694 15.6006H21.3702C20.5341 15.6006 19.8051 16.1627 19.6031 16.9638L18.1671 22.6368C18.0685 23.0263 17.8409 23.372 17.5205 23.619C17.2002 23.866 16.8054 24.0001 16.399 24H10.4378C10.1609 24.0001 9.88759 23.9378 9.63868 23.8179C9.38976 23.6979 9.1718 23.5235 9.00135 23.3079C8.8309 23.0923 8.71245 22.8412 8.65499 22.5736C8.59754 22.306 8.6026 22.029 8.66978 21.7636L10.1888 15.7636C10.2874 15.3743 10.5148 15.0287 10.835 14.7817C11.1551 14.5347 11.5496 14.4005 11.9559 14.4004H18.3931C19.2621 14.4004 20.0101 13.7949 20.1801 12.9532L22.3882 2.04774C22.4705 1.63945 22.6936 1.27198 23.0195 1.00793C23.3453 0.74388 23.7538 0.599578 24.1752 0.599605H30.1774C30.4471 0.599529 30.7134 0.658587 30.9572 0.772515C31.201 0.886444 31.4161 1.0524 31.5871 1.25842C31.758 1.46443 31.8806 1.70537 31.9458 1.96383C32.0111 2.2223 32.0175 2.49185 31.9645 2.75305L29.6564 14.1534ZM9.61081 13.5538C9.52825 13.962 9.30507 14.3292 8.97924 14.593C8.65341 14.857 8.24508 15.0011 7.82375 15.001H1.82257C1.55289 15.0011 1.28656 14.942 1.04279 14.8281C0.79902 14.7141 0.583892 14.5482 0.412928 14.3422C0.241965 14.1362 0.11943 13.8952 0.0541639 13.6368C-0.0111017 13.3783 -0.0174699 13.1087 0.0355186 12.8475L2.34359 1.44715C2.42614 1.03904 2.64933 0.671798 2.97516 0.407944C3.30099 0.144089 3.70932 -0.00007 4.13064 0H10.1318C10.4015 -0.00008 10.6678 0.0589818 10.9116 0.172911C11.1554 0.286839 11.3705 0.453799 11.5415 0.659813C11.7124 0.864828 11.835 1.10576 11.9002 1.36423C11.9655 1.62269 11.9719 1.89225 11.9189 2.15344L9.61081 13.5538Z" />
+  </g>
+</svg>

package/templates/starter/index.mdx

@@ -1,31 +1,31 @@
----
-title: Introduction
-description: Welcome to your Velu documentation site.
----
-
-This is your new documentation site, rendered by **Velu** from plain
-Markdown and a `velu.json` config. The sidebar, tabs, and page order
-all come from the `navigation` block — edit it and the site updates on
-save.
-
-<Callout type="tip">
-  Page paths in `navigation` are relative to the project root with no
-  extension: `"essentials/markdown"` renders `essentials/markdown.mdx`.
-</Callout>
-
-## Get going
-
-<CardGroup>
-  <Card title="Quickstart" icon="rocket" href="/quickstart">
-    Run the dev server and make your first edit.
-  </Card>
-  <Card title="Customize" icon="sliders-horizontal" href="/essentials/settings">
-    Set your colors, font, and favicon.
-  </Card>
-  <Card title="Write content" icon="pen-line" href="/essentials/markdown">
-    Markdown plus a library of components.
-  </Card>
-  <Card title="API reference" icon="terminal" href="/api-reference/introduction">
-    Document your endpoints.
-  </Card>
-</CardGroup>
+---
+title: Introduction
+description: Welcome to your Velu documentation site.
+---
+
+This is your new documentation site, rendered by **Velu** from plain
+Markdown and a `velu.json` config. The sidebar, tabs, and page order
+all come from the `navigation` block — edit it and the site updates on
+save.
+
+<Callout type="tip">
+  Page paths in `navigation` are relative to the project root with no
+  extension: `"essentials/markdown"` renders `essentials/markdown.mdx`.
+</Callout>
+
+## Get going
+
+<CardGroup>
+  <Card title="Quickstart" icon="rocket" href="/quickstart">
+    Run the dev server and make your first edit.
+  </Card>
+  <Card title="Customize" icon="sliders-horizontal" href="/essentials/settings">
+    Set your colors, font, and favicon.
+  </Card>
+  <Card title="Write content" icon="pen-line" href="/essentials/markdown">
+    Markdown plus a library of components.
+  </Card>
+  <Card title="API reference" icon="terminal" href="/api-reference/introduction">
+    Document your endpoints.
+  </Card>
+</CardGroup>

package/templates/starter/openapi.json

@@ -1,160 +1,160 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "Product Catalog API",
-    "version": "1.0.0",
-    "description": "A friendly, fully-hosted example API — a product catalog backed by the live https://dummyjson.com service. Every operation hits the real API: list, search, fetch, create, update and delete products and see real responses."
-  },
-  "servers": [{ "url": "https://dummyjson.com" }],
-  "tags": [{ "name": "Products", "description": "Browse and manage the product catalog." }],
-  "paths": {
-    "/products": {
-      "get": {
-        "operationId": "listProducts",
-        "summary": "List products",
-        "description": "List products, with optional pagination.",
-        "tags": ["Products"],
-        "parameters": [
-          { "name": "limit", "in": "query", "schema": { "type": "integer" }, "description": "How many products to return (0 returns all)." },
-          { "name": "skip", "in": "query", "schema": { "type": "integer" }, "description": "How many products to skip (for pagination)." }
-        ],
-        "responses": {
-          "200": {
-            "description": "A page of products.",
-            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } }
-          }
-        }
-      }
-    },
-    "/products/search": {
-      "get": {
-        "operationId": "searchProducts",
-        "summary": "Search products",
-        "description": "Search the catalog by a free-text query.",
-        "tags": ["Products"],
-        "parameters": [
-          { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The search query (try `phone`)." }
-        ],
-        "responses": {
-          "200": {
-            "description": "Matching products.",
-            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } }
-          }
-        }
-      }
-    },
-    "/products/{id}": {
-      "get": {
-        "operationId": "getProduct",
-        "summary": "Get a product",
-        "description": "Retrieve a single product by its id.",
-        "tags": ["Products"],
-        "parameters": [
-          { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The product id (try `1`)." }
-        ],
-        "responses": {
-          "200": {
-            "description": "The product.",
-            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
-          }
-        }
-      },
-      "put": {
-        "operationId": "updateProduct",
-        "summary": "Update a product",
-        "description": "Update fields on an existing product. (Simulated by the upstream API — the response reflects the change but nothing is persisted.)",
-        "tags": ["Products"],
-        "parameters": [
-          { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The product id." }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInput" } } }
-        },
-        "responses": {
-          "200": {
-            "description": "The updated product.",
-            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
-          }
-        }
-      },
-      "delete": {
-        "operationId": "deleteProduct",
-        "summary": "Delete a product",
-        "description": "Delete a product by its id. (Simulated — the response includes `isDeleted` and `deletedOn`.)",
-        "tags": ["Products"],
-        "parameters": [
-          { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The product id." }
-        ],
-        "responses": {
-          "200": {
-            "description": "The deleted product.",
-            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
-          }
-        }
-      }
-    },
-    "/products/add": {
-      "post": {
-        "operationId": "addProduct",
-        "summary": "Add a product",
-        "description": "Create a new product. (Simulated — the response echoes the body with a fresh `id`.)",
-        "tags": ["Products"],
-        "requestBody": {
-          "required": true,
-          "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInput" } } }
-        },
-        "responses": {
-          "201": {
-            "description": "The created product.",
-            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "Product": {
-        "type": "object",
-        "properties": {
-          "id": { "type": "integer", "description": "Unique identifier." },
-          "title": { "type": "string", "description": "Product name." },
-          "description": { "type": "string", "description": "Product description." },
-          "category": { "type": "string", "description": "Category slug." },
-          "price": { "type": "number", "description": "Price in USD." },
-          "discountPercentage": { "type": "number", "description": "Discount, as a percentage." },
-          "rating": { "type": "number", "description": "Average customer rating (0–5)." },
-          "stock": { "type": "integer", "description": "Units in stock." },
-          "brand": { "type": "string", "description": "Brand name." },
-          "thumbnail": { "type": "string", "description": "Thumbnail image URL." }
-        }
-      },
-      "ProductList": {
-        "type": "object",
-        "properties": {
-          "products": { "type": "array", "description": "The products on this page.", "items": { "$ref": "#/components/schemas/Product" } },
-          "total": { "type": "integer", "description": "Total number of matching products." },
-          "skip": { "type": "integer", "description": "How many were skipped." },
-          "limit": { "type": "integer", "description": "How many were returned." }
-        }
-      },
-      "ProductInput": {
-        "type": "object",
-        "required": ["title"],
-        "properties": {
-          "title": { "type": "string", "description": "Product name." },
-          "description": { "type": "string", "description": "Product description." },
-          "category": { "type": "string", "description": "Category slug." },
-          "price": { "type": "number", "description": "Price in USD." }
-        },
-        "example": {
-          "title": "Velu Notebook",
-          "description": "A dotted-grid notebook for docs notes.",
-          "category": "stationery",
-          "price": 19.99
-        }
-      }
-    }
-  }
-}
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Product Catalog API",
+    "version": "1.0.0",
+    "description": "A friendly, fully-hosted example API — a product catalog backed by the live https://dummyjson.com service. Every operation hits the real API: list, search, fetch, create, update and delete products and see real responses."
+  },
+  "servers": [{ "url": "https://dummyjson.com" }],
+  "tags": [{ "name": "Products", "description": "Browse and manage the product catalog." }],
+  "paths": {
+    "/products": {
+      "get": {
+        "operationId": "listProducts",
+        "summary": "List products",
+        "description": "List products, with optional pagination.",
+        "tags": ["Products"],
+        "parameters": [
+          { "name": "limit", "in": "query", "schema": { "type": "integer" }, "description": "How many products to return (0 returns all)." },
+          { "name": "skip", "in": "query", "schema": { "type": "integer" }, "description": "How many products to skip (for pagination)." }
+        ],
+        "responses": {
+          "200": {
+            "description": "A page of products.",
+            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } }
+          }
+        }
+      }
+    },
+    "/products/search": {
+      "get": {
+        "operationId": "searchProducts",
+        "summary": "Search products",
+        "description": "Search the catalog by a free-text query.",
+        "tags": ["Products"],
+        "parameters": [
+          { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "description": "The search query (try `phone`)." }
+        ],
+        "responses": {
+          "200": {
+            "description": "Matching products.",
+            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } }
+          }
+        }
+      }
+    },
+    "/products/{id}": {
+      "get": {
+        "operationId": "getProduct",
+        "summary": "Get a product",
+        "description": "Retrieve a single product by its id.",
+        "tags": ["Products"],
+        "parameters": [
+          { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The product id (try `1`)." }
+        ],
+        "responses": {
+          "200": {
+            "description": "The product.",
+            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
+          }
+        }
+      },
+      "put": {
+        "operationId": "updateProduct",
+        "summary": "Update a product",
+        "description": "Update fields on an existing product. (Simulated by the upstream API — the response reflects the change but nothing is persisted.)",
+        "tags": ["Products"],
+        "parameters": [
+          { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The product id." }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInput" } } }
+        },
+        "responses": {
+          "200": {
+            "description": "The updated product.",
+            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteProduct",
+        "summary": "Delete a product",
+        "description": "Delete a product by its id. (Simulated — the response includes `isDeleted` and `deletedOn`.)",
+        "tags": ["Products"],
+        "parameters": [
+          { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The product id." }
+        ],
+        "responses": {
+          "200": {
+            "description": "The deleted product.",
+            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
+          }
+        }
+      }
+    },
+    "/products/add": {
+      "post": {
+        "operationId": "addProduct",
+        "summary": "Add a product",
+        "description": "Create a new product. (Simulated — the response echoes the body with a fresh `id`.)",
+        "tags": ["Products"],
+        "requestBody": {
+          "required": true,
+          "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInput" } } }
+        },
+        "responses": {
+          "201": {
+            "description": "The created product.",
+            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Product": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "description": "Unique identifier." },
+          "title": { "type": "string", "description": "Product name." },
+          "description": { "type": "string", "description": "Product description." },
+          "category": { "type": "string", "description": "Category slug." },
+          "price": { "type": "number", "description": "Price in USD." },
+          "discountPercentage": { "type": "number", "description": "Discount, as a percentage." },
+          "rating": { "type": "number", "description": "Average customer rating (0–5)." },
+          "stock": { "type": "integer", "description": "Units in stock." },
+          "brand": { "type": "string", "description": "Brand name." },
+          "thumbnail": { "type": "string", "description": "Thumbnail image URL." }
+        }
+      },
+      "ProductList": {
+        "type": "object",
+        "properties": {
+          "products": { "type": "array", "description": "The products on this page.", "items": { "$ref": "#/components/schemas/Product" } },
+          "total": { "type": "integer", "description": "Total number of matching products." },
+          "skip": { "type": "integer", "description": "How many were skipped." },
+          "limit": { "type": "integer", "description": "How many were returned." }
+        }
+      },
+      "ProductInput": {
+        "type": "object",
+        "required": ["title"],
+        "properties": {
+          "title": { "type": "string", "description": "Product name." },
+          "description": { "type": "string", "description": "Product description." },
+          "category": { "type": "string", "description": "Category slug." },
+          "price": { "type": "number", "description": "Price in USD." }
+        },
+        "example": {
+          "title": "Velu Notebook",
+          "description": "A dotted-grid notebook for docs notes.",
+          "category": "stationery",
+          "price": 19.99
+        }
+      }
+    }
+  }
+}