@axerity/cli 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.
- package/LICENSE +21 -0
- package/README.md +1 -0
- package/axerity.default.json +135 -0
- package/axerity.schema.json +268 -0
- package/bin/axerity.js +305 -0
- package/mdsvex.config.js +261 -0
- package/package.json +103 -0
- package/scripts/prepare-engine.mjs +20 -0
- package/src/app.d.ts +17 -0
- package/src/app.html +39 -0
- package/src/content/demo/api/meta.json +5 -0
- package/src/content/demo/api/pet/add-pet.md +105 -0
- package/src/content/demo/api/pet/delete-pet.md +70 -0
- package/src/content/demo/api/pet/find-by-status.md +72 -0
- package/src/content/demo/api/pet/find-by-tags.md +64 -0
- package/src/content/demo/api/pet/get-pet.md +99 -0
- package/src/content/demo/api/pet/meta.json +15 -0
- package/src/content/demo/api/pet/pet-object.md +112 -0
- package/src/content/demo/api/pet/update-pet-with-form.md +69 -0
- package/src/content/demo/api/pet/update-pet.md +79 -0
- package/src/content/demo/api/pet/upload-image.md +79 -0
- package/src/content/demo/api/store/delete-order.md +62 -0
- package/src/content/demo/api/store/get-order.md +70 -0
- package/src/content/demo/api/store/inventory.md +54 -0
- package/src/content/demo/api/store/meta.json +5 -0
- package/src/content/demo/api/store/order-object.md +77 -0
- package/src/content/demo/api/store/place-order.md +83 -0
- package/src/content/demo/api/user/create-user.md +69 -0
- package/src/content/demo/api/user/create-with-list.md +57 -0
- package/src/content/demo/api/user/delete-user.md +61 -0
- package/src/content/demo/api/user/get-user.md +69 -0
- package/src/content/demo/api/user/login.md +80 -0
- package/src/content/demo/api/user/logout.md +45 -0
- package/src/content/demo/api/user/meta.json +14 -0
- package/src/content/demo/api/user/update-user.md +69 -0
- package/src/content/demo/api/user/user-object.md +85 -0
- package/src/content/demo/changelog.md +44 -0
- package/src/content/demo/components/accordion.md +70 -0
- package/src/content/demo/components/api.md +185 -0
- package/src/content/demo/components/badge.md +34 -0
- package/src/content/demo/components/callout.md +83 -0
- package/src/content/demo/components/cards.md +88 -0
- package/src/content/demo/components/code-group.md +55 -0
- package/src/content/demo/components/columns.md +42 -0
- package/src/content/demo/components/frame.md +51 -0
- package/src/content/demo/components/icon.md +54 -0
- package/src/content/demo/components/kbd.md +28 -0
- package/src/content/demo/components/meta.json +26 -0
- package/src/content/demo/components/roadmap.md +86 -0
- package/src/content/demo/components/steps.md +72 -0
- package/src/content/demo/components/tabs.md +146 -0
- package/src/content/demo/components/tooltip.md +44 -0
- package/src/content/demo/components/tree.md +83 -0
- package/src/content/demo/components/type-table.md +77 -0
- package/src/content/demo/components/update.md +48 -0
- package/src/content/demo/components/video.md +56 -0
- package/src/content/demo/components/webhooks.md +109 -0
- package/src/content/demo/components/websockets.md +101 -0
- package/src/content/demo/configuration/ai.md +40 -0
- package/src/content/demo/configuration/cli.md +46 -0
- package/src/content/demo/configuration/deployment.md +105 -0
- package/src/content/demo/configuration/index.md +92 -0
- package/src/content/demo/configuration/layouts.md +51 -0
- package/src/content/demo/configuration/meta.json +5 -0
- package/src/content/demo/configuration/navigation.md +167 -0
- package/src/content/demo/configuration/openapi.md +103 -0
- package/src/content/demo/configuration/search.md +36 -0
- package/src/content/demo/index.md +59 -0
- package/src/content/demo/installation.md +49 -0
- package/src/content/demo/meta.json +15 -0
- package/src/content/demo/quick-start.md +47 -0
- package/src/content/demo/theming/advanced.md +116 -0
- package/src/content/demo/theming/code.md +66 -0
- package/src/content/demo/theming/colors.md +103 -0
- package/src/content/demo/theming/index.md +88 -0
- package/src/content/demo/theming/layout.md +71 -0
- package/src/content/demo/theming/meta.json +5 -0
- package/src/content/demo/theming/themes.md +99 -0
- package/src/content/demo/theming/typography.md +83 -0
- package/src/content/demo/writing/code-blocks.md +154 -0
- package/src/content/demo/writing/diagrams.md +44 -0
- package/src/content/demo/writing/frontmatter.md +33 -0
- package/src/content/demo/writing/markdown.md +62 -0
- package/src/content/demo/writing/meta.json +5 -0
- package/src/hooks.server.ts +49 -0
- package/src/lib/assets/favicon.svg +1 -0
- package/src/lib/base.ts +12 -0
- package/src/lib/components/DynamicIcon.svelte +26 -0
- package/src/lib/components/docs/Analytics.svelte +38 -0
- package/src/lib/components/docs/Banner.svelte +44 -0
- package/src/lib/components/docs/Breadcrumbs.svelte +38 -0
- package/src/lib/components/docs/CopyPageMenu.svelte +119 -0
- package/src/lib/components/docs/DocsLayout.svelte +192 -0
- package/src/lib/components/docs/Footer.svelte +60 -0
- package/src/lib/components/docs/Mermaid.svelte +39 -0
- package/src/lib/components/docs/Navbar.svelte +144 -0
- package/src/lib/components/docs/PageMeta.svelte +35 -0
- package/src/lib/components/docs/PageNav.svelte +44 -0
- package/src/lib/components/docs/SearchDialog.svelte +182 -0
- package/src/lib/components/docs/Sidebar.svelte +85 -0
- package/src/lib/components/docs/SidebarDropdown.svelte +56 -0
- package/src/lib/components/docs/SidebarFooterLinks.svelte +19 -0
- package/src/lib/components/docs/SidebarGroup.svelte +54 -0
- package/src/lib/components/docs/SidebarLink.svelte +67 -0
- package/src/lib/components/docs/TableOfContents.svelte +77 -0
- package/src/lib/components/docs/ThemeToggle.svelte +19 -0
- package/src/lib/components/docs/VersionSwitcher.svelte +80 -0
- package/src/lib/components/kit/Accordion.svelte +60 -0
- package/src/lib/components/kit/AccordionGroup.svelte +13 -0
- package/src/lib/components/kit/Badge.svelte +32 -0
- package/src/lib/components/kit/Callout.svelte +51 -0
- package/src/lib/components/kit/Card.svelte +72 -0
- package/src/lib/components/kit/CardGroup.svelte +21 -0
- package/src/lib/components/kit/CodeGroup.svelte +65 -0
- package/src/lib/components/kit/Columns.svelte +26 -0
- package/src/lib/components/kit/Event.svelte +23 -0
- package/src/lib/components/kit/EventList.svelte +9 -0
- package/src/lib/components/kit/File.svelte +15 -0
- package/src/lib/components/kit/Folder.svelte +46 -0
- package/src/lib/components/kit/Frame.svelte +81 -0
- package/src/lib/components/kit/Icon.svelte +17 -0
- package/src/lib/components/kit/Kbd.svelte +11 -0
- package/src/lib/components/kit/Roadmap.svelte +15 -0
- package/src/lib/components/kit/RoadmapItem.svelte +109 -0
- package/src/lib/components/kit/Step.svelte +63 -0
- package/src/lib/components/kit/Steps.svelte +16 -0
- package/src/lib/components/kit/Tab.svelte +27 -0
- package/src/lib/components/kit/Tabs.svelte +75 -0
- package/src/lib/components/kit/Tooltip.svelte +33 -0
- package/src/lib/components/kit/Tree.svelte +11 -0
- package/src/lib/components/kit/TypeTable.svelte +187 -0
- package/src/lib/components/kit/Update.svelte +32 -0
- package/src/lib/components/kit/Video.svelte +64 -0
- package/src/lib/components/kit/accordion-context.ts +1 -0
- package/src/lib/components/kit/api/Api.svelte +80 -0
- package/src/lib/components/kit/api/ApiExamplePanel.svelte +100 -0
- package/src/lib/components/kit/api/ApiField.svelte +124 -0
- package/src/lib/components/kit/api/Channel.svelte +121 -0
- package/src/lib/components/kit/api/Endpoint.svelte +116 -0
- package/src/lib/components/kit/api/Enum.svelte +44 -0
- package/src/lib/components/kit/api/EnumValues.svelte +35 -0
- package/src/lib/components/kit/api/Expandable.svelte +70 -0
- package/src/lib/components/kit/api/Message.svelte +67 -0
- package/src/lib/components/kit/api/ObjectExample.svelte +11 -0
- package/src/lib/components/kit/api/RequestExample.svelte +11 -0
- package/src/lib/components/kit/api/ResponseExample.svelte +11 -0
- package/src/lib/components/kit/api/Webhook.svelte +115 -0
- package/src/lib/components/kit/api/api-context.ts +15 -0
- package/src/lib/components/kit/tabs-context.ts +8 -0
- package/src/lib/components/kit/tabs-store.svelte.ts +28 -0
- package/src/lib/config/site.ts +34 -0
- package/src/lib/content/index.ts +50 -0
- package/src/lib/content/raw.ts +21 -0
- package/src/lib/content/tree.ts +169 -0
- package/src/lib/index.ts +79 -0
- package/src/lib/nav-match.ts +23 -0
- package/src/lib/openapi/generate.ts +629 -0
- package/src/lib/server/og.ts +140 -0
- package/src/lib/state/search.svelte.ts +9 -0
- package/src/lib/state/theme.svelte.ts +58 -0
- package/src/lib/types.ts +216 -0
- package/src/params/docpage.ts +3 -0
- package/src/params/mdfile.ts +3 -0
- package/src/routes/+error.svelte +46 -0
- package/src/routes/+layout.svelte +25 -0
- package/src/routes/[...path=mdfile]/+server.ts +21 -0
- package/src/routes/[...slug=docpage]/+page.svelte +63 -0
- package/src/routes/[...slug=docpage]/+page.ts +44 -0
- package/src/routes/layout.css +897 -0
- package/src/routes/llms-full.txt/+server.ts +22 -0
- package/src/routes/llms.txt/+server.ts +20 -0
- package/src/routes/og/[...slug]/+server.ts +77 -0
- package/src/routes/rss.xml/+server.ts +65 -0
- package/src/routes/search.json/+server.ts +54 -0
- package/src/routes/sitemap.xml/+server.ts +21 -0
- package/static/favicon-dark.svg +6 -0
- package/static/favicon-light.svg +6 -0
- package/static/favicon.svg +14 -0
- package/static/fonts/geist-400.ttf +0 -0
- package/static/fonts/geist-600.ttf +0 -0
- package/static/fonts/geist-700.ttf +0 -0
- package/static/og-image.png +0 -0
- package/static/robots.txt +4 -0
- package/svelte.config.js +35 -0
- package/tsconfig.json +20 -0
- package/vite.config.ts +46 -0
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Callout
|
|
3
|
+
description: Draw attention to important notes.
|
|
4
|
+
icon: info
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Callout } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Callout
|
|
12
|
+
|
|
13
|
+
Callouts highlight notes, tips, warnings, and more. Import the component in a
|
|
14
|
+
page's `<script>` block, then use it anywhere in your Markdown.
|
|
15
|
+
|
|
16
|
+
## Variants
|
|
17
|
+
|
|
18
|
+
<Callout type="info">
|
|
19
|
+
|
|
20
|
+
This is the default **info** callout.
|
|
21
|
+
|
|
22
|
+
</Callout>
|
|
23
|
+
|
|
24
|
+
<Callout type="tip">
|
|
25
|
+
|
|
26
|
+
A handy **tip** to make your life easier.
|
|
27
|
+
|
|
28
|
+
</Callout>
|
|
29
|
+
|
|
30
|
+
<Callout type="success">
|
|
31
|
+
|
|
32
|
+
Everything worked, **success!**
|
|
33
|
+
|
|
34
|
+
</Callout>
|
|
35
|
+
|
|
36
|
+
<Callout type="warn">
|
|
37
|
+
|
|
38
|
+
Careful, this is a **warning**.
|
|
39
|
+
|
|
40
|
+
</Callout>
|
|
41
|
+
|
|
42
|
+
<Callout type="error">
|
|
43
|
+
|
|
44
|
+
Something went wrong, this is an **error**.
|
|
45
|
+
|
|
46
|
+
</Callout>
|
|
47
|
+
|
|
48
|
+
## Usage
|
|
49
|
+
|
|
50
|
+
Leave a blank line between the tags and the content so the inner text is parsed
|
|
51
|
+
as Markdown (an mdsvex requirement):
|
|
52
|
+
|
|
53
|
+
```svelte
|
|
54
|
+
<script>
|
|
55
|
+
import { Callout } from '$lib';
|
|
56
|
+
</script>
|
|
57
|
+
|
|
58
|
+
<Callout type="warn">Careful, this is a **warning** with a [link](/).</Callout>
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Types
|
|
62
|
+
|
|
63
|
+
| Type | Use for |
|
|
64
|
+
| ------------------ | -------------------------------- |
|
|
65
|
+
| `info` _(default)_ | General notes and asides |
|
|
66
|
+
| `tip` | Helpful suggestions |
|
|
67
|
+
| `success` | Confirmations and positive notes |
|
|
68
|
+
| `warn` / `warning` | Things to be careful about |
|
|
69
|
+
| `error` | Errors and destructive warnings |
|
|
70
|
+
|
|
71
|
+
## Custom title
|
|
72
|
+
|
|
73
|
+
Pass a `title` to override the default heading:
|
|
74
|
+
|
|
75
|
+
<Callout type="tip" title="Pro tip">
|
|
76
|
+
|
|
77
|
+
You can set any heading you like.
|
|
78
|
+
|
|
79
|
+
</Callout>
|
|
80
|
+
|
|
81
|
+
```svelte
|
|
82
|
+
<Callout type="tip" title="Pro tip">You can set any heading you like.</Callout>
|
|
83
|
+
```
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Cards
|
|
3
|
+
description: Rich, tappable cards for links and feature grids.
|
|
4
|
+
icon: layout-grid
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Card, CardGroup } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Cards
|
|
12
|
+
|
|
13
|
+
Cards present links and information as rich, tappable blocks, great for "next
|
|
14
|
+
steps" grids, feature overviews, and navigation.
|
|
15
|
+
|
|
16
|
+
## Card
|
|
17
|
+
|
|
18
|
+
A standalone `Card` with an icon, title, and description. Add `href` to make the
|
|
19
|
+
whole card a link (it gains a hover state and an arrow):
|
|
20
|
+
|
|
21
|
+
<Card title="Installation" icon="download" href="/installation">
|
|
22
|
+
|
|
23
|
+
Get Axerity running locally in a minute.
|
|
24
|
+
|
|
25
|
+
</Card>
|
|
26
|
+
|
|
27
|
+
## Card group
|
|
28
|
+
|
|
29
|
+
Wrap cards in a `CardGroup` to lay them out in a responsive grid. Use `cols` to
|
|
30
|
+
set the number of columns:
|
|
31
|
+
|
|
32
|
+
<CardGroup cols={2}>
|
|
33
|
+
<Card title="Quick Start" icon="rocket" href="/quick-start">
|
|
34
|
+
|
|
35
|
+
Write your first page in two minutes.
|
|
36
|
+
|
|
37
|
+
</Card>
|
|
38
|
+
<Card title="Markdown" icon="file-text" href="/writing/markdown">
|
|
39
|
+
|
|
40
|
+
Author content in Markdown and Svelte.
|
|
41
|
+
|
|
42
|
+
</Card>
|
|
43
|
+
<Card title="Components" icon="blocks" href="/components/callout">
|
|
44
|
+
|
|
45
|
+
Explore the component kit.
|
|
46
|
+
|
|
47
|
+
</Card>
|
|
48
|
+
<Card title="GitHub" icon="code" href="https://github.com/axerity/axerity">
|
|
49
|
+
|
|
50
|
+
Star the project on GitHub.
|
|
51
|
+
|
|
52
|
+
</Card>
|
|
53
|
+
|
|
54
|
+
</CardGroup>
|
|
55
|
+
|
|
56
|
+
## Horizontal
|
|
57
|
+
|
|
58
|
+
Set `horizontal` to place the icon beside the content instead of above it:
|
|
59
|
+
|
|
60
|
+
<Card title="Configuration" icon="tag" horizontal>
|
|
61
|
+
|
|
62
|
+
A horizontal card is handy in tighter layouts.
|
|
63
|
+
|
|
64
|
+
</Card>
|
|
65
|
+
|
|
66
|
+
## Usage
|
|
67
|
+
|
|
68
|
+
```svelte
|
|
69
|
+
<script>
|
|
70
|
+
import { Card, CardGroup } from '$lib';
|
|
71
|
+
</script>
|
|
72
|
+
|
|
73
|
+
<CardGroup cols={2}>
|
|
74
|
+
<Card title="Quick Start" icon="rocket" href="/quick-start">
|
|
75
|
+
Write your first page in two minutes.
|
|
76
|
+
</Card>
|
|
77
|
+
</CardGroup>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Props
|
|
81
|
+
|
|
82
|
+
| Component | Prop | Description |
|
|
83
|
+
| ----------- | ------------ | ------------------------------- |
|
|
84
|
+
| `CardGroup` | `cols` | Number of columns (default `2`) |
|
|
85
|
+
| `Card` | `title` | Card heading (required) |
|
|
86
|
+
| `Card` | `icon` | Optional Lucide icon name |
|
|
87
|
+
| `Card` | `href` | Makes the card a link |
|
|
88
|
+
| `Card` | `horizontal` | Lay the icon beside the content |
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Code Group
|
|
3
|
+
description: Switch between related code blocks in a single tabbed panel.
|
|
4
|
+
icon: code
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { CodeGroup } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Code Group
|
|
12
|
+
|
|
13
|
+
A code group collapses several code blocks into one panel with a tab for each.
|
|
14
|
+
It is handy for showing the same step across package managers or languages. Each
|
|
15
|
+
tab takes its label from the block's `title`, so give every block one.
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
<CodeGroup>
|
|
20
|
+
|
|
21
|
+
```bash title="npm"
|
|
22
|
+
npm install axerity
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
```bash title="pnpm"
|
|
26
|
+
pnpm add axerity
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
```bash title="yarn"
|
|
30
|
+
yarn add axerity
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
</CodeGroup>
|
|
34
|
+
|
|
35
|
+
## Usage
|
|
36
|
+
|
|
37
|
+
Wrap the blocks in `<CodeGroup>` and leave a blank line around each one so the
|
|
38
|
+
Markdown is parsed:
|
|
39
|
+
|
|
40
|
+
````md
|
|
41
|
+
<CodeGroup>
|
|
42
|
+
|
|
43
|
+
```bash title="npm"
|
|
44
|
+
npm install axerity
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
```bash title="pnpm"
|
|
48
|
+
pnpm add axerity
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
</CodeGroup>
|
|
52
|
+
````
|
|
53
|
+
|
|
54
|
+
The `title` on each block becomes its tab. Without a title a block falls back to
|
|
55
|
+
`Tab 1`, `Tab 2`, and so on.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Columns
|
|
3
|
+
description: Lay content out in a responsive grid.
|
|
4
|
+
icon: columns-3
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Columns, Card } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Columns
|
|
12
|
+
|
|
13
|
+
Columns place their children in an even grid. On narrow screens the grid
|
|
14
|
+
collapses to a single column so nothing gets cramped. Set `cols` to choose how
|
|
15
|
+
many columns to show on wider screens.
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
<Columns cols={2}>
|
|
20
|
+
<Card title="Fast" icon="zap">Static output that loads instantly.</Card>
|
|
21
|
+
<Card title="Simple" icon="feather">Write Markdown, get a site.</Card>
|
|
22
|
+
</Columns>
|
|
23
|
+
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
```svelte
|
|
27
|
+
<script>
|
|
28
|
+
import { Columns, Card } from '$lib';
|
|
29
|
+
</script>
|
|
30
|
+
|
|
31
|
+
<Columns cols={3}>
|
|
32
|
+
<Card title="One" />
|
|
33
|
+
<Card title="Two" />
|
|
34
|
+
<Card title="Three" />
|
|
35
|
+
</Columns>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Props
|
|
39
|
+
|
|
40
|
+
| Prop | Type | Description |
|
|
41
|
+
| ------ | -------- | ------------------------------------------- |
|
|
42
|
+
| `cols` | `number` | Columns on screens 640px and up (default 2) |
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Frame
|
|
3
|
+
description: Wrap an image, video, or component in a styled border with a caption.
|
|
4
|
+
icon: image
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Frame } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Frame
|
|
12
|
+
|
|
13
|
+
A frame puts a soft border and padding around whatever you place inside it, so a
|
|
14
|
+
screenshot or diagram sits apart from the surrounding text instead of bleeding
|
|
15
|
+
into it. Add a caption to label what the reader is looking at.
|
|
16
|
+
|
|
17
|
+
Click a frame to open it full screen, then click anywhere or press `Escape` to
|
|
18
|
+
close. Pass `zoom={false}` to turn that off.
|
|
19
|
+
|
|
20
|
+
## With a caption
|
|
21
|
+
|
|
22
|
+
<Frame caption="The dashboard after a fresh install">
|
|
23
|
+
<img src="https://placehold.co/720x360/png" alt="Dashboard screenshot" />
|
|
24
|
+
</Frame>
|
|
25
|
+
|
|
26
|
+
## Without a caption
|
|
27
|
+
|
|
28
|
+
<Frame>
|
|
29
|
+
<img src="https://placehold.co/720x240/png" alt="A wide banner" />
|
|
30
|
+
</Frame>
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
Frame works with any content, an image, a video, or another component:
|
|
35
|
+
|
|
36
|
+
```svelte
|
|
37
|
+
<script>
|
|
38
|
+
import { Frame } from '$lib';
|
|
39
|
+
</script>
|
|
40
|
+
|
|
41
|
+
<Frame caption="The dashboard after a fresh install">
|
|
42
|
+
<img src="/screenshots/dashboard.png" alt="Dashboard" />
|
|
43
|
+
</Frame>
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Props
|
|
47
|
+
|
|
48
|
+
| Prop | Type | Description |
|
|
49
|
+
| --------- | --------- | -------------------------------------- |
|
|
50
|
+
| `caption` | `string` | Text shown below the framed content |
|
|
51
|
+
| `zoom` | `boolean` | Click to open full screen (default on) |
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Icon
|
|
3
|
+
description: Drop a Lucide icon inline in a sentence or heading.
|
|
4
|
+
icon: flag
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Icon } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Icon
|
|
12
|
+
|
|
13
|
+
Use the `Icon` component to place a single glyph anywhere in your text. It pulls
|
|
14
|
+
from [Lucide](https://lucide.dev/icons), so any icon name on that site works here.
|
|
15
|
+
|
|
16
|
+
## Inline
|
|
17
|
+
|
|
18
|
+
Icons sit on the text baseline, so they read well inside a sentence. Save your
|
|
19
|
+
work often <Icon icon="save" /> and ship when the tests pass <Icon icon="check" color="oklch(0.6 0.16 155)" />.
|
|
20
|
+
|
|
21
|
+
## Sizing
|
|
22
|
+
|
|
23
|
+
Pass `size` in pixels. The default is 16.
|
|
24
|
+
|
|
25
|
+
<Icon icon="flag" size={20} /> <Icon icon="flag" size={28} /> <Icon icon="flag" size={36} />
|
|
26
|
+
|
|
27
|
+
## Color
|
|
28
|
+
|
|
29
|
+
By default an icon takes the color of the surrounding text. Pass `color` with any
|
|
30
|
+
CSS color to override it.
|
|
31
|
+
|
|
32
|
+
<Icon icon="heart" color="oklch(0.62 0.22 25)" size={24} />
|
|
33
|
+
<Icon icon="star" color="oklch(0.7 0.16 75)" size={24} />
|
|
34
|
+
<Icon icon="droplet" color="oklch(0.62 0.2 250)" size={24} />
|
|
35
|
+
|
|
36
|
+
## Usage
|
|
37
|
+
|
|
38
|
+
```svelte
|
|
39
|
+
<script>
|
|
40
|
+
import { Icon } from '$lib';
|
|
41
|
+
</script>
|
|
42
|
+
|
|
43
|
+
Save your work <Icon icon="save" /> often.
|
|
44
|
+
|
|
45
|
+
<Icon icon="flag" size={32} color="oklch(0.62 0.22 25)" />
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Props
|
|
49
|
+
|
|
50
|
+
| Prop | Type | Description |
|
|
51
|
+
| ------- | -------- | ----------------------------------- |
|
|
52
|
+
| `icon` | `string` | Lucide icon name (required) |
|
|
53
|
+
| `size` | `number` | Size in pixels (default 16) |
|
|
54
|
+
| `color` | `string` | Any CSS color (defaults to inherit) |
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Keyboard
|
|
3
|
+
description: Show keyboard keys and shortcuts.
|
|
4
|
+
icon: keyboard
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Kbd } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Keyboard
|
|
12
|
+
|
|
13
|
+
Wrap a key name in `Kbd` to render it as a physical keyboard key. It is handy
|
|
14
|
+
for documenting shortcuts inline.
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
Press <Kbd>⌘</Kbd> <Kbd>K</Kbd> to search, or <Kbd>Esc</Kbd> to close a dialog.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```svelte
|
|
23
|
+
<script>
|
|
24
|
+
import { Kbd } from '$lib';
|
|
25
|
+
</script>
|
|
26
|
+
|
|
27
|
+
Save with <Kbd>Ctrl</Kbd> <Kbd>S</Kbd>.
|
|
28
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"title": "Components",
|
|
3
|
+
"icon": "blocks",
|
|
4
|
+
"pages": [
|
|
5
|
+
"callout",
|
|
6
|
+
"cards",
|
|
7
|
+
"accordion",
|
|
8
|
+
"tabs",
|
|
9
|
+
"code-group",
|
|
10
|
+
"tooltip",
|
|
11
|
+
"tree",
|
|
12
|
+
"icon",
|
|
13
|
+
"frame",
|
|
14
|
+
"video",
|
|
15
|
+
"steps",
|
|
16
|
+
"columns",
|
|
17
|
+
"badge",
|
|
18
|
+
"kbd",
|
|
19
|
+
"update",
|
|
20
|
+
"roadmap",
|
|
21
|
+
"type-table",
|
|
22
|
+
"api",
|
|
23
|
+
"webhooks",
|
|
24
|
+
"websockets"
|
|
25
|
+
]
|
|
26
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Roadmap
|
|
3
|
+
description: Show what you are building, in progress, and shipped.
|
|
4
|
+
icon: map
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Roadmap, RoadmapItem } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Roadmap
|
|
12
|
+
|
|
13
|
+
A roadmap is a list of items, each with a status and an optional target. Use it
|
|
14
|
+
on a public roadmap page so readers can see what is planned, what you are working
|
|
15
|
+
on now, and what already shipped.
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
<Roadmap>
|
|
20
|
+
|
|
21
|
+
<RoadmapItem title="Versioned content" status="shipped" eta="June 2026">
|
|
22
|
+
|
|
23
|
+
Keep separate v1 and v2 content trees with a switcher that follows the reader
|
|
24
|
+
across versions.
|
|
25
|
+
|
|
26
|
+
</RoadmapItem>
|
|
27
|
+
|
|
28
|
+
<RoadmapItem title="Search filters" status="in-progress" eta="Q3 2026">
|
|
29
|
+
|
|
30
|
+
Filter results by section and tag.
|
|
31
|
+
|
|
32
|
+
</RoadmapItem>
|
|
33
|
+
|
|
34
|
+
<RoadmapItem title="Offline reading" status="exploring">
|
|
35
|
+
|
|
36
|
+
Bundle pages into a service worker so docs stay available without a connection.
|
|
37
|
+
|
|
38
|
+
</RoadmapItem>
|
|
39
|
+
|
|
40
|
+
<RoadmapItem title="PDF export" status="planned" />
|
|
41
|
+
|
|
42
|
+
</Roadmap>
|
|
43
|
+
|
|
44
|
+
## Usage
|
|
45
|
+
|
|
46
|
+
Wrap the items in `<Roadmap>` and give each `<RoadmapItem>` a `title` and a
|
|
47
|
+
`status`. The body is optional, and so is the `eta`.
|
|
48
|
+
|
|
49
|
+
```svelte
|
|
50
|
+
<script>
|
|
51
|
+
import { Roadmap, RoadmapItem } from '$lib';
|
|
52
|
+
</script>
|
|
53
|
+
|
|
54
|
+
<Roadmap>
|
|
55
|
+
<RoadmapItem title="Versioned content" status="shipped" eta="June 2026">
|
|
56
|
+
Separate content trees with a version switcher.
|
|
57
|
+
</RoadmapItem>
|
|
58
|
+
|
|
59
|
+
<RoadmapItem title="Search filters" status="in-progress" eta="Q3 2026">
|
|
60
|
+
Filter results by section and tag.
|
|
61
|
+
</RoadmapItem>
|
|
62
|
+
|
|
63
|
+
<RoadmapItem title="PDF export" status="planned" />
|
|
64
|
+
</Roadmap>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Status
|
|
68
|
+
|
|
69
|
+
Each status has its own color and label.
|
|
70
|
+
|
|
71
|
+
| Status | Label |
|
|
72
|
+
| ------------- | ----------- |
|
|
73
|
+
| `planned` | Planned |
|
|
74
|
+
| `exploring` | Exploring |
|
|
75
|
+
| `in-progress` | In progress |
|
|
76
|
+
| `shipped` | Shipped |
|
|
77
|
+
|
|
78
|
+
## Props
|
|
79
|
+
|
|
80
|
+
### RoadmapItem
|
|
81
|
+
|
|
82
|
+
| Prop | Type | Description |
|
|
83
|
+
| -------- | -------- | --------------------------------------------------- |
|
|
84
|
+
| `title` | `string` | The item name |
|
|
85
|
+
| `status` | `string` | `planned`, `exploring`, `in-progress`, or `shipped` |
|
|
86
|
+
| `eta` | `string` | Optional target, e.g. `Q3 2026` |
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Steps
|
|
3
|
+
description: Numbered, vertical walkthroughs.
|
|
4
|
+
icon: list
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<script>
|
|
8
|
+
import { Steps, Step } from '$lib';
|
|
9
|
+
</script>
|
|
10
|
+
|
|
11
|
+
# Steps
|
|
12
|
+
|
|
13
|
+
Steps lay out a sequence of instructions as a numbered, vertical walkthrough.
|
|
14
|
+
Numbering is automatic.
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
<Steps>
|
|
19
|
+
<Step title="Install">
|
|
20
|
+
|
|
21
|
+
Add Axerity to your project:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pnpm add axerity
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
</Step>
|
|
28
|
+
<Step title="Create a page">
|
|
29
|
+
|
|
30
|
+
Drop a Markdown file into `src/content/docs`.
|
|
31
|
+
|
|
32
|
+
</Step>
|
|
33
|
+
<Step title="Run it">
|
|
34
|
+
|
|
35
|
+
Start the dev server with `pnpm dev` and open the page.
|
|
36
|
+
|
|
37
|
+
</Step>
|
|
38
|
+
|
|
39
|
+
</Steps>
|
|
40
|
+
|
|
41
|
+
## Usage
|
|
42
|
+
|
|
43
|
+
Wrap `Step`s in `Steps`. Each `Step` takes an optional `title`. Keep the blank
|
|
44
|
+
lines around content so the Markdown is parsed:
|
|
45
|
+
|
|
46
|
+
````md
|
|
47
|
+
<script>
|
|
48
|
+
import { Steps, Step } from '$lib';
|
|
49
|
+
</script>
|
|
50
|
+
|
|
51
|
+
<Steps>
|
|
52
|
+
<Step title="Install">
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pnpm add axerity
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
</Step>
|
|
59
|
+
<Step title="Run it">
|
|
60
|
+
|
|
61
|
+
Start the dev server.
|
|
62
|
+
|
|
63
|
+
</Step>
|
|
64
|
+
|
|
65
|
+
</Steps>
|
|
66
|
+
````
|
|
67
|
+
|
|
68
|
+
## Props
|
|
69
|
+
|
|
70
|
+
| Component | Prop | Description |
|
|
71
|
+
| --------- | ------- | ----------------------- |
|
|
72
|
+
| `Step` | `title` | Step heading (optional) |
|