You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
svelte/site
Fabrizio Calderan 2c7986034d
[docs] A reference of the field variable is missing in the sidebar (#6815)
3 years ago
..
content [docs] A reference of the field variable is missing in the sidebar (#6815) 3 years ago
migrations [site] migrate to SvelteKit (#6811) 3 years ago
scripts [site] convert to ESM (#6795) 3 years ago
src [docs] fix redirects from legacy /repl page (#6894) 3 years ago
static [docs] Use a simpler demo for the first actions tutorial (#5014) (#6962) 3 years ago
test/utils [site] migrate to SvelteKit (#6811) 3 years ago
.dockerignore [site] migrate to SvelteKit (#6811) 3 years ago
.env.example [site] migrate to SvelteKit (#6811) 3 years ago
.eslintrc.cjs [site] convert to ESM (#6795) 3 years ago
.gcloudignore site: use gcloud CLI to build Docker image 6 years ago
Dockerfile [site] migrate to SvelteKit (#6811) 3 years ago
Makefile [site] migrate to SvelteKit (#6811) 3 years ago
README.md [site] migrate to SvelteKit (#6811) 3 years ago
config.js Site: use pure javascript slugification library 6 years ago
docker-compose.yml [site] migrate to SvelteKit (#6811) 3 years ago
package-lock.json site: disable Vite vendor chunk (#6935) 3 years ago
package.json site: disable Vite vendor chunk (#6935) 3 years ago
svelte.config.js site: disable Vite vendor chunk (#6935) 3 years ago

README.md

Running locally

Set up the site sub-project:

git clone https://github.com/sveltejs/svelte.git
cd site
npm ci
npm run dev

and navigate to localhost:3000.

The first time you run the site locally, it will update the list of Contributors and REPL dependencies. After this it won't run again unless you force it by running:

npm run update

Running using the local copy of Svelte

By default, the REPL will fetch the most recent version of Svelte from https://unpkg.com/svelte. When running the site locally, you can also use your local copy of Svelte.

To produce the proper browser-compatible UMD build of the compiler, you will need to run npm run build (or npm run dev) in the root of this repository with the PUBLISH environment variable set to any non-empty string:

git clone https://github.com/sveltejs/svelte.git
cd svelte
npm ci
PUBLISH=1 npm run build
cd site
npm ci
npm run dev

Then visit the REPL at localhost:3000/repl?version=local. Please note that the local REPL only works with npm run dev and not when building the site for production usage.

REPL GitHub integration

In order for the REPL's GitHub integration to work properly when running locally, you will need to:

  • create a GitHub OAuth app:
    • set Authorization callback URL to http://localhost:3000/auth/callback;
    • set Application name as you like, and Homepage URL as http://localhost:3000/;
    • create the app and take note of Client ID and Client Secret
  • in this repo, create site/.env containing:
    GITHUB_CLIENT_ID=[your app's Client ID]
    GITHUB_CLIENT_SECRET=[your app's Client Secret]
    BASEURL=http://localhost:3000
    

Building the site

To build the website, run npm run build. The output can be found in build.

Testing

Tests can be run using npm run test.

Linking @sveltejs/site-kit and @sveltejs/svelte-repl

This site depends on @sveltejs/site-kit (a collection of styles, components and icons used in common by *.svelte.dev websites), and @sveltejs/svelte-repl.

In order to work on features that depend on those packages, you need to link their repositories:

  • cd <somewhere>
  • git clone https://github.com/sveltejs/site-kit
  • git clone https://github.com/sveltejs/svelte-repl
  • cd <somewhere>/site-kit
  • npm link
  • cd <somewhere>/svelte-repl
  • npm link
  • cd <svelte-repo>/site
  • npm link @sveltejs/site-kit
  • npm link @sveltejs/svelte-repl

Translating the API docs

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.

If we need to translate the API documentation to a language using unicode chars, we can setup this app to export the correct anchors by setting up SLUG_PRESERVE_UNICODE to true in config.js.