2
2
3
3
> Opinionated starter template for SvelteKit
4
4
5
- The Svelte-world is akin to the universes of
5
+ Svelte-world is akin to the fiery aftermath when the universes of
6
6
[ Mad Max] ( https://en.wikipedia.org/wiki/Mad_Max:_Fury_Road ) and
7
- [ Split] ( < https://en.wikipedia.org/wiki/Split_(2016_American_film) > ) collided - full of peril,
8
- violent sandstorms and new beginnings with a touch of disassociative personality disorder.
7
+ [ Split] ( < https://en.wikipedia.org/wiki/Split_(2016_American_film) > ) collide - full of peril, violent
8
+ sandstorms and new beginnings with a touch of disassociative personality disorder.
9
9
10
10
To help navigate through this madness, just like how Moses parted the Red Sea, behold the emergence
11
11
of this repo. Cue angels singing. The best way to describe this is it's like a brick-layer - but
@@ -16,19 +16,19 @@ So let's get started.
16
16
17
17
## Usage
18
18
19
- ### Create Svelte
19
+ ### Step 1: Create Svelte
20
20
21
21
Generate the base template using ` create-svelte ` with these recommended options:
22
22
23
- - [x] Skeleton project
23
+ - [x] Skeleton or Library project
24
24
- [x] JavaScript with JSDoc comments
25
- - [x] ESLint, Prettier and Playwight/Vitest
25
+ - [x] Include ESLint, Prettier and Playwight
26
26
27
27
```
28
28
$ npm create svelte@latest my-app
29
29
```
30
30
31
- ### Run combo-patcher
31
+ ### Step 2: Run the combo-patcher
32
32
33
33
Then, layer the patches based on the last-known SvelteKit decisions. This uses
34
34
[ zx] ( https://github.com/google/zx ) , so make sure that's installed.
@@ -37,7 +37,7 @@ Then, layer the patches based on the last-known SvelteKit decisions. This uses
37
37
$ zx https://cdn.jsdelivr.net/gh/zerodevx/svelte-starter@2/index.mjs my-app
38
38
```
39
39
40
- ### Update dependencies
40
+ ### Step 3: Update dependencies
41
41
42
42
Finally, apply the finishing touches.
43
43
@@ -96,14 +96,22 @@ module.exports = {
96
96
Seriously, don't use SSR unless you really need to. Installs ` adapter-static ` and adds sensible
97
97
defaults.
98
98
99
- ### Custom fonts
99
+ ### Versioning
100
+
101
+ Use the ` version ` from ` package.json ` in SvelteKit's native versioning system, like so:
102
+
103
+ ``` js
104
+ import { version } from ' $app/environment' // `version` string from `package.json`
105
+ ```
106
+
107
+ ### Fonts
100
108
101
109
Use ` @fontsource-variable ` for self-hosted open-source fonts.
102
110
103
- ### Custom icons
111
+ ### Icons
104
112
105
113
Use ` @iconify/tailwind ` plugin for high-performance css-only icons. Apply icon classes using
106
- ` icon-[{prefix}--{name}] ` . Install icon sets at ` @iconify-json/{name } ` . Only icons you use will be
114
+ ` icon-[{prefix}--{name}] ` . Install icon sets at ` @iconify-json/{prefix } ` . Only icons you use will be
107
115
included in your build. Read more at
108
116
[ Iconify] ( https://github.com/iconify/iconify/tree/main/plugins/tailwind ) .
109
117
0 commit comments