-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,16 @@ | ||
# create-svelte | ||
# HTML generator for the docs | ||
|
||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). | ||
## Building the docs | ||
|
||
## Creating a project | ||
- Install `nodejs` / `npm` | ||
- Run `npm install` | ||
- Copy the mdx docs into the routes folder | ||
- set `DOCS_VERSION` in the env to the correct prefix (eg `main`) | ||
- set `DOCS_LANGUAGE` in the env to the correct language (eg `en`) | ||
- Run `npm run run build` | ||
|
||
If you're seeing this, you've probably already done this step. Congrats! | ||
The generated html files and assets are in the `build` folder. | ||
|
||
```bash | ||
# create a new project in the current directory | ||
npm create svelte@latest | ||
## Previewing the docs | ||
|
||
# create a new project in my-app | ||
npm create svelte@latest my-app | ||
``` | ||
|
||
## Developing | ||
|
||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: | ||
|
||
```bash | ||
npm run dev | ||
|
||
# or start the server and open the app in a new browser tab | ||
npm run dev -- --open | ||
``` | ||
|
||
## Building | ||
|
||
To create a production version of your app: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
You can preview the production build with `npm run preview`. | ||
|
||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. | ||
Instead of `npm run build`, do `npm run dev`. Then go to http://localhost:3000 (or replace `main` with the correct prefix). |