Skip to content

Commit 25e9e68

Browse files
benschacmindrones
andauthored
site: explain how to use site-kit and site-repl (#5163)
Co-authored-by: Luca Bonavita <[email protected]>
1 parent ec0f79c commit 25e9e68

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

site/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,26 @@ To build the website, run `npm run sapper`. The output can be found in `__sapper
5353

5454
Tests can be run using `npm run test`.
5555

56+
57+
## Linking `@sveltejs/site-kit` and `@sveltejs/site-repl`
58+
59+
This site depends on `@sveltejs/site-kit`, a collection of styles, components and icons used in common by *.svelte.dev websites, and `@sveltejs/site-repl`.
60+
61+
In order to work on features that depend on those packages, you need to [link](https://docs.npmjs.com/cli/link) their repositories:
62+
63+
- `cd <somewhere>`
64+
- `git clone https://github.com/sveltejs/site-kit`
65+
- `git clone https://github.com/sveltejs/svelte-repl`
66+
- `cd <somewhere>/site-kit`
67+
- `npm link`
68+
- `cd <somewhere>/svelte-repl`
69+
- `npm link`
70+
- `cd <svelte-repo>/site`
71+
- `npm link @sveltejs/site-kit`
72+
- `npm link @sveltejs/svelte-repl`
73+
74+
75+
5676
## Translating the API docs
5777

5878
Anchors are automatically generated using headings in the documentation and by default (for the english language) they are latinised to make sure the URL is always conforming to RFC3986.

0 commit comments

Comments
 (0)