|
5 years ago | |
---|---|---|
.. | ||
content | 5 years ago | |
cypress | 6 years ago | |
migrations | 5 years ago | |
scripts | 5 years ago | |
src | 5 years ago | |
static | 5 years ago | |
test/utils | 5 years ago | |
.dockerignore | 5 years ago | |
.env.example | 5 years ago | |
.eslintrc.json | 5 years ago | |
.gcloudignore | 5 years ago | |
.travis.yml | 6 years ago | |
Dockerfile | 5 years ago | |
Makefile | 5 years ago | |
README.md | 5 years ago | |
appveyor.yml | 6 years ago | |
config.js | 5 years ago | |
cypress.json | 6 years ago | |
package-lock.json | 5 years ago | |
package.json | 5 years ago | |
rollup.config.js | 5 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
Authorization callback URL
tohttp://localhost:3000/auth/callback
; - set
Application name
as you like, andHomepage URL
ashttp://localhost:3000/
; - create the app and take note of
Client ID
andClient Secret
- set
- 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
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
.