sveltejs · Mlocik97 · May 5, 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,107 @@
+---
+title: Project Structure
+---
+
+The basic structure of a SvelteKit project is:
+
+```sh
+my-app/
+ |
+ +---- .svelte-kit/                 # (generated by SvelteKit)
+ +---- build/                       # (generated at build)
+ +---- src/
+ |       |
+ |       +---- lib/                 # (optional)
+ |       +---- params/              # (optional)
+ |       +---- routes/
+ |       +---- app.css              # (optional)
+ |       +---- app.d.ts             # (optional)
+ |       +---- app.html
+ |       +---- hooks.js             # or 'hooks/' (optional)
+ |       +---- service-worker.js    # (optional)
+ +---- static/
+ +---- tests/                       # (optional)
+ +---- .eslintrtc.cjs               # (optional)
+ +---- .gitignore                   # (optional)
+ +---- .npmrc
+ +---- .prettierrc                  # (optional)
+ +---- jsconfig.json                # or 'tsconfig.json' (optional)
+ +---- package.json
+ +---- playwright.config.js         # (optional)
+ +---- svelte.config.js
+ +---- vite.config.js
+```
+
+If using TypeScript, the scripts files in the `src/` directory will have a `.ts` file extension.
+
+### package.json
+
+The `package.json` file is a standard file where you can configure your `dependencies` and `devDependencies`. [Read more in the npm docs](https://docs.npmjs.com/cli/v7/configuring-npm/package-json).
+
+SvelteKit is [ESM-first](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) so we set `"type": "module"`. In the `"scripts"` property, you can see scripts used for building the project, running the dev server, packaging a library (optional), and running other tools for linting, formatting, type checking, testing etc.
+
+### svelte.config.js
+
+Contains [configuration](configuration) for the SvelteKit project.
+
+### vite.config.js
+
+Contains [configuration](https://vitejs.dev/config/) for the [Vite](https://vitejs.dev/). It use [SvelteKit Vite plugins](modules#sveltejs-kit-vite).
+
+### static/
+
+Holds your static assets. These are files that are not processed by Vite but are just copied to the build folder by the adapter when building the application.
+
+### src/
+
+Holds the Svelte, JS/TS, and other source files for your app.
+
+#### app.html
+
+This is the entry point to your application. It contains placeholders like `%sveltekit.head%`, `%sveltekit.body%`, and `%sveltekit.assets%`. These placeholders will be removed and replaced by actual content at build or SSR.
+
+`%sveltekit.head%` is replaced with `<link>` and `<script>` tags that power the application as well as content from the [`<svelte:head>`](https://svelte.dev/docs#template-syntax-svelte-head) tags defined in your layouts and pages.
+
+`%sveltekit.body%` is where the HTML for your application is rendered.
+
+`%sveltekit.assets%` is replaced by the [assets base path](configuration#paths).
+
+#### routes/
+
+Contains your [pages](routing#pages), [endpoints](routing#endpoints), [standalone endpoints](routing#endpoints-standalone-endpoints), [layouts](layouts) and can also hold [private module](routing#private-modules) files. SvelteKit uses file-based routing, so the file path of the pages and endpoints in this folder maps to the URL which renders them.
+
+#### lib/
+
+A folder that contains source for non-routing related files used by your application. They can be imported via the `$lib` alias. If you are creating a library, the contents of the `lib/` folder are used by default to generate the package when you run [`svelte-kit package`](packaging).
+
+#### hooks.js or hooks/
+
+A folder or file that contain [hooks](hooks) functions executed at every request. The top scope of this file can be used for initialization code like a database connection.
+
+#### params/
+
+Contains [param matchers](routing#advanced-routing-matching) that can be used for dynamic pages or endpoints.
+
+#### service-worker.js or service-worker/
+
+Optionally contains code for your [service-worker](service-worker).
+
+#### other files in src/ folder
+
+The `src/` folder can also contain an `app.css` file with global styles or an `app.d.ts` file with type definitions.
+
+### build/
+
+The output location for your project will depend on which adapter you use. Many adapters will use the `build/` folder as the output location for your compiled app prepared for deploying to production.
+
+### .svelte-kit/
+
+Holds Vite output used directly when you run `npm run dev` or as intermediate output of `npm run build`.
+
+### tests/
+
+If PlayWright is set, this folder is place for testing your app.
+
+### Other
+
+Based on options you selected when initializing the project, there other files will be generated for tools like Git, ESLint, Prettier, TypeScript, and PlayWright.
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