SvelteKit

Connect SvelteKit to Flame during development and deploy static or server-rendered applications alongside the docs.

Complete the shared setup and reserve /docs. SvelteKit and Flame keep their own rendering and routing.

Develop on one local origin

Keep the existing SvelteKit plugin and add the Vite dev proxy:

vite.config.ts
import { sveltekit } from "@sveltejs/kit/vite";
import { defineConfig } from "vite";

const docsProxy = {
  target: "http://localhost:3001",
  changeOrigin: true,
};

export default defineConfig({
  plugins: [sveltekit()],
  server: {
    port: 5173,
    strictPort: true,
    proxy: {
      "^/docs(?:/|$)": docsProxy,
      "/__hmr": docsProxy,
    },
  },
});

Start npm run dev and npm run docs:dev in separate terminals. Visit http://localhost:5173/docs/. Forwarding /__hmr preserves Flame's development reload stream. See Vite proxy options.

Use full document navigation

src/lib/DocsLink.svelte
<a href="/docs/" data-sveltekit-reload rel="external">Documentation</a>

data-sveltekit-reload makes the browser load a new document. rel="external" also keeps the link out of SvelteKit's prerender crawl. Exclude the docs prefix from service worker navigation handling.

Build with adapter-static

Use this path when the application is already configured for @sveltejs/adapter-static. Its default pages and assets directory is build/. Complete the application's prerender configuration before combining the builds.

shell
npx vite build
npm run docs:build
cp -R .docu/dist/. build/

Publish build/. If pages and assets use customized adapter directories, copy the complete Flame tree into the directory the host serves at /, and include it in the published artifact. Keep /docs out of SvelteKit's own generated routes.

The host must serve the docs and its missing-page responses before applying an SPA fallback. Choose Vercel, Cloudflare or Netlify.

Deploy with server rendering

Keep the application's chosen adapter. Deploy Flame's .docu/dist/ to its own static site and proxy /docs plus /docs/* at the public entry point. Use external rewrites on Vercel, the Cloudflare routing boundary or Netlify's proxy.

Copying docs into an adapter's internal output without registering them with that adapter can leave the files out of deployment. A separate docs deployment avoids depending on those output internals.

Verify a direct nested docs URL, the docs link, search assets and a missing guide with the shared checks.

Last updated Nov 7, 2026