@veluai/velu 0.2.25 → 0.2.28

package/README.md

@@ -1,80 +1,80 @@
-# Velu
-
-A documentation-site generator with live preview. Scaffold a docs project
-and run it locally with two commands — author your pages in Markdown +
-components, configure the site with a single `velu.json`.
-
-```bash
-npm install -g @veluai/velu
-velu init my-docs
-velu dev my-docs
-```
-
-Then open <http://localhost:8358>. Editing any `.mdx` page or `velu.json`
-reloads the browser automatically.
-
-> Requires **Node.js 18+**. Prefer not to install globally? Use
-> `npx @veluai/velu init my-docs` and `npx @veluai/velu dev my-docs`.
-
-## Commands
-
-| Command | What it does |
-| --- | --- |
-| `velu init <dir>` | Scaffold a new docs project into `<dir>` (creates `velu.json`, a favicon, and a set of starter `.mdx` pages). |
-| `velu dev [dir]` | Start the live-preview dev server for the project in `<dir>` (defaults to the current directory). |
-
-Set a custom port with the `PORT` env var:
-
-```bash
-PORT=5180 velu dev my-docs
-```
-
-## Project layout
-
-`velu init` produces a project shaped like this:
-
-```
-my-docs/
-├─ velu.json          # site config: name, colors, font, favicon, navigation
-├─ favicon.svg
-├─ index.mdx          # pages, organized however your navigation references them
-├─ quickstart.mdx
-└─ …
-```
-
-## `velu.json`
-
-`velu.json` drives the whole site — branding and navigation:
-
-```json
-{
-  "$schema": "https://veluai.com/velu.schema.json",
-  "name": "My Docs",
-  "colors": { "primary": "#dc143c" },
-  "favicon": "/favicon.svg",
-  "font": { "family": "Inter" },
-  "navigation": {
-    "tabs": [
-      {
-        "tab": "Guides",
-        "groups": [
-          { "group": "Getting started", "pages": ["index", "quickstart"] }
-        ]
-      }
-    ]
-  }
-}
-```
-
-- **`colors`** — `primary` is required; `light` and `dark` default to `primary`.
-- **`navigation`** — Mintlify-compatible: `products → versions → languages →
-  tabs → anchors → groups → pages`. Switchable axes (products, versions,
-  languages) become URL path prefixes; the default value of each axis is
-  unprefixed. Languages are stored as ISO 639-1 codes and shown with their
-  native name.
-
-Page labels come from each page's frontmatter `title`.
-
-## License
-
-Proprietary. © Velu.
+# Velu
+
+A documentation-site generator with live preview. Scaffold a docs project
+and run it locally with two commands — author your pages in Markdown +
+components, configure the site with a single `velu.json`.
+
+```bash
+npm install -g @veluai/velu
+velu init my-docs
+velu dev my-docs
+```
+
+Then open <http://localhost:8358>. Editing any `.mdx` page or `velu.json`
+reloads the browser automatically.
+
+> Requires **Node.js 18+**. Prefer not to install globally? Use
+> `npx @veluai/velu init my-docs` and `npx @veluai/velu dev my-docs`.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `velu init <dir>` | Scaffold a new docs project into `<dir>` (creates `velu.json`, a favicon, and a set of starter `.mdx` pages). |
+| `velu dev [dir]` | Start the live-preview dev server for the project in `<dir>` (defaults to the current directory). |
+
+Set a custom port with the `PORT` env var:
+
+```bash
+PORT=5180 velu dev my-docs
+```
+
+## Project layout
+
+`velu init` produces a project shaped like this:
+
+```
+my-docs/
+├─ velu.json          # site config: name, colors, font, favicon, navigation
+├─ favicon.svg
+├─ index.mdx          # pages, organized however your navigation references them
+├─ quickstart.mdx
+└─ …
+```
+
+## `velu.json`
+
+`velu.json` drives the whole site — branding and navigation:
+
+```json
+{
+  "$schema": "https://veluai.com/velu.schema.json",
+  "name": "My Docs",
+  "colors": { "primary": "#dc143c" },
+  "favicon": "/favicon.svg",
+  "font": { "family": "Inter" },
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Guides",
+        "groups": [
+          { "group": "Getting started", "pages": ["index", "quickstart"] }
+        ]
+      }
+    ]
+  }
+}
+```
+
+- **`colors`** — `primary` is required; `light` and `dark` default to `primary`.
+- **`navigation`** — Mintlify-compatible: `products → versions → languages →
+  tabs → anchors → groups → pages`. Switchable axes (products, versions,
+  languages) become URL path prefixes; the default value of each axis is
+  unprefixed. Languages are stored as ISO 639-1 codes and shown with their
+  native name.
+
+Page labels come from each page's frontmatter `title`.
+
+## License
+
+Proprietary. © Velu.