Added sveltekit example

.changeset/curvy-impalas-melt.md

@@ -0,0 +1,5 @@
+---
+"vite-plugin-pagefind": patch
+---
+
+Added examples folder, added SvelteKit

.prettierignore

@@ -1 +1,2 @@
-.changeset
+.changeset
+examples

CHANGELOG.md

@@ -4,93 +4,93 @@
 
 ### Patch Changes
 
-- e1cbe1f: Fixed dynamic imports being due to faulty vite configuration
+-   e1cbe1f: Fixed dynamic imports being due to faulty vite configuration
 
 ## 0.0.15
 
 ### Patch Changes
 
-- 6bb27bc: Fixed nested pagefind dir
+-   6bb27bc: Fixed nested pagefind dir
 
 ## 0.0.14
 
 ### Patch Changes
 
-- 3759d12: Removed testing console.log
+-   3759d12: Removed testing console.log
 
 ## 0.0.13
 
 ### Patch Changes
 
-- a9d0e41: Removed prerequisites from docs since the plugin will handle pagefind through the node API
+-   a9d0e41: Removed prerequisites from docs since the plugin will handle pagefind through the node API
 
 ## 0.0.12
 
 ### Patch Changes
 
-- e08ff34: Cleaned up docs, renamed appDir to publicDir (makes more sense with vite), added LICENSE
-- b974483: Fixed docs
+-   e08ff34: Cleaned up docs, renamed appDir to publicDir (makes more sense with vite), added LICENSE
+-   b974483: Fixed docs
 
 ## 0.0.11
 
 ### Patch Changes
 
-- 692518a: Added assetsInclude config and external config to make usage of pagefind FAR easier
+-   692518a: Added assetsInclude config and external config to make usage of pagefind FAR easier
 
 ## 0.0.10
 
 ### Patch Changes
 
-- cf9d8a7: Forced buildDir to be present
-- 9f91f77: Fixed buildDir being optional type
+-   cf9d8a7: Forced buildDir to be present
+-   9f91f77: Fixed buildDir being optional type
 
 ## 0.0.9
 
 ### Patch Changes
 
-- 1dc1751: Renamed pagefindDir to appDir and removed the need to specify the `pagefind` folder
-- 1dc1751: Added documentation (see README.md)
+-   1dc1751: Renamed pagefindDir to appDir and removed the need to specify the `pagefind` folder
+-   1dc1751: Added documentation (see README.md)
 
 ## 0.0.8
 
 ### Patch Changes
 
-- bd97d3d: Finally fixed running pagefind after build
-- fcf32c0: Fixed broken vite dependency: https://github.com/vitejs/vite/issues/15714
+-   bd97d3d: Finally fixed running pagefind after build
+-   fcf32c0: Fixed broken vite dependency: https://github.com/vitejs/vite/issues/15714
 
 ## 0.0.7
 
 ### Patch Changes
 
-- 9bdcc49: Fixed pagefind post build not running after the build process
+-   9bdcc49: Fixed pagefind post build not running after the build process
 
 ## 0.0.6
 
 ### Patch Changes
 
-- d911925: Fixed hardcoded buildDir
-- 324852e: Added quotes around paths for pagefind to prevent invalid paths from occuring
+-   d911925: Fixed hardcoded buildDir
+-   324852e: Added quotes around paths for pagefind to prevent invalid paths from occuring
 
 ## 0.0.5
 
 ### Patch Changes
 
-- 04163e9: Added cwd option that defaults to process.cwd, added default to buildDir: build
+-   04163e9: Added cwd option that defaults to process.cwd, added default to buildDir: build
 
 ## 0.0.4
 
 ### Patch Changes
 
-- 93731cd: Bugfix: Had colorette as devDep causing issues with the plugin
+-   93731cd: Bugfix: Had colorette as devDep causing issues with the plugin
 
 ## 0.0.3
 
 ### Patch Changes
 
-- 2f8a075: Only packaging dist files now
+-   2f8a075: Only packaging dist files now
 
 ## 0.0.2
 
 ### Patch Changes
 
-- a969687: Released package
+-   a969687: Released package

README.md

@@ -51,7 +51,11 @@ Example: `buildDir: 'public'` results in: `public/pagefind/pagefind.js`
 
 ## Examples
 
-Coming soon.
+Every framework implements their build and dev process slightly different, this is why there is an [examples folder](examples/) to demonstrate usage in a specific framework:
+
+-   ### [sveltekit](examples/sveltekit/)
+
+Don't see your framework? Consider adding it through a contribution!
 
 ## Pagefind
 

examples/sveltekit/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*

examples/sveltekit/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

examples/sveltekit/README.md

@@ -0,0 +1,38 @@
+# create-svelte
+
+Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+
+## Creating a project
+
+If you're seeing this, you've probably already done this step. Congrats!
+
+```bash
+# create a new project in the current directory
+npm create svelte@latest
+
+# 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.

examples/sveltekit/package.json

@@ -0,0 +1,19 @@
+{
+	"name": "sveltekit",
+	"version": "0.0.1",
+	"private": true,
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build",
+		"preview": "vite preview"
+	},
+	"devDependencies": {
+		"@sveltejs/adapter-static": "^3.0.1",
+		"@sveltejs/kit": "^2.0.0",
+		"@sveltejs/vite-plugin-svelte": "^3.0.0",
+		"svelte": "^4.2.7",
+		"vite": "^5.0.3",
+		"vite-plugin-pagefind": "^0.0.16"
+	},
+	"type": "module"
+}