Skip to content

Commit 724f9e7

Browse files
getting-start-text (#837)
- fixed some wording - adding note referencing setup darkmode - cleaned up content to 'git up and running quicker' tabs
1 parent 8f98b4a commit 724f9e7

1 file changed

Lines changed: 22 additions & 17 deletions

File tree

  • docs/src/routes/docs/getting-started

docs/src/routes/docs/getting-started/+page.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22
title: Getting Started
33
---
44

5-
LayerChart can be used standlone, or integrates nicely with other frameworks and design systems.
6-
7-
Provides built-in first class support for [:icon{name="logos:tailwindcss-icon" class="text-xs"} Tailwind 4](https://tailwindcss.com/),
8-
but is completely optional. The library also works seamlessly with vanilla CSS, inline styles, and [:icon{name="logos:unocss"} unoCSS](https://unocss.dev/).
5+
LayerChart provides built-in first class support for [:icon{name="logos:tailwindcss-icon" class="text-xs"} Tailwind 4](https://tailwindcss.com/),
6+
but this is completely optional. The library also works seamlessly with vanilla CSS, inline styles, and [:icon{name="logos:unocss"} unoCSS](https://unocss.dev/). It can be used standlone, or integrates nicely with other frameworks and design systems.
97

108
::steps
119

1210
## Create a new project or [git a project](#git-up-and-running-even-quicker)
1311

14-
Use the Svelte CLI to generate a new SvelteKit project, or continue with an existing project.
12+
Use the Svelte `sv` CLI to generate a new SvelteKit project.
1513

1614
:::tabs{key="bundler"}
1715

@@ -53,7 +51,7 @@ Use the Svelte CLI to generate a new SvelteKit project, or continue with an exis
5351
:::
5452

5553
::note
56-
To add Tailwind to an existing project you can `npm sv add tailwindcss`
54+
To add Tailwind to an existing Sveltekit project you can `npx sv add tailwindcss`
5755
::
5856

5957
## Import `layerchart` with your package manager of choice.
@@ -94,7 +92,7 @@ To add Tailwind to an existing project you can `npm sv add tailwindcss`
9492

9593
## Apply CSS
9694

97-
Out of the box LayerChart will use [`currentColor`](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/color_value#currentcolor_keyword) as the default color, but you can customize the CSS globally with a few CSS variables.
95+
Out of the box LayerChart will use [`currentColor`](https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Values/color_value#currentcolor_keyword) as the default primary color, but you can customize the CSS globally with a few CSS variables.
9896

9997
```css title="app.css"
10098
.lc-root-container {
@@ -111,6 +109,10 @@ Out of the box LayerChart will use [`currentColor`](https://developer.mozilla.or
111109
}
112110
```
113111

112+
::note
113+
If you wish to apply darkmode defaults, see the [dark mode](/docs/guides/styles#dark-mode) section of the styling guide.
114+
::
115+
114116
or with a single `.css` import, Layerchart [provides](https://github.com/techniq/layerchart/tree/next/packages/layerchart/src/lib/styles) theming conventions for many popular UI frameworks.
115117

116118
:::tabs{key="framework"}
@@ -201,49 +203,52 @@ Starter [project repos](https://github.com/techniq/layerchart/tree/next/examples
201203
::tab{label="shadcn-svelte" icon="custom-brands:shadcnsvelte"}
202204
[shadcn-svelte](https://www.shadcn-svelte.com/)
203205

204-
v1:
206+
- v1:
205207
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/shadcn-svelte-1" size="sm" icon="lucide:github"}
206208
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/shadcn-svelte-1" size="sm" icon="simple-icons:stackblitz"}
207209
::
208210

209211
::tab{label="Skeleton" icon="custom-brands:skeleton"}
210212
[Skeleton](https://www.skeleton.dev/)
211213

212-
v3:
214+
- v3:
213215
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/skeleton-3" size="sm" icon="lucide:github"}
214216
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/skeleton-3" size="sm" icon="simple-icons:stackblitz"}
215-
216-
v4:
217+
- v4:
217218
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/skeleton-4" size="sm" icon="lucide:github"}
218219
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/skeleton-4" size="sm" icon="simple-icons:stackblitz"}
219220
::
220221

221222
::tab{label="Svelte UX" icon="custom-brands:svelteux"}
222223
[Svelte UX](https://svelte-ux.techniq.dev/)
223224

224-
v2:
225+
- v2:
225226
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/svelte-ux-2" size="sm" icon="lucide:github"}
226227
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/svelte-ux-2" size="sm" icon="simple-icons:stackblitz"}
227228
::
228229

229230
::tab{label="daisyUI" icon="custom-brands:daisyUI"}
230231
[daisyUI](https://daisyui.com/)
231232

232-
v5:
233+
- v5:
233234
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/daisyui-5" size="sm" icon="lucide:github"}
234235
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/daisyui-5" size="sm" icon="simple-icons:stackblitz"}
235236
::
236237

237238
::tab{label="UnoCSS" icon="logos:unocss"}
238239
[UnoCSS](https://unocss.dev/)
239240

240-
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/unocss" size="sm" icon="lucide:github"}
241-
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/unocss-1" size="sm" icon="simple-icons:stackblitz"}
241+
-
242+
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/unocss" size="sm" icon="lucide:github"}
243+
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/unocss-1" size="sm" icon="simple-icons:stackblitz"}
242244
::
243245

244246
::tab{label="Vanilla CSS" icon="vscode-icons:file-type-css"}
245-
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/standalone" size="sm" icon="lucide:github"}
246-
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/standalone" size="sm" icon="simple-icons:stackblitz"}
247+
Vanilla CSS
248+
249+
-
250+
:button{label="Source" href="https://github.com/techniq/layerchart/tree/docs-v2/examples/standalone" size="sm" icon="lucide:github"}
251+
:button{label="Open in StackBlitz" href="https://stackblitz.com/github/techniq/layerchart/tree/docs-v2/examples/standalone" size="sm" icon="simple-icons:stackblitz"}
247252
::
248253

249254
:::

0 commit comments

Comments
 (0)