0
0
mirror of https://github.com/sveltejs/svelte.git synced 2024-12-01 17:30:59 +01:00
svelte/site
2019-04-22 06:45:29 -04:00
..
content remove superfluous example 2019-04-21 20:41:50 -04:00
cypress
scripts redo thumbnails as jpgs 2019-04-21 20:41:37 -04:00
src Merge pull request #2469 from sveltejs/better-site-errors 2019-04-22 06:45:29 -04:00
static makes links a bit more obvious, per #2445. also tweaks some /blog css 2019-04-21 22:13:35 -04:00
test/utils Support slug translations in the API docs 2019-04-17 00:42:53 +01:00
.dockerignore site: use gcloud CLI to build Docker image 2019-04-22 01:59:48 -04:00
.eslintrc.json
.gcloudignore site: use gcloud CLI to build Docker image 2019-04-22 01:59:48 -04:00
.travis.yml
appveyor.yml
config.js Support slug translations in the API docs 2019-04-17 00:42:53 +01:00
cypress.json
Dockerfile Merge pull request #2479 from sveltejs/gcloud-builds 2019-04-22 06:07:35 -04:00
Makefile site: use gcloud CLI to build Docker image 2019-04-22 01:59:48 -04:00
package-lock.json Merge branch 'master' into site/deps 2019-04-22 06:05:57 -04:00
package.json Merge branch 'master' into site/deps 2019-04-22 06:05:57 -04:00
README.md Support slug translations in the API docs 2019-04-17 00:42:53 +01:00
rollup.config.js

Running locally

Set up the project:

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

Start the server with npm run dev, and navigate to localhost:3000.

Using a local copy of Svelte

By default, the REPL will fetch the most recent version of Svelte from https://unpkg.com/svelte. To use the local copy of the compiler and runtime from this repo, you can navigate to localhost:3000/repl?version=local. To produce the proper browser-compatible UMD build, you will need to run npm run build with the PUBLISH environment variable set (to any non-empty string).

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 its authorization callback URL to http://localhost:3000/auth/callback, and in this project, create site/.env containing:

GITHUB_CLIENT_ID=[your app's client id]
GITHUB_CLIENT_SECRET=[your app's client secret]
BASEURL=http://localhost:3000

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 and SLUG_LANG to the ISO 639-1 two-letter language code of your choice in config.js.