@veluai/velu 0.2.35 → 0.2.37

package/README.md

@@ -21,6 +21,7 @@ reloads the browser automatically.
 | 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 migrate mintlify [dir]` | Migrate Mintlify docs into a new directory; supports `--out`, `--dry-run`, `--strict`, and `--json`. |
 | `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:
@@ -29,6 +30,22 @@ Set a custom port with the `PORT` env var:
 PORT=5180 velu dev my-docs
 ```
 
+## Migrate from Mintlify
+
+```bash
+velu migrate mintlify ./mintlify-docs --out ./velu-docs --dry-run
+velu migrate mintlify ./mintlify-docs --out ./velu-docs
+```
+
+The source stays untouched. Configuration, MDX, snippets, custom CSS/JavaScript,
+assets, and supported npm scripts are migrated, with JSON and Markdown reports
+for anything requiring review. See the [migration guide](docs/mintlify-migration.md)
+for coverage, exit codes, and runtime limitations.
+
+Set `"theme": "vepa"` in `velu.json` for the Vepa preset. Migration
+maps Mintlify’s `sequoia` setting to `vepa` automatically. See [Vepa compatibility](docs/vepa.md)
+for the pinned Mintlify reference, verified geometry, and remaining parity limits.
+
 ## Project layout
 
 `velu init` produces a project shaped like this:
@@ -75,6 +92,45 @@ my-docs/
 
 Page labels come from each page's frontmatter `title`.
 
+## Custom CSS and JavaScript
+
+Every `.css` and `.js` file in the project folder (at any depth) is included on
+every page — nothing to configure. CSS is linked after the theme so your rules
+win; JS runs once per page load, after the page has hydrated. Dot-folders,
+`node_modules/`, `public/` and the build output are skipped.
+
+MDX also supports Tailwind utility classes on HTML elements
+(`className="w-full rounded-xl"`, `dark:hidden`, …) — they are scanned from the
+project and generated into the theme stylesheet.
+
+Selectors follow Mintlify's, so Mintlify custom CSS ports over:
+
+- **Ids** on the layout — `#navbar`, `#sidebar`, `#sidebar-content`, `#content`,
+  `#content-area`, `#table-of-contents`, `#pagination`, `#footer`,
+  `#search-bar-entry`, `#search-input`, `#assistant-entry`, `#topbar-cta-button`,
+  `#page-context-menu`, `#chat-assistant-sheet`, `#feedback-*`, `#request-example`,
+  `#response-example`, `#changelog-filters`, `#localization-select-*`, …
+- **Element selectors** — components render as the same tags Mintlify uses, so
+  `card { }`, `callout { }`, `code-block { }`, `steps { }`, `toc-item { }`,
+  `sidebar-group { }`, `mdx-content { }` … work as-is. Roots that must stay native
+  HTML (`<a>`, `<button>`, `<details>`…) carry `data-component` instead:
+  `[data-component="accordion"]`, `[data-component="nav-tabs-item"]`.
+- **State** — `html[data-theme="dark"]`, `html[data-current-path="/quickstart"]`,
+  and `[data-active]` on the active sidebar link, header tab, TOC item and
+  dropdown item.
+
+```css
+/* style.css */
+#navbar { background: #fffff2; }
+card { border-radius: 0; }
+html[data-theme="dark"] callout { border-color: #444; }
+```
+
+```js
+// analytics.js
+window.dataLayer = window.dataLayer || [];
+```
+
 ## License
 
 Proprietary. © Velu.