@veluai/velu 0.2.13 → 0.2.15
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 +80 -80
- package/dist/cli.js +37 -37
- package/package.json +64 -64
- package/runtime/velu-ui/base.css +320 -320
- package/runtime/velu-ui/components/Accordion.jsx +64 -64
- package/runtime/velu-ui/components/ApiClient.jsx +207 -207
- package/runtime/velu-ui/components/ApiField.jsx +87 -87
- package/runtime/velu-ui/components/ApiPath.jsx +63 -63
- package/runtime/velu-ui/components/ApiReferencePage.jsx +384 -384
- package/runtime/velu-ui/components/ApiSamples.jsx +36 -36
- package/runtime/velu-ui/components/ApiSidebar.jsx +122 -122
- package/runtime/velu-ui/components/AskBar.jsx +71 -71
- package/runtime/velu-ui/components/Callout.jsx +114 -114
- package/runtime/velu-ui/components/Card.jsx +131 -131
- package/runtime/velu-ui/components/Chatbot.jsx +885 -885
- package/runtime/velu-ui/components/CodeBlock.jsx +375 -375
- package/runtime/velu-ui/components/Columns.jsx +56 -56
- package/runtime/velu-ui/components/ContextMenu.jsx +298 -273
- package/runtime/velu-ui/components/ErrorCard.jsx +138 -138
- package/runtime/velu-ui/components/Field.jsx +81 -81
- package/runtime/velu-ui/components/Image.jsx +163 -163
- package/runtime/velu-ui/components/Logo.jsx +31 -31
- package/runtime/velu-ui/components/MethodBadge.jsx +31 -31
- package/runtime/velu-ui/components/NavSelect.jsx +108 -108
- package/runtime/velu-ui/components/NotFound.jsx +63 -63
- package/runtime/velu-ui/components/PageFeedback.jsx +219 -219
- package/runtime/velu-ui/components/PageFooter.jsx +145 -145
- package/runtime/velu-ui/components/PageHeader.jsx +422 -422
- package/runtime/velu-ui/components/PageNav.jsx +77 -77
- package/runtime/velu-ui/components/PoweredBy.jsx +51 -51
- package/runtime/velu-ui/components/Prompt.jsx +115 -115
- package/runtime/velu-ui/components/Search.jsx +460 -460
- package/runtime/velu-ui/components/Sidebar.jsx +254 -254
- package/runtime/velu-ui/components/SocialLinks.jsx +90 -90
- package/runtime/velu-ui/components/Steps.jsx +65 -65
- package/runtime/velu-ui/components/ThemeToggle.jsx +48 -48
- package/runtime/velu-ui/components/Toc.jsx +537 -537
- package/runtime/velu-ui/components/TocBar.jsx +195 -195
- package/runtime/velu-ui/components/Tree.jsx +87 -87
- package/runtime/velu-ui/components/TryItBar.jsx +102 -102
- package/runtime/velu-ui/components/accordion.css +92 -92
- package/runtime/velu-ui/components/api-page.css +208 -208
- package/runtime/velu-ui/components/api.css +635 -635
- package/runtime/velu-ui/components/ask-bar.css +94 -94
- package/runtime/velu-ui/components/card.css +105 -105
- package/runtime/velu-ui/components/chatbot.css +622 -622
- package/runtime/velu-ui/components/code-block.css +263 -263
- package/runtime/velu-ui/components/context-menu.css +173 -173
- package/runtime/velu-ui/components/docs-layout.css +822 -822
- package/runtime/velu-ui/components/field.css +82 -82
- package/runtime/velu-ui/components/image.css +237 -237
- package/runtime/velu-ui/components/nav-select.css +157 -157
- package/runtime/velu-ui/components/not-found.css +94 -94
- package/runtime/velu-ui/components/page-feedback.css +241 -241
- package/runtime/velu-ui/components/page-footer.css +130 -130
- package/runtime/velu-ui/components/page-header.css +558 -558
- package/runtime/velu-ui/components/page-nav.css +50 -50
- package/runtime/velu-ui/components/powered-by.css +92 -92
- package/runtime/velu-ui/components/prompt.css +99 -99
- package/runtime/velu-ui/components/search.css +307 -307
- package/runtime/velu-ui/components/sidebar.css +205 -205
- package/runtime/velu-ui/components/steps.css +77 -77
- package/runtime/velu-ui/components/theme-toggle.css +102 -102
- package/runtime/velu-ui/components/toc-bar.css +234 -234
- package/runtime/velu-ui/components/tree.css +49 -49
- package/runtime/velu-ui/index.js +54 -54
- package/runtime/velu-ui/lib/api-send.js +92 -92
- package/runtime/velu-ui/lib/brand-icons.jsx +103 -103
- package/runtime/velu-ui/lib/component-schemas.js +100 -100
- package/runtime/velu-ui/lib/copyText.js +64 -64
- package/runtime/velu-ui/lib/docs-assistant.js +250 -250
- package/runtime/velu-ui/lib/lang-icons.jsx +147 -147
- package/runtime/velu-ui/lib/pagefind.js +113 -113
- package/runtime/velu-ui/lib/prism-langs.js +957 -957
- package/runtime/velu-ui/lib/prism-loader.js +74 -74
- package/runtime/velu-ui/lib/resolveIcon.jsx +29 -29
- package/runtime/velu-ui/lib/scrollIntoNearestView.js +66 -66
- package/runtime/velu-ui/mdx-components.jsx +105 -105
- package/runtime/velu-ui/primitives/Cluster.jsx +49 -49
- package/runtime/velu-ui/primitives/Stack.jsx +63 -63
- package/runtime/velu-ui/primitives/Switcher.jsx +57 -57
- package/runtime/velu-ui/primitives/stack.css +3 -3
- package/runtime/velu-ui/primitives/switcher.css +25 -25
- package/runtime/velu-ui/styles.css +46 -46
- package/runtime/velu-ui/tokens.css +4 -4
- package/schema/velu.schema.json +423 -423
- package/src/lib/extract-mdx-error.js +170 -170
- package/src/lib/issues.js +159 -159
- package/src/lib/known-components.js +34 -34
- package/src/navigation.js +443 -443
- package/src/runtime/App.jsx +1669 -1668
- package/src/runtime/ErrorBoundary.jsx +54 -54
- package/src/runtime/client-entry.jsx +22 -22
- package/src/runtime/server-entry.jsx +16 -16
- package/src/template.html +48 -48
- package/templates/starter/ai-tools/claude-code.mdx +26 -26
- package/templates/starter/ai-tools/cursor.mdx +17 -17
- package/templates/starter/api-reference/introduction.mdx +43 -43
- package/templates/starter/development.mdx +19 -19
- package/templates/starter/essentials/code.mdx +29 -29
- package/templates/starter/essentials/images.mdx +29 -29
- package/templates/starter/essentials/markdown.mdx +25 -25
- package/templates/starter/essentials/navigation.mdx +39 -39
- package/templates/starter/essentials/settings.mdx +30 -30
- package/templates/starter/favicon.svg +6 -6
- package/templates/starter/index.mdx +31 -31
- package/templates/starter/openapi.json +160 -160
- package/templates/starter/quickstart.mdx +31 -31
- package/templates/starter/velu.json +41 -41
|
@@ -1,31 +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>
|
|
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>
|
|
@@ -1,41 +1,41 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://veludocs.com/velu.schema.json",
|
|
3
|
-
"name": "Starter",
|
|
4
|
-
"url": "https://veludocs.com",
|
|
5
|
-
"colors": {
|
|
6
|
-
"primary": "#dc143c"
|
|
7
|
-
},
|
|
8
|
-
"favicon": "/favicon.svg",
|
|
9
|
-
"contextual": {
|
|
10
|
-
"options": ["copy", "view", "chatgpt", "claude", "mcp", "cursor", "vscode"]
|
|
11
|
-
},
|
|
12
|
-
"navigation": {
|
|
13
|
-
"anchors": [
|
|
14
|
-
{ "anchor": "Documentation", "icon": "book-open", "href": "https://veludocs.com" },
|
|
15
|
-
{ "anchor": "Community", "icon": "users", "href": "https://veludocs.com/community" }
|
|
16
|
-
],
|
|
17
|
-
"tabs": [
|
|
18
|
-
{
|
|
19
|
-
"tab": "Guides",
|
|
20
|
-
"groups": [
|
|
21
|
-
{ "group": "Getting Started", "icon": "rocket", "pages": ["index", "quickstart", "development"] },
|
|
22
|
-
{ "group": "Customization", "icon": "sliders-horizontal", "pages": ["essentials/settings", "essentials/navigation"] },
|
|
23
|
-
{ "group": "Writing Content", "icon": "pen-line", "pages": ["essentials/markdown", "essentials/code", "essentials/images"] },
|
|
24
|
-
{ "group": "AI Tools", "icon": "sparkles", "pages": ["ai-tools/claude-code", "ai-tools/cursor"] }
|
|
25
|
-
]
|
|
26
|
-
},
|
|
27
|
-
{
|
|
28
|
-
"tab": "API Reference",
|
|
29
|
-
"icon": "terminal",
|
|
30
|
-
"openapi": "/openapi.json",
|
|
31
|
-
"groups": [
|
|
32
|
-
{ "group": "API Documentation", "pages": ["api-reference/introduction"] }
|
|
33
|
-
]
|
|
34
|
-
}
|
|
35
|
-
]
|
|
36
|
-
},
|
|
37
|
-
"api": {
|
|
38
|
-
"playground": { "proxy": true },
|
|
39
|
-
"examples": { "languages": ["curl", "javascript", "python", "ruby"] }
|
|
40
|
-
}
|
|
41
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://veludocs.com/velu.schema.json",
|
|
3
|
+
"name": "Starter",
|
|
4
|
+
"url": "https://veludocs.com",
|
|
5
|
+
"colors": {
|
|
6
|
+
"primary": "#dc143c"
|
|
7
|
+
},
|
|
8
|
+
"favicon": "/favicon.svg",
|
|
9
|
+
"contextual": {
|
|
10
|
+
"options": ["copy", "view", "chatgpt", "claude", "mcp", "cursor", "vscode"]
|
|
11
|
+
},
|
|
12
|
+
"navigation": {
|
|
13
|
+
"anchors": [
|
|
14
|
+
{ "anchor": "Documentation", "icon": "book-open", "href": "https://veludocs.com" },
|
|
15
|
+
{ "anchor": "Community", "icon": "users", "href": "https://veludocs.com/community" }
|
|
16
|
+
],
|
|
17
|
+
"tabs": [
|
|
18
|
+
{
|
|
19
|
+
"tab": "Guides",
|
|
20
|
+
"groups": [
|
|
21
|
+
{ "group": "Getting Started", "icon": "rocket", "pages": ["index", "quickstart", "development"] },
|
|
22
|
+
{ "group": "Customization", "icon": "sliders-horizontal", "pages": ["essentials/settings", "essentials/navigation"] },
|
|
23
|
+
{ "group": "Writing Content", "icon": "pen-line", "pages": ["essentials/markdown", "essentials/code", "essentials/images"] },
|
|
24
|
+
{ "group": "AI Tools", "icon": "sparkles", "pages": ["ai-tools/claude-code", "ai-tools/cursor"] }
|
|
25
|
+
]
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"tab": "API Reference",
|
|
29
|
+
"icon": "terminal",
|
|
30
|
+
"openapi": "/openapi.json",
|
|
31
|
+
"groups": [
|
|
32
|
+
{ "group": "API Documentation", "pages": ["api-reference/introduction"] }
|
|
33
|
+
]
|
|
34
|
+
}
|
|
35
|
+
]
|
|
36
|
+
},
|
|
37
|
+
"api": {
|
|
38
|
+
"playground": { "proxy": true },
|
|
39
|
+
"examples": { "languages": ["curl", "javascript", "python", "ruby"] }
|
|
40
|
+
}
|
|
41
|
+
}
|