@veluai/velu 0.2.36 → 0.2.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -0
- package/dist/cli.js +122 -55
- package/docs/mintlify-migration.md +159 -0
- package/docs/vepa.md +97 -0
- package/package.json +8 -2
- package/runtime/velu-ui/components/ApiReferencePage.jsx +11 -3
- package/runtime/velu-ui/components/ApiSamples.jsx +9 -4
- package/runtime/velu-ui/components/Card.jsx +7 -4
- package/runtime/velu-ui/components/Chatbot.jsx +9 -4
- package/runtime/velu-ui/components/Columns.jsx +1 -0
- package/runtime/velu-ui/components/PageFooter.jsx +3 -0
- package/runtime/velu-ui/components/PageHeader.jsx +14 -7
- package/runtime/velu-ui/components/ThemePreferenceMenu.jsx +57 -0
- package/runtime/velu-ui/components/ThemeToggle.jsx +3 -1
- package/runtime/velu-ui/components/Update.jsx +22 -10
- package/runtime/velu-ui/components/VepaFooter.jsx +40 -0
- package/runtime/velu-ui/components/card.css +9 -0
- package/runtime/velu-ui/components/chatbot.css +42 -0
- package/runtime/velu-ui/components/docs-layout.css +75 -0
- package/runtime/velu-ui/components/page-header.css +6 -0
- package/runtime/velu-ui/styles.css +1 -0
- package/runtime/velu-ui/themes/vepa.css +396 -0
- package/schema/velu.schema.json +5 -0
- package/src/navigation.js +3 -2
- package/src/runtime/App.jsx +120 -50
- package/src/runtime/VepaToc.jsx +12 -0
- package/src/runtime/page-mode.js +54 -0
- package/templates/starter/essentials/settings.mdx +15 -0
package/README.md
CHANGED
|
@@ -21,6 +21,7 @@ reloads the browser automatically.
|
|
|
21
21
|
| Command | What it does |
|
|
22
22
|
| --- | --- |
|
|
23
23
|
| `velu init <dir>` | Scaffold a new docs project into `<dir>` (creates `velu.json`, a favicon, and a set of starter `.mdx` pages). |
|
|
24
|
+
| `velu migrate mintlify [dir]` | Migrate Mintlify docs into a new directory; supports `--out`, `--dry-run`, `--strict`, and `--json`. |
|
|
24
25
|
| `velu dev [dir]` | Start the live-preview dev server for the project in `<dir>` (defaults to the current directory). |
|
|
25
26
|
|
|
26
27
|
Set a custom port with the `PORT` env var:
|
|
@@ -29,6 +30,22 @@ Set a custom port with the `PORT` env var:
|
|
|
29
30
|
PORT=5180 velu dev my-docs
|
|
30
31
|
```
|
|
31
32
|
|
|
33
|
+
## Migrate from Mintlify
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
velu migrate mintlify ./mintlify-docs --out ./velu-docs --dry-run
|
|
37
|
+
velu migrate mintlify ./mintlify-docs --out ./velu-docs
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The source stays untouched. Configuration, MDX, snippets, custom CSS/JavaScript,
|
|
41
|
+
assets, and supported npm scripts are migrated, with JSON and Markdown reports
|
|
42
|
+
for anything requiring review. See the [migration guide](docs/mintlify-migration.md)
|
|
43
|
+
for coverage, exit codes, and runtime limitations.
|
|
44
|
+
|
|
45
|
+
Set `"theme": "vepa"` in `velu.json` for the Vepa preset. Migration
|
|
46
|
+
maps Mintlify’s `sequoia` setting to `vepa` automatically. See [Vepa compatibility](docs/vepa.md)
|
|
47
|
+
for the pinned Mintlify reference, verified geometry, and remaining parity limits.
|
|
48
|
+
|
|
32
49
|
## Project layout
|
|
33
50
|
|
|
34
51
|
`velu init` produces a project shaped like this:
|