Skip to content

Commit 2153a04

Browse files
committed
added more cli instructions and color to links
1 parent 9ac6a50 commit 2153a04

File tree

2 files changed

+27
-4
lines changed
  • apps/website/src

2 files changed

+27
-4
lines changed

apps/website/src/components/mdx-components/index.tsx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ export const components: Record<string, any> = {
1919
</p>
2020
);
2121
}),
22+
a: component$<PropsOf<'a'>>(({ ...props }) => {
23+
return (
24+
<a {...props} class={[cn('text-primary', props.class)]}>
25+
<Slot />
26+
</a>
27+
);
28+
}),
2229
h1: component$<PropsOf<'h1'>>(({ ...props }) => {
2330
return (
2431
<h1

apps/website/src/routes/docs/styled/(getting-started)/install/index.mdx

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,30 @@ title: 'Qwik UI | Styled Kit - Installation'
44

55
# Using the Styled Kit
66

7-
## CLI
8-
9-
## Step 0: Skip everthing below, just use the cli 🚀
7+
## Skip the manual steps and just use the cli 🚀
108

119
Simply run the following command:
1210

1311
```zsh
14-
npx qwik-ui init
12+
pnpm dlx qwik-ui init
13+
```
14+
15+
(or "**npx qwik-ui init**" if you prefer npm)
16+
17+
This will help you install tailwind, create a `qwik-ui.config.json` file and modify your root/global css and tailwind config files with the necessary Qwik UI design system variables and values ([see below](#manual-installation))
18+
19+
### Generating components using the CLI
20+
21+
When you want to add a component you can run:
22+
23+
```zsh
24+
pnpm qwik-ui add
25+
```
26+
27+
Or if you know a specific component you want to add, let's say "`input`", you can run:
28+
29+
```zsh
30+
pnpm qwik-ui add input
1531
```
1632

1733
## Manual installation

0 commit comments

Comments
 (0)