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
Rich Harris 2fdf7d4e91
Merge pull request #2554 from thollander/fix/mobile-docs-sidebar
6 years ago
..
content simplify example further 6 years ago
cypress Bring svelte.technology source into main repo 6 years ago
scripts site: use master branch of template in svelte-app 6 years ago
src Merge pull request #2554 from thollander/fix/mobile-docs-sidebar 6 years ago
static Merge pull request #2529 from sveltejs/examples-loader-and-cache-2527 6 years ago
test/utils Support slug translations in the API docs 6 years ago
.dockerignore site: use gcloud CLI to build Docker image 6 years ago
.eslintrc.json site: bump eslint-plugin-svelte3 6 years ago
.gcloudignore site: use gcloud CLI to build Docker image 6 years ago
.travis.yml Bring svelte.technology source into main repo 6 years ago
Dockerfile Merge pull request #2479 from sveltejs/gcloud-builds 6 years ago
Makefile site: use gcloud CLI to build Docker image 6 years ago
README.md Support slug translations in the API docs 6 years ago
appveyor.yml Bring svelte.technology source into main repo 6 years ago
config.js Support slug translations in the API docs 6 years ago
cypress.json Bring svelte.technology source into main repo 6 years ago
package-lock.json Merge branch 'master' into site/polka 6 years ago
package.json Merge branch 'master' into site/polka 6 years ago
rollup.config.js Add a tutorial (#2132) 6 years ago

README.md

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.