@veluai/velu 0.1.0

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.
Files changed (90) hide show
  1. package/dist/cli.js +11 -0
  2. package/package.json +52 -0
  3. package/runtime/velu-ui/base.css +311 -0
  4. package/runtime/velu-ui/components/Accordion.jsx +64 -0
  5. package/runtime/velu-ui/components/ApiClient.jsx +121 -0
  6. package/runtime/velu-ui/components/ApiField.jsx +87 -0
  7. package/runtime/velu-ui/components/ApiPath.jsx +63 -0
  8. package/runtime/velu-ui/components/ApiSidebar.jsx +122 -0
  9. package/runtime/velu-ui/components/AskBar.jsx +71 -0
  10. package/runtime/velu-ui/components/Callout.jsx +114 -0
  11. package/runtime/velu-ui/components/Card.jsx +131 -0
  12. package/runtime/velu-ui/components/Chatbot.jsx +596 -0
  13. package/runtime/velu-ui/components/CodeBlock.jsx +375 -0
  14. package/runtime/velu-ui/components/Columns.jsx +56 -0
  15. package/runtime/velu-ui/components/Field.jsx +81 -0
  16. package/runtime/velu-ui/components/Image.jsx +163 -0
  17. package/runtime/velu-ui/components/MethodBadge.jsx +31 -0
  18. package/runtime/velu-ui/components/NavSelect.jsx +108 -0
  19. package/runtime/velu-ui/components/PageFeedback.jsx +219 -0
  20. package/runtime/velu-ui/components/PageFooter.jsx +213 -0
  21. package/runtime/velu-ui/components/PageHeader.jsx +414 -0
  22. package/runtime/velu-ui/components/PageNav.jsx +77 -0
  23. package/runtime/velu-ui/components/PoweredBy.jsx +51 -0
  24. package/runtime/velu-ui/components/Prompt.jsx +115 -0
  25. package/runtime/velu-ui/components/Search.jsx +366 -0
  26. package/runtime/velu-ui/components/Sidebar.jsx +191 -0
  27. package/runtime/velu-ui/components/Steps.jsx +65 -0
  28. package/runtime/velu-ui/components/ThemeToggle.jsx +48 -0
  29. package/runtime/velu-ui/components/Toc.jsx +537 -0
  30. package/runtime/velu-ui/components/TocBar.jsx +195 -0
  31. package/runtime/velu-ui/components/Tree.jsx +87 -0
  32. package/runtime/velu-ui/components/TryItBar.jsx +90 -0
  33. package/runtime/velu-ui/components/accordion.css +92 -0
  34. package/runtime/velu-ui/components/api.css +479 -0
  35. package/runtime/velu-ui/components/ask-bar.css +94 -0
  36. package/runtime/velu-ui/components/card.css +105 -0
  37. package/runtime/velu-ui/components/chatbot.css +617 -0
  38. package/runtime/velu-ui/components/code-block.css +263 -0
  39. package/runtime/velu-ui/components/docs-layout.css +775 -0
  40. package/runtime/velu-ui/components/field.css +82 -0
  41. package/runtime/velu-ui/components/image.css +237 -0
  42. package/runtime/velu-ui/components/nav-select.css +157 -0
  43. package/runtime/velu-ui/components/page-feedback.css +241 -0
  44. package/runtime/velu-ui/components/page-footer.css +130 -0
  45. package/runtime/velu-ui/components/page-header.css +520 -0
  46. package/runtime/velu-ui/components/page-nav.css +50 -0
  47. package/runtime/velu-ui/components/powered-by.css +66 -0
  48. package/runtime/velu-ui/components/prompt.css +99 -0
  49. package/runtime/velu-ui/components/search.css +307 -0
  50. package/runtime/velu-ui/components/sidebar.css +144 -0
  51. package/runtime/velu-ui/components/steps.css +77 -0
  52. package/runtime/velu-ui/components/theme-toggle.css +70 -0
  53. package/runtime/velu-ui/components/toc-bar.css +234 -0
  54. package/runtime/velu-ui/components/tree.css +49 -0
  55. package/runtime/velu-ui/index.js +45 -0
  56. package/runtime/velu-ui/lib/copyText.js +64 -0
  57. package/runtime/velu-ui/lib/lang-icons.jsx +156 -0
  58. package/runtime/velu-ui/lib/prism-langs.js +957 -0
  59. package/runtime/velu-ui/lib/prism-loader.js +74 -0
  60. package/runtime/velu-ui/lib/resolveIcon.jsx +29 -0
  61. package/runtime/velu-ui/lib/scrollIntoNearestView.js +66 -0
  62. package/runtime/velu-ui/mdx-components.jsx +85 -0
  63. package/runtime/velu-ui/primitives/Cluster.jsx +49 -0
  64. package/runtime/velu-ui/primitives/Stack.jsx +63 -0
  65. package/runtime/velu-ui/primitives/Switcher.jsx +57 -0
  66. package/runtime/velu-ui/primitives/stack.css +3 -0
  67. package/runtime/velu-ui/primitives/switcher.css +25 -0
  68. package/runtime/velu-ui/styles.css +43 -0
  69. package/runtime/velu-ui/tokens.css +4 -0
  70. package/schema/velu.schema.json +167 -0
  71. package/src/navigation.js +434 -0
  72. package/src/runtime/App.jsx +1473 -0
  73. package/src/runtime/client-entry.jsx +22 -0
  74. package/src/runtime/server-entry.jsx +16 -0
  75. package/src/template.html +48 -0
  76. package/templates/starter/ai-tools/claude-code.mdx +26 -0
  77. package/templates/starter/ai-tools/cursor.mdx +17 -0
  78. package/templates/starter/api-reference/endpoint/create.mdx +24 -0
  79. package/templates/starter/api-reference/endpoint/get.mdx +27 -0
  80. package/templates/starter/api-reference/introduction.mdx +28 -0
  81. package/templates/starter/development.mdx +19 -0
  82. package/templates/starter/essentials/code.mdx +28 -0
  83. package/templates/starter/essentials/images.mdx +29 -0
  84. package/templates/starter/essentials/markdown.mdx +25 -0
  85. package/templates/starter/essentials/navigation.mdx +39 -0
  86. package/templates/starter/essentials/settings.mdx +30 -0
  87. package/templates/starter/favicon.svg +6 -0
  88. package/templates/starter/index.mdx +31 -0
  89. package/templates/starter/quickstart.mdx +31 -0
  90. package/templates/starter/velu.json +33 -0
