From 2c1c4925b7f4257413bb16dbc7a08488d736e203 Mon Sep 17 00:00:00 2001 From: Luca Bonavita Date: Sat, 18 Jul 2020 15:16:37 +0100 Subject: [PATCH] Mention @sveltejs/svelte-repl and add explicit instructions --- site/README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/site/README.md b/site/README.md index 83d08a881b..892b8e1249 100644 --- a/site/README.md +++ b/site/README.md @@ -54,13 +54,22 @@ To build the website, run `npm run sapper`. The output can be found in `__sapper Tests can be run using `npm run test`. -## Working With Components - -svelte.dev uses the package [`@sveltejs/site-kit`](https://github.com/sveltejs/site-kit) to import it's UI components - -clone [`@sveltejs/site-kit`](https://github.com/sveltejs/site-kit) locally - -[`npm-link`](https://docs.npmjs.com/cli/link) your local site-kit to `svelte/site` to see your component changes reflected locally. +## Linking `@sveltejs/site-kit` and `@sveltejs/site-repl` + +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`. + +In order to work on features that depend on those packages, you need to [link](https://docs.npmjs.com/cli/link) their repositories: + +- `cd ` +- `git clone https://github.com/sveltejs/site-kit` +- `git clone https://github.com/sveltejs/svelte-repl` +- `cd /site-kit` +- `npm link` +- `cd /svelte-repl` +- `npm link` +- `cd /site` +- `npm link @sveltejs/site-kit` +- `npm link @sveltejs/svelte-repl`