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 5c365108ac
fix italicisation
5 years ago
..
content fix italicisation 5 years ago
migrations Use database for REPL, update URL structure (#2572) 6 years ago
scripts docs: adding a quick comment 5 years ago
src use SVG godaddy logo instead 5 years ago
static site: remove unused files 5 years ago
test/utils Site: use pure javascript slugification library 6 years ago
.dockerignore site: use gcloud CLI to build Docker image 6 years ago
.env.example Use database for REPL, update URL structure (#2572) 6 years ago
.eslintrc.js fix ESLint and eslint-plugin-svelte3 stuff 5 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 site: update Dockerfile to Node 12 5 years ago
Makefile site: deploy with --platform managed 5 years ago
README.md Update site README for local REPL (#3078) 5 years ago
appveyor.yml Bring svelte.technology source into main repo 6 years ago
config.js Site: use pure javascript slugification library 6 years ago
cypress.json Bring svelte.technology source into main repo 6 years ago
package-lock.json site: update deps 5 years ago
package.json site: update deps 5 years ago
rollup.config.js some linting and tidying 6 years ago

README.md

Running locally

Set up the project:

git clone https://github.com/sveltejs/svelte.git
cd svelte
npm ci
PUBLISH=1 npm run build
cd 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. 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.

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 sapper. The output can be found in __sapper__/build.

Testing

Tests can be run using npm run test.

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.