package/src/runtime/client-entry.jsx ADDED
@@ -0,0 +1,22 @@
1
+ import React from 'react';
2
+ import { hydrateRoot } from 'react-dom/client';
3
+ import { BrowserRouter } from 'react-router-dom';
4
+ import 'velu-ui/styles.css';
5
+ import App from './App.jsx';
6
+
7
+ hydrateRoot(
8
+ document.getElementById('root'),
9
+ <BrowserRouter>
10
+ <App />
11
+ </BrowserRouter>
12
+ );
13
+
14
+ // Dev only: the SSR-inlined critical CSS (<style data-velu-ssr>) exists just
15
+ // to avoid FOUC on first paint. By now Vite has injected its own HMR-managed
16
+ // stylesheet from the `velu-ui/styles.css` import above, so drop the stale
17
+ // inline copy — otherwise it shadows hot CSS updates and edits don't apply.
18
+ if (import.meta.hot) {
19
+ for (const el of document.querySelectorAll('style[data-velu-ssr]')) {
20
+ el.remove();
21
+ }
22
+ }
package/src/runtime/server-entry.jsx ADDED
@@ -0,0 +1,16 @@
1
+ import React from 'react';
2
+ import { renderToString } from 'react-dom/server';
3
+ import { StaticRouter } from 'react-router-dom/server';
4
+ // Side-effect import: stubbed to empty during SSR, but it registers the
5
+ // stylesheet in Vite's SSR module graph so dev-server.js can collect and
6
+ // inline it into <head> (flicker-free SSR).
7
+ import 'velu-ui/styles.css';
8
+ import App from './App.jsx';
9
+
10
+ export async function render(url) {
11
+ return renderToString(
12
+ <StaticRouter location={url}>
13
+ <App />
14
+ </StaticRouter>
15
+ );
16
+ }
package/src/template.html ADDED
@@ -0,0 +1,48 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
6
+ <title><!--app-title--></title>
7
+ <link rel="preconnect" href="https://fonts.googleapis.com" />
8
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
9
+ <link
10
+ rel="stylesheet"
11
+ href="https://fonts.googleapis.com/css2?family=Google+Sans+Code:wght@400;500&family=Google+Sans+Flex:opsz,wght@6..144,1..1000&family=Outfit:wght@300;400;500&display=swap"
12
+ />
13
+ <script>
14
+ // Anti-flash: set the theme BEFORE first paint so CSS vars resolve
15
+ // correctly on frame 1. Two-state; first visit follows the OS, an
16
+ // explicit choice (localStorage) is remembered and overrides the OS.
17
+ (function () {
18
+ try {
19
+ var KEY = 'velu-theme';
20
+ var mq = matchMedia('(prefers-color-scheme: dark)');
21
+ var saved = localStorage.getItem(KEY);
22
+ var theme =
23
+ saved === 'light' || saved === 'dark'
24
+ ? saved
25
+ : mq.matches
26
+ ? 'dark'
27
+ : 'light';
28
+ document.documentElement.dataset.theme = theme;
29
+ // Track the OS only until the user makes an explicit choice.
30
+ mq.addEventListener('change', function () {
31
+ var s = localStorage.getItem(KEY);
32
+ if (s !== 'light' && s !== 'dark')
33
+ document.documentElement.dataset.theme = mq.matches
34
+ ? 'dark'
35
+ : 'light';
36
+ });
37
+ } catch (e) {
38
+ document.documentElement.dataset.theme = 'light';
39
+ }
40
+ })();
41
+ </script>
42
+ <!--app-head-->
43
+ </head>
44
+ <body>
45
+ <div id="root"><!--app-html--></div>
46
+ <script type="module" src="/src/runtime/client-entry.jsx"></script>
47
+ </body>
48
+ </html>
package/templates/starter/ai-tools/claude-code.mdx ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: Claude Code
3
+ description: Work on your docs with Claude Code.
4
+ ---
5
+
6
+ Claude Code can read your `velu.json` and `.mdx` files to draft pages,
7
+ restructure navigation, and keep content consistent.
8
+
9
+ <Callout type="tip">
10
+ Keep page paths and `navigation` in sync — ask Claude to add a page
11
+ and wire it into the right group in one step.
12
+ </Callout>
13
+
14
+ ## Suggested workflow
15
+
16
+ <Steps>
17
+ <Step title="Describe the page">
18
+ Tell Claude the title and what it should cover.
19
+ </Step>
20
+ <Step title="Review the draft">
21
+ Claude writes the `.mdx` and adds it to `navigation`.
22
+ </Step>
23
+ <Step title="Preview">
24
+ `velu dev` reloads so you can read it in place.
25
+ </Step>
26
+ </Steps>
package/templates/starter/ai-tools/cursor.mdx ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: Cursor
3
+ description: Edit your docs in Cursor.
4
+ ---
5
+
6
+ Cursor's editor understands your project structure, so it can complete
7
+ `navigation` entries and scaffold pages from a prompt.
8
+
9
+ <Callout type="note">
10
+ Point Cursor at `velu.json` when asking it to reorganize the sidebar
11
+ — that's the single source of truth for structure.
12
+ </Callout>
13
+
14
+ ## Tips
15
+
16
+ - Reference an existing page as a style example when drafting a new one.
17
+ - Ask for a whole group at once, then refine page by page.
package/templates/starter/api-reference/endpoint/create.mdx ADDED
@@ -0,0 +1,24 @@
1
+ ---
2
+ title: Create item
3
+ description: Create a new item.
4
+ ---
5
+
6
+ <MethodBadge method="POST" /> `/items`
7
+
8
+ Creates an item and returns it.
9
+
10
+ ## Body
11
+
12
+ <ApiField name="name" type="string" required>
13
+ Display name for the item.
14
+ </ApiField>
15
+
16
+ ## Response
17
+
18
+ ```json
19
+ {
20
+ "id": "itm_2",
21
+ "name": "New item",
22
+ "created_at": "2024-01-01T00:00:00Z"
23
+ }
24
+ ```
package/templates/starter/api-reference/endpoint/get.mdx ADDED
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: Get items
3
+ description: Retrieve a list of items.
4
+ ---
5
+
6
+ <MethodBadge method="GET" /> `/items`
7
+
8
+ Returns a paginated list of items.
9
+
10
+ ## Query parameters
11
+
12
+ <ApiField name="limit" type="integer" default="20">
13
+ Maximum number of items to return.
14
+ </ApiField>
15
+
16
+ <ApiField name="cursor" type="string">
17
+ Pagination cursor from a previous response.
18
+ </ApiField>
19
+
20
+ ## Response
21
+
22
+ ```json
23
+ {
24
+ "data": [{ "id": "itm_1", "name": "Example" }],
25
+ "next_cursor": null
26
+ }
27
+ ```
package/templates/starter/api-reference/introduction.mdx ADDED
@@ -0,0 +1,28 @@
1
+ ---
2
+ title: Introduction
3
+ description: How to read this API reference.
4
+ ---
5
+
6
+ This section documents the example API. Endpoints are grouped in the
7
+ sidebar; each page shows the request, parameters, and a sample
8
+ response.
9
+
10
+ <Callout type="note">
11
+ This is a second tab ("API Reference"). Tabs let you keep guides and
12
+ reference docs in separate top-level sections of the same site.
13
+ </Callout>
14
+
15
+ ## Base URL
16
+
17
+ ```
18
+ https://api.example.com/v1
19
+ ```
20
+
21
+ ## Authentication
22
+
23
+ Send your key as a bearer token:
24
+
25
+ ```bash
26
+ curl https://api.example.com/v1/items \
27
+ -H "Authorization: Bearer YOUR_TOKEN"
28
+ ```
package/templates/starter/development.mdx ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: Development
3
+ description: Preview your docs locally as you write.
4
+ ---
5
+
6
+ `velu dev` serves your project with server-side rendering and live
7
+ reload, so what you see locally matches production.
8
+
9
+ <Callout type="note">
10
+ The dev server reads `velu.json` from the folder you point it at.
11
+ Run it from your project root, or pass the path: `velu dev ./docs`.
12
+ </Callout>
13
+
14
+ ## What reloads automatically
15
+
16
+ - Editing any `.mdx` page reloads that page.
17
+ - Editing `velu.json` (colors, font, favicon, navigation) re-renders
18
+ the whole site.
19
+ - Adding or removing a page file updates the route map.
package/templates/starter/essentials/code.mdx ADDED
@@ -0,0 +1,28 @@
1
+ ---
2
+ title: Code blocks
3
+ description: Syntax-highlighted code and groups.
4
+ ---
5
+
6
+ Fenced code blocks are upgraded to a rich code component with a copy
7
+ button and a language label.
8
+
9
+ ```js
10
+ export function greet(name) {
11
+ return `Hello, ${name}!`;
12
+ }
13
+ ```
14
+
15
+ ## Code groups
16
+
17
+ Show the same example in several languages with a `CodeGroup`:
18
+
19
+ <CodeGroup>
20
+ ```js index.js
21
+ fetch('/api/hello').then((r) => r.json());
22
+ ```
23
+
24
+ ```py main.py
25
+ import requests
26
+ requests.get('/api/hello').json()
27
+ ```
28
+ </CodeGroup>
package/templates/starter/essentials/images.mdx ADDED
@@ -0,0 +1,29 @@
1
+ ---
2
+ title: Images
3
+ description: Add images and visual media.
4
+ ---
5
+
6
+ Use standard Markdown images, or the `Image` component for captions
7
+ and framing.
8
+
9
+ ```md
10
+ ![Alt text](/images/diagram.png)
11
+ ```
12
+
13
+ <Callout type="tip">
14
+ Put assets in a folder like `/images` at your project root and
15
+ reference them with an absolute path.
16
+ </Callout>
17
+
18
+ ## Cards with media
19
+
20
+ Cards can hold images, prose, or anything else:
21
+
22
+ <CardGroup>
23
+ <Card title="Light & dark" icon="moon">
24
+ Assets and colors adapt to the active theme.
25
+ </Card>
26
+ <Card title="Responsive" icon="smartphone">
27
+ Layout reflows cleanly from desktop to mobile.
28
+ </Card>
29
+ </CardGroup>
package/templates/starter/essentials/markdown.mdx ADDED
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: Markdown
3
+ description: Author with Markdown and components.
4
+ ---
5
+
6
+ Standard Markdown works everywhere: **bold**, _italic_, `inline code`,
7
+ [links](https://veludocs.com), lists, and tables.
8
+
9
+ ## Components
10
+
11
+ Drop a component tag right into your Markdown:
12
+
13
+ <Callout type="warning">
14
+ Callouts come in `note`, `tip`, `warning`, and `danger` styles.
15
+ </Callout>
16
+
17
+ <Accordion title="How does MDX work?">
18
+ Each page compiles to a component that renders identically on the
19
+ server and the client, so there's no flash of unstyled content.
20
+ </Accordion>
21
+
22
+ ## Headings
23
+
24
+ Use `##` and `###` for sections — they populate the on-page table of
25
+ contents on the right automatically.
package/templates/starter/essentials/navigation.mdx ADDED
@@ -0,0 +1,39 @@
1
+ ---
2
+ title: Navigation
3
+ description: Organize your docs with tabs, groups, and pages.
4
+ ---
5
+
6
+ `navigation` in `velu.json` is a tree. The pieces, outermost to
7
+ innermost:
8
+
9
+ - **tabs** — top-level sections in the header (e.g. Guides, API).
10
+ - **groups** — sidebar sections within a tab.
11
+ - **pages** — the page paths in a group; a page may also be a nested
12
+ group.
13
+ - **anchors** — pinned links (often external) shown above the groups.
14
+
15
+ ```json
16
+ {
17
+ "navigation": {
18
+ "tabs": [
19
+ {
20
+ "tab": "Guides",
21
+ "groups": [
22
+ { "group": "Getting Started", "pages": ["index", "quickstart"] }
23
+ ]
24
+ }
25
+ ]
26
+ }
27
+ }
28
+ ```
29
+
30
+ <Callout type="note">
31
+ Sidebar labels come from each page's frontmatter `title` — you don't
32
+ repeat them in `navigation`.
33
+ </Callout>
34
+
35
+ ## Multiple products, versions, languages
36
+
37
+ Wrap your tabs in `products`, `versions`, or `languages` to offer a
38
+ switcher. The active non-default choice becomes a URL prefix
39
+ (`/v2/...`, `/fr/...`).
package/templates/starter/essentials/settings.mdx ADDED
@@ -0,0 +1,30 @@
1
+ ---
2
+ title: Settings
3
+ description: Theme your site through velu.json.
4
+ ---
5
+
6
+ Your site's look comes from a few top-level keys in `velu.json`.
7
+
8
+ ```json
9
+ {
10
+ "name": "Acme Docs",
11
+ "colors": { "primary": "#16a34a", "light": "#07c983", "dark": "#15803d" },
12
+ "favicon": "/favicon.svg",
13
+ "font": { "family": "Inter" }
14
+ }
15
+ ```
16
+
17
+ ## Colors
18
+
19
+ `colors.primary` sets the accent used across the UI. `light` and
20
+ `dark` override it per theme; both default to `primary`.
21
+
22
+ ## Font
23
+
24
+ `font.family` is any Google Font family — it's loaded automatically and
25
+ applied as the body font.
26
+
27
+ <Callout type="tip">
28
+ `favicon` is a path relative to your project root, e.g.
29
+ `/favicon.svg`.
30
+ </Callout>
package/templates/starter/favicon.svg ADDED
@@ -0,0 +1,6 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
2
+ <rect width="32" height="32" rx="7" fill="#dc143c" />
3
+ <g transform="translate(5.6 8.2) scale(0.65)" fill="#ffffff">
4
+ <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" />
5
+ </g>
6
+ </svg>
package/templates/starter/index.mdx ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: Introduction
3
+ description: Welcome to your Velu documentation site.
4
+ ---
5
+
6
+ This is your new documentation site, rendered by **Velu** from plain
7
+ Markdown and a `velu.json` config. The sidebar, tabs, and page order
8
+ all come from the `navigation` block — edit it and the site updates on
9
+ save.
10
+
11
+ <Callout type="tip">
12
+ Page paths in `navigation` are relative to the project root with no
13
+ extension: `"essentials/markdown"` renders `essentials/markdown.mdx`.
14
+ </Callout>
15
+
16
+ ## Get going
17
+
18
+ <CardGroup>
19
+ <Card title="Quickstart" icon="rocket" href="/quickstart">
20
+ Run the dev server and make your first edit.
21
+ </Card>
22
+ <Card title="Customize" icon="sliders-horizontal" href="/essentials/settings">
23
+ Set your colors, font, and favicon.
24
+ </Card>
25
+ <Card title="Write content" icon="pen-line" href="/essentials/markdown">
26
+ Markdown plus a library of components.
27
+ </Card>
28
+ <Card title="API reference" icon="terminal" href="/api-reference/introduction">
29
+ Document your endpoints.
30
+ </Card>
31
+ </CardGroup>
package/templates/starter/quickstart.mdx ADDED
@@ -0,0 +1,31 @@
1
+ ---
2
+ title: Quickstart
3
+ description: Get your documentation site running in a minute.
4
+ ---
5
+
6
+ ## Start the dev server
7
+
8
+ From your project folder, run:
9
+
10
+ ```bash
11
+ velu dev
12
+ ```
13
+
14
+ Then open the printed URL. The server live-reloads as you edit content
15
+ or `velu.json`.
16
+
17
+ ## Add a page
18
+
19
+ <Steps>
20
+ <Step title="Create the file">
21
+ Add a new `.mdx` file anywhere in the project, e.g.
22
+ `guides/hello.mdx`, with a `title` in its frontmatter.
23
+ </Step>
24
+ <Step title="List it in navigation">
25
+ Add its path (without `.mdx`) to a group's `pages` array in
26
+ `velu.json`.
27
+ </Step>
28
+ <Step title="Save">
29
+ The sidebar updates and your page is live.
30
+ </Step>
31
+ </Steps>
package/templates/starter/velu.json ADDED
@@ -0,0 +1,33 @@
1
+ {
2
+ "$schema": "https://veludocs.com/velu.schema.json",
3
+ "name": "Starter",
4
+ "colors": {
5
+ "primary": "#dc143c"
6
+ },
7
+ "favicon": "/favicon.svg",
8
+ "navigation": {
9
+ "anchors": [
10
+ { "anchor": "Documentation", "icon": "book-open", "href": "https://veludocs.com" },
11
+ { "anchor": "Community", "icon": "users", "href": "https://veludocs.com/community" }
12
+ ],
13
+ "tabs": [
14
+ {
15
+ "tab": "Guides",
16
+ "groups": [
17
+ { "group": "Getting Started", "icon": "rocket", "pages": ["index", "quickstart", "development"] },
18
+ { "group": "Customization", "icon": "sliders-horizontal", "pages": ["essentials/settings", "essentials/navigation"] },
19
+ { "group": "Writing Content", "icon": "pen-line", "pages": ["essentials/markdown", "essentials/code", "essentials/images"] },
20
+ { "group": "AI Tools", "icon": "sparkles", "pages": ["ai-tools/claude-code", "ai-tools/cursor"] }
21
+ ]
22
+ },
23
+ {
24
+ "tab": "API Reference",
25
+ "icon": "terminal",
26
+ "groups": [
27
+ { "group": "API Documentation", "pages": ["api-reference/introduction"] },
28
+ { "group": "Endpoint Examples", "pages": ["api-reference/endpoint/get", "api-reference/endpoint/create"] }
29
+ ]
30
+ }
31
+ ]
32
+ }
33
+ }