sveltejs · Rich-Harris · Jul 8, 2022 · May 5, 2022 · May 5, 2022 · May 5, 2022
diff --git a/documentation/docs/01-project-structure.md b/documentation/docs/01-project-structure.md
@@ -0,0 +1,77 @@
+---
+title: Project Structure
+---
+
+A typical SvelteKit project looks like this:
+
+```bash
+my-project/
+├ src/
+│ ├ lib/
+│ │ └ [your lib files]
+│ ├ params/
+│ │ └ [your param matchers]
+│ ├ routes/
+│ │ └ [your routes]
+│ ├ app.html
+│ └ hooks.js
+├ static/
+│ └ [your static assets]
+├ package.json
+├ svelte.config.js
+├ tsconfig.json
+└ vite.config.js
+```
+
+You'll also find common files like `.gitignore` and `.npmrc` (and `.prettierrc` and `.eslintrc.cjs` and so on, if you chose those options when running `npm create svelte`).
+
+### Project files
+
+#### src
+
+The `src` directory contains the meat of your project.
+
+- `lib` contains your library code, which can be imported via the [`$lib`](/docs/modules#$lib) alias, or packaged up for distribution using [`svelte-kit package`](/docs/packaging)
+- `params` contains any [param matchers](/docs/routing#advanced-routing-matching) your app needs
+- `routes` contains the [pages](/docs/routing#pages) and [endpoints](/docs/routing#endpoints) of your application
+- `app.html` is your page template — an HTML document containing the following placeholders:
+  - `%sveltekit.head%` — `<link>` and `<script>` elements needed by the app, plus any `<svelte:head>` content
+  - `%sveltekit.body%` — the markup for a rendered page
+  - `%sveltekit.assets%` — a relative path from the page to [`paths.assets`](/docs/configuration#paths)
+  - `%sveltekit.nonce%` — a [CSP](/docs/configuration#csp) nonce for manually included links and scripts, if used
+- `hooks.js` (optional) contains your application's [hooks](/docs/hooks)
+- `service-worker.js` (optional) contains your [service worker](/docs/service-workers)
+
+You can use `.ts` files instead of `.js` files, if using TypeScript.
+
+#### static
+
+Any static assets that should be served as-is, like `robots.txt` or `favicon.png`, go in here.
+
+#### package.json
+
+Your `package.json` file must include `@sveltejs/kit`, `svelte` and `vite` as `devDependencies`.
+
+When you create a project with `npm create svelte`, you'll also notice that `package.json` includes `"type": "module"`. This means that `.js` files are interpreted as native JavaScript modules with `import` and `export` keywords. Legacy CommonJS files need a `.cjs` file extension.
+
+#### svelte.config.js
+
+This file contains your Svelte and SvelteKit [configuration](/docs/configuration).
+
+#### tsconfig.json
+
+This file (or `jsconfig.json`, if you prefer type-checked `.js` files over `.ts` files) configures TypeScript, if you added typechecking during `npm create svelte`. Since SvelteKit relies on certain configuration being set a specific way, it generates its own `.svelte-kit/tsconfig.json` file which your own config `extends`.
+
+#### vite.config.js
+
+A SvelteKit project is really just a [Vite](https://vitejs.dev) project that uses the [`@sveltejs/kit/vite`](/docs/modules#sveltejs-kit-vite) plugin, along with any other [Vite configuration](https://vitejs.dev/config/).
+
+### Other files
+
+#### test
+
+If you choose to add tests during `npm create svelte`, they will go in a `test` directory.
+
+#### .svelte-kit
+
+As you develop and build your project, SvelteKit will generate files in a `.svelte-kit` directory (configurable as [`outDir`](/docs/configuration#outdir)). You can ignore its contents, and delete them at any time (they will be regenerated when you next `dev` or `build`).
diff --git a/documentation/docs/01-web-standards.md → documentation/docs/02-web-standards.md b/documentation/docs/01-web-standards.md → documentation/docs/02-web-standards.md
diff --git a/documentation/docs/02-routing.md → documentation/docs/03-routing.md b/documentation/docs/02-routing.md → documentation/docs/03-routing.md
diff --git a/documentation/docs/03-layouts.md → documentation/docs/04-layouts.md b/documentation/docs/03-layouts.md → documentation/docs/04-layouts.md
diff --git a/documentation/docs/04-loading.md → documentation/docs/05-loading.md b/documentation/docs/04-loading.md → documentation/docs/05-loading.md
diff --git a/documentation/docs/05-hooks.md → documentation/docs/06-hooks.md b/documentation/docs/05-hooks.md → documentation/docs/06-hooks.md
diff --git a/documentation/docs/06-modules.md → documentation/docs/07-modules.md b/documentation/docs/06-modules.md → documentation/docs/07-modules.md
diff --git a/documentation/docs/07-service-workers.md → documentation/docs/08-service-workers.md b/documentation/docs/07-service-workers.md → documentation/docs/08-service-workers.md
diff --git a/documentation/docs/08-a-options.md → documentation/docs/09-a-options.md b/documentation/docs/08-a-options.md → documentation/docs/09-a-options.md
diff --git a/documentation/docs/09-events.md → documentation/docs/10-events.md b/documentation/docs/09-events.md → documentation/docs/10-events.md
diff --git a/documentation/docs/10-adapters.md → documentation/docs/11-adapters.md b/documentation/docs/10-adapters.md → documentation/docs/11-adapters.md
diff --git a/documentation/docs/11-page-options.md → documentation/docs/12-page-options.md b/documentation/docs/11-page-options.md → documentation/docs/12-page-options.md
diff --git a/documentation/docs/12-packaging.md → documentation/docs/13-packaging.md b/documentation/docs/12-packaging.md → documentation/docs/13-packaging.md
diff --git a/documentation/docs/13-cli.md → documentation/docs/14-cli.md b/documentation/docs/13-cli.md → documentation/docs/14-cli.md
diff --git a/documentation/docs/14-configuration.md → documentation/docs/15-configuration.md b/documentation/docs/14-configuration.md → documentation/docs/15-configuration.md
diff --git a/documentation/docs/15-types.md → documentation/docs/16-types.md b/documentation/docs/15-types.md → documentation/docs/16-types.md
diff --git a/documentation/docs/16-seo.md → documentation/docs/17-seo.md b/documentation/docs/16-seo.md → documentation/docs/17-seo.md
diff --git a/documentation/docs/17-assets.md → documentation/docs/18-assets.md b/documentation/docs/17-assets.md → documentation/docs/18-assets.md