# Qwik

> Qwik is a resumable web framework. It serializes application state into HTML during SSR and resumes on the client without hydration, so apps stay interactive without eagerly downloading all component code.

Use this file to find the best markdown sources for Qwik framework, router, and package API documentation.
The linked markdown mirrors are generated from the local docs sources so they stay readable for both people and LLM tools.

## Start Here

- [Qwik Home](https://next.qwik.dev/index.md): Project overview with the core value proposition behind resumability and streaming execution.
- [Getting Started](https://next.qwik.dev/docs/getting-started.md): Hands-on introduction to creating an app, routing, data loading, state, tasks, and styling.
- [Project Structure](https://next.qwik.dev/docs/project-structure.md): Explains the default app layout, routing folders, and where framework and router concerns live.

## Tools

- [MCP server](https://next.qwik.dev/docs/labs/mcp.md): Connect an MCP client to a running Qwik app for local read-only inspection.

## Core Concepts

- [Docs Overview](https://next.qwik.dev/docs.md): High-level docs entry point for Qwik framework concepts and core learning paths.
- [Core Overview](https://next.qwik.dev/docs/core/overview.md): Overview of components, JSX rendering, and the framework primitives used throughout Qwik apps.
- [Think Qwik](https://next.qwik.dev/docs/concepts/think-qwik.md): Mental model for resumability, lazy execution, and how Qwik differs from hydration-based frameworks.
- [Resumable](https://next.qwik.dev/docs/concepts/resumable.md): Explains resumability and how Qwik serializes state and resumes without replaying components.
- [Reactivity](https://next.qwik.dev/docs/concepts/reactivity.md): Covers signals, stores, and the fine-grained update model used by Qwik.
- [The $ Dollar Sign](https://next.qwik.dev/docs/advanced/dollar.md): Explains the `$` suffix transform, lazy boundaries, and serializable closures.
- [QRL](https://next.qwik.dev/docs/advanced/qrl.md): Deep dive into QRLs, how lazy references are encoded, and how symbols are resumed on demand.
- [Optimizer Hints](https://next.qwik.dev/docs/advanced/optimizer-hints.md): Documents optimizer suppression hints like `@qwik-disable-next-line` and when to use named diagnostics sparingly.
- [Web Workers](https://next.qwik.dev/docs/advanced/worker.md): Explains `worker$()`, when to use browser Web Workers, and what data can be passed to worker functions.
- [State](https://next.qwik.dev/docs/core/state.md): Reference for signals, stores, computed values, async state, and related reactive primitives.
- [Events](https://next.qwik.dev/docs/core/events.md): Event handling model, lazy event listeners, and DOM interaction in Qwik.
- [Synchronous Events with State](https://next.qwik.dev/docs/advanced/sync-events.md): Advanced `sync$()` patterns for synchronous DOM event work that still coordinates with reactive state.
- [Tasks and Lifecycle](https://next.qwik.dev/docs/core/tasks.md): Lifecycle and task model including `useTask$`, `useVisibleTask$`, and tracked reactive work.
- [Context](https://next.qwik.dev/docs/core/context.md): Dependency-style state sharing with `useContext` and `useContextProvider`.
- [Slots](https://next.qwik.dev/docs/core/slots.md): Projected content and component composition patterns in Qwik.
- [Rendering](https://next.qwik.dev/docs/core/rendering.md): Rendering behavior, JSX output, and how Qwik updates and resumes DOM.
- [Styles](https://next.qwik.dev/docs/core/styles.md): Styling patterns including scoped styles, inline styles, and stylesheet loading.

## Routing and Server

- [Routing](https://next.qwik.dev/docs/routing.md): File-based routing fundamentals, route folders, params, and navigation concepts.
- [Advanced Routing](https://next.qwik.dev/docs/advanced/routing.md): Advanced matching behavior and route structure patterns for larger applications.
- [Prevent Navigation](https://next.qwik.dev/docs/advanced/prevent-navigation.md): How to use `usePreventNavigate$` to guard unsaved state during SPA and browser navigation.
- [Rewrites](https://next.qwik.dev/docs/guides/rewrites.md): How to use `request.rewrite()` in route middleware to render another path while keeping the visible URL.
- [Route Loader](https://next.qwik.dev/docs/route-loader.md): Server-side data loading with `routeLoader$`, typed access, and route-level data dependencies.
- [Action](https://next.qwik.dev/docs/action.md): Mutations and form actions with `routeAction$`, validation, and progressive enhancement.
- [server$](https://next.qwik.dev/docs/server$.md): RPC-style server functions callable from the client with serialization and request context support.

## Experimental

- [Pending](https://next.qwik.dev/docs/labs/pending.md): Experimental fallback boundaries for async rendering and out-of-order streaming, including `useComputed$`, `delay`, and `Reveal` patterns.

## API Packages

- [@qwik.dev/qwik](https://next.qwik.dev/api/qwik.md): Core framework API reference, including components, QRLs, signals, JSX types, and hooks.
- [@qwik.dev/qwik-router](https://next.qwik.dev/api/qwik-router.md): Router API reference for routing, loaders, actions, middleware, and server utilities.
- [@qwik.dev/qwik-server](https://next.qwik.dev/api/qwik-server.md): Server rendering and serialization APIs for rendering Qwik applications outside the browser.
- [@qwik.dev/core/worker](https://next.qwik.dev/api/qwik-worker.md): Worker API reference for `worker$()` and `workerQrl()`, which run Qwik functions away from the main browser thread.
- [@qwik.dev/qwik-optimizer](https://next.qwik.dev/api/qwik-optimizer.md): Optimizer API reference for the compiler and transform pipeline that powers lazy loading.
- [@qwik.dev/qwik-testing](https://next.qwik.dev/api/qwik-testing.md): Testing helpers and utilities for unit, DOM, and integration-style Qwik tests.
- [API Reference](https://next.qwik.dev/api.md): Index of Qwik package API references.
- [\@qwik.dev/router/vite API Reference](https://next.qwik.dev/api/qwik-router-vite.md): 

## Docs

- [Backpatching | Advanced](https://next.qwik.dev/docs/advanced/backpatching.md): 
- [Containers | Advanced](https://next.qwik.dev/docs/advanced/containers.md): 
- [Custom Build Output Directory | Advanced](https://next.qwik.dev/docs/advanced/custom-build-dir.md): 
- [/docs/advanced/eslint/](https://next.qwik.dev/docs/advanced/eslint.md): 
- [Component library | Advanced](https://next.qwik.dev/docs/advanced/library.md): 
- [Prefetching | Advanced](https://next.qwik.dev/docs/advanced/modules-prefetching.md): 
- [Optimizer Rules | Advanced](https://next.qwik.dev/docs/advanced/optimizer.md): 
- [Qwikloader | Advanced](https://next.qwik.dev/docs/advanced/qwikloader.md): 
- [State Prewarm | Advanced](https://next.qwik.dev/docs/advanced/state-prewarm.md): 
- [Vite | Advanced](https://next.qwik.dev/docs/advanced/vite.md): 
- [Progressive | Concepts](https://next.qwik.dev/docs/concepts/progressive.md): 
- [Deprecated Features | Guides](https://next.qwik.dev/docs/deprecated-features.md): 
- [Frequently Asked Questions | Introduction](https://next.qwik.dev/docs/faq.md): 
- [Complex Forms | Advanced](https://next.qwik.dev/docs/advanced/complex-forms.md): Learn how to create complex forms with arrays and objects.
- [Content Security Policy | Advanced](https://next.qwik.dev/docs/advanced/content-security-policy.md): Learn how to create a content security policy (CSP) to keep your Qwik app safe.
- [Menu | Advanced](https://next.qwik.dev/docs/advanced/menu.md): How to use menus to define site navigation.
- [Qwik Plugins | Qwik Router](https://next.qwik.dev/docs/advanced/plugins.md): Learn about advanced routing in Qwik Router, including 404 page handling, grouped layouts, named layouts, nested layouts, and plugin.ts files.
- [Request Handling | Advanced](https://next.qwik.dev/docs/advanced/request-handling.md): How to handle requests in Qwik Router, including REST endpoints, and middlewares.
- [Generating Sitemaps | Advanced](https://next.qwik.dev/docs/advanced/sitemaps.md): Learn how to generate a sitemap for your site in Qwik Router.
- [Speculative Module Fetching | Advanced](https://next.qwik.dev/docs/advanced/speculative-module-fetching.md): Learn how Qwik handles loading bundles in the background and filling the cache with Speculative Module Fetching.
- [Static Assets | Advanced](https://next.qwik.dev/docs/advanced/static-assets.md): How to serve static assets in your Qwik app.
- [API Reference | Qwik Router](https://next.qwik.dev/docs/api.md): Qwik Router API reference.
- [Caching | Qwik Router](https://next.qwik.dev/docs/caching.md): Learn how to handle caching in your Qwik Router app to keep your site as fast as possible.
- [Endpoints | Qwik Router](https://next.qwik.dev/docs/endpoints.md): Endpoints are middleware functions used to control and return data in various formats like RESTful API, GraphQL API, JSON, XML, reverse proxy, or other API types.
- [Error handling | Qwik Router](https://next.qwik.dev/docs/error-handling.md): 
- [Best Practices | Guides](https://next.qwik.dev/docs/guides/best-practices.md): Learn the best practices for Qwik, a guide for understanding how to use Qwik to its full potential.
- [Bundle Optimization | Guides](https://next.qwik.dev/docs/guides/bundle.md): Learn about bundle optimization in Qwik, a JavaScript framework for building web applications. This guide explains how to optimize your code by co-locating symbols and chunks, and provides examples of how to create and use symbols in your source code. Follow along with the code snippets and try them out in the included CodeSandbox demo.
- [Qwik Hybrid Native App Overview | Guides](https://next.qwik.dev/docs/guides/capacitor.md): Learn to build hybrid native apps with Qwik.
- [Debugging | Introduction](https://next.qwik.dev/docs/guides/debugging.md): Learn a few debugging tips to streamline your journey with Qwik.
- [/docs/guides/deploy/](https://next.qwik.dev/docs/guides/deploy.md): 
- [Environment variables | Qwik Router](https://next.qwik.dev/docs/guides/env-variables.md): Qwik apps can read environment variables in two main ways build-time variables and server-side variables.
- [Markdown and MDX | Guides](https://next.qwik.dev/docs/guides/mdx.md): Learn how to use Markdown and MDX in Qwik Router.
- [Qwik in a nutshell | Introduction](https://next.qwik.dev/docs/guides/qwik-nutshell.md): Learn the general concepts of Qwik in this short introduction guide.
- [Redirects | Guides](https://next.qwik.dev/docs/guides/redirects.md): Learn how to use redirects in Qwik Router.
- [Serialization and Serialization Boundaries | Guides](https://next.qwik.dev/docs/guides/serialization.md): Learn about serialization and serialization boundaries in Qwik, the process of converting data into a format that can be stored or transmitted.
- [Static Site Generation (SSG) Overview | Guides](https://next.qwik.dev/docs/guides/static-site-generation.md): Learn how static site generation (SSG) works in Qwik Router.
- [HTML attributes | Qwik Router](https://next.qwik.dev/docs/html-attributes.md): Learn how to add attributes to the html tag, in order to add "lang" or other custom attributes.
- [Layout & Middleware | Guides](https://next.qwik.dev/docs/layout.md): 
- [Middleware | Guides](https://next.qwik.dev/docs/middleware.md): 
- [Pages | Qwik Router](https://next.qwik.dev/docs/pages.md): 
- [Deprecated Features | Qwik Router](https://next.qwik.dev/docs/qwikrouter-deprecated-features.md): 
- [Overview | Qwik Router](https://next.qwik.dev/docs/qwikrouter.md): 
- [Cookbook | Re-exporting loaders](https://next.qwik.dev/docs/re-exporting-loaders.md): 
- [/docs/troubleshooting/](https://next.qwik.dev/docs/troubleshooting.md): 
- [Validators | Qwik Router](https://next.qwik.dev/docs/validator.md): 
- [Cookbook | Algolia Search](https://next.qwik.dev/docs/cookbook/algolia-search.md): 
- [Cookbook | Combine Request Handlers](https://next.qwik.dev/docs/cookbook/combine-request-handlers.md): 
- [Cookbook | Debouncer](https://next.qwik.dev/docs/cookbook/debouncer.md): 
- [Cookbook | Detect img tag onLoad](https://next.qwik.dev/docs/cookbook/detect-img-tag-onload.md): 
- [Cookbook | Drag & Drop](https://next.qwik.dev/docs/cookbook/drag&drop.md): 
- [Cookbook | Font optimization](https://next.qwik.dev/docs/cookbook/fonts.md): 
- [Cookbook | Glob Import with import.meta.glob](https://next.qwik.dev/docs/cookbook/glob-import.md): 
- [Cookbook | Overview](https://next.qwik.dev/docs/cookbook.md): 
- [Cookbook | Media Controller with iOS Support](https://next.qwik.dev/docs/cookbook/mediaController.md): 
- [Cookbook | Navbar link](https://next.qwik.dev/docs/cookbook/nav-link.md): 
- [Cookbook | Deploy with Node using Docker](https://next.qwik.dev/docs/cookbook/node-docker-deploy.md): 
- [Cookbook | Portals](https://next.qwik.dev/docs/cookbook/portals.md): 
- [Cookbook | Streaming/deferred loaders](https://next.qwik.dev/docs/cookbook/streaming-deferred-loaders.md): 
- [Cookbook | Dark and Light Theme](https://next.qwik.dev/docs/cookbook/theme-management.md): 
- [Cookbook | View Transition API](https://next.qwik.dev/docs/cookbook/view-transition.md): 
- [AWS Lambda | Deployments](https://next.qwik.dev/docs/deployments/aws-lambda.md): 
- [Azion Web Platform | Deployments](https://next.qwik.dev/docs/deployments/azion.md): 
- [Azure Static Web Apps | Deployments](https://next.qwik.dev/docs/deployments/azure-swa.md): 
- [Bun Middleware | Deployments](https://next.qwik.dev/docs/deployments/bun.md): 
- [Cloudflare Pages Adapter and Middleware | Deployments](https://next.qwik.dev/docs/deployments/cloudflare-pages.md): 
- [Cloudflare Workers Adapter and Middleware | Deployments](https://next.qwik.dev/docs/deployments/cloudflare-workers.md): 
- [Deno Middleware | Deployments](https://next.qwik.dev/docs/deployments/deno.md): 
- [DeployHQ | Deployments](https://next.qwik.dev/docs/deployments/deployhq.md): 
- [Firebase | Deployments](https://next.qwik.dev/docs/deployments/firebase.md): 
- [Cloud Run Middleware | Deployments](https://next.qwik.dev/docs/deployments/gcp-cloud-run.md): 
- [GitHub Pages](https://next.qwik.dev/docs/deployments/github-pages.md): 
- [Deployments | Guides](https://next.qwik.dev/docs/deployments.md): 
- [Netlify Edge Adapter and Middleware | Deployments](https://next.qwik.dev/docs/deployments/netlify-edge.md): 
- [Node Middleware | Deployments](https://next.qwik.dev/docs/deployments/node.md): 
- [Self-Hosting](https://next.qwik.dev/docs/deployments/self-hosting.md): 
- [Static Site](https://next.qwik.dev/docs/deployments/static.md): 
- [Vercel Edge Adapter and Middleware | Deployments](https://next.qwik.dev/docs/deployments/vercel-edge.md): 
- [Error Codes | Reference](https://next.qwik.dev/docs/errors.md): Reference for all Qwik internal error codes with descriptions and troubleshooting guidance.
- [Glossary](https://next.qwik.dev/docs/glossary.md): Definitions of the key terms used in the Qwik documentation.
- [Astro | Integrations](https://next.qwik.dev/docs/integrations/astro.md): Learn how to use Qwik inside an Astro project.
- [Auth.js | Integrations](https://next.qwik.dev/docs/integrations/authjs.md): 
- [Bootstrap | Integrations](https://next.qwik.dev/docs/integrations/bootstrap.md): 
- [Builder.io | Integrations](https://next.qwik.dev/docs/integrations/builderio.md): 
- [Cypress | Integrations](https://next.qwik.dev/docs/integrations/cypress.md): 
- [Drizzle | Integrations](https://next.qwik.dev/docs/integrations/drizzle.md): 
- [Formisch | Integrations](https://next.qwik.dev/docs/integrations/formisch.md): 
- [Internationalization | Integrations](https://next.qwik.dev/docs/integrations/i18n.md): 
- [Icons | Integrations](https://next.qwik.dev/docs/integrations/icons.md): 
- [Image Optimization | Integrations](https://next.qwik.dev/docs/integrations/image-optimization.md): 
- [Qwik Router Integrations | Guides](https://next.qwik.dev/docs/integrations.md): 
- [LeafletJS Map | Integrations](https://next.qwik.dev/docs/integrations/leaflet-map.md): 
- [Nx Monorepos | Integrations](https://next.qwik.dev/docs/integrations/nx.md): 
- [OG Image (og-img) | Integrations](https://next.qwik.dev/docs/integrations/og-img.md): 
- [Qwik Router and Orama](https://next.qwik.dev/docs/integrations/orama.md): 
- [Panda CSS | Integrations](https://next.qwik.dev/docs/integrations/panda-css.md): 
- [Partytown | Integrations](https://next.qwik.dev/docs/integrations/partytown.md): 
- [Playwright | Integrations](https://next.qwik.dev/docs/integrations/playwright.md): 
- [PostCSS | Integrations](https://next.qwik.dev/docs/integrations/postcss.md): 
- [Prisma | Integrations](https://next.qwik.dev/docs/integrations/prisma.md): 
- [React | Integrations](https://next.qwik.dev/docs/integrations/react.md): 
- [Storybook | Integrations](https://next.qwik.dev/docs/integrations/storybook.md): 
- [Styled Vanilla Extract | Integrations](https://next.qwik.dev/docs/integrations/styled-vanilla-extract.md): 
- [Supabase | Integrations](https://next.qwik.dev/docs/integrations/supabase.md): 
- [Tailwind | Integrations](https://next.qwik.dev/docs/integrations/tailwind-v3.md): 
- [Tailwind | Integrations](https://next.qwik.dev/docs/integrations/tailwind.md): 
- [Tauri | Integrations](https://next.qwik.dev/docs/integrations/tauri.md): 
- [Turso | Integrations](https://next.qwik.dev/docs/integrations/turso.md): 
- [Vitest | Integrations](https://next.qwik.dev/docs/integrations/vitest.md): 
- [Catch | Experimental](https://next.qwik.dev/docs/labs/catch.md): 
- [🧪 Devtools](https://next.qwik.dev/docs/labs/devtools.md): 
- [🧪 Each | Experimental](https://next.qwik.dev/docs/labs/each.md): 
- [🧪 Experimental | Overview](https://next.qwik.dev/docs/labs.md): 
- [🧪 Insights | Experimental](https://next.qwik.dev/docs/labs/insights.md): 
- [Show | Experimental](https://next.qwik.dev/docs/labs/show.md): 
- [🧪 Typed Routes](https://next.qwik.dev/docs/labs/typed-routes.md): 

## Optional

- [Playground](https://next.qwik.dev/playground.md): Interactive playground for trying Qwik code, shareable examples, and quick experiments.
- [React Cheat Sheet](https://next.qwik.dev/docs/guides/react-cheat-sheet.md): Maps common React concepts to Qwik primitives for teams migrating or comparing frameworks.
- [Upgrade](https://next.qwik.dev/docs/upgrade.md): Migration notes, upgrade guidance, and version transition details.
- [@qwik.dev/qwik-insights](https://next.qwik.dev/api/qwik-insights.md): Insights package API reference for performance tracing and analytics integration.
- [@qwik.dev/qwik-router-ssg](https://next.qwik.dev/api/qwik-router-ssg.md): API reference for @qwik.dev/qwik-router-ssg.
- [@qwik.dev/qwik-router-vite-azure-swa](https://next.qwik.dev/api/qwik-router-vite-azure-swa.md): API reference for @qwik.dev/qwik-router-vite-azure-swa.
- [@qwik.dev/qwik-router-vite-bun-server](https://next.qwik.dev/api/qwik-router-vite-bun-server.md): API reference for @qwik.dev/qwik-router-vite-bun-server.
- [@qwik.dev/qwik-router-vite-cloud-run](https://next.qwik.dev/api/qwik-router-vite-cloud-run.md): API reference for @qwik.dev/qwik-router-vite-cloud-run.
- [@qwik.dev/qwik-router-vite-cloudflare-pages](https://next.qwik.dev/api/qwik-router-vite-cloudflare-pages.md): API reference for @qwik.dev/qwik-router-vite-cloudflare-pages.
- [@qwik.dev/qwik-router-vite-netlify-edge](https://next.qwik.dev/api/qwik-router-vite-netlify-edge.md): API reference for @qwik.dev/qwik-router-vite-netlify-edge.
- [@qwik.dev/qwik-router-vite-node-server](https://next.qwik.dev/api/qwik-router-vite-node-server.md): API reference for @qwik.dev/qwik-router-vite-node-server.
- [@qwik.dev/qwik-router-vite-ssg](https://next.qwik.dev/api/qwik-router-vite-ssg.md): API reference for @qwik.dev/qwik-router-vite-ssg.
- [@qwik.dev/qwik-router-vite-vercel](https://next.qwik.dev/api/qwik-router-vite-vercel.md): API reference for @qwik.dev/qwik-router-vite-vercel.
- [@qwik.dev/qwik-router-middleware-aws-lambda](https://next.qwik.dev/api/qwik-router-middleware-aws-lambda.md): API reference for @qwik.dev/qwik-router-middleware-aws-lambda.
- [@qwik.dev/qwik-router-middleware-azure-swa](https://next.qwik.dev/api/qwik-router-middleware-azure-swa.md): API reference for @qwik.dev/qwik-router-middleware-azure-swa.
- [@qwik.dev/qwik-router-middleware-cloudflare-pages](https://next.qwik.dev/api/qwik-router-middleware-cloudflare-pages.md): API reference for @qwik.dev/qwik-router-middleware-cloudflare-pages.
- [@qwik.dev/qwik-router-middleware-firebase](https://next.qwik.dev/api/qwik-router-middleware-firebase.md): API reference for @qwik.dev/qwik-router-middleware-firebase.
- [@qwik.dev/qwik-router-middleware-netlify-edge](https://next.qwik.dev/api/qwik-router-middleware-netlify-edge.md): API reference for @qwik.dev/qwik-router-middleware-netlify-edge.
- [@qwik.dev/qwik-router-middleware-node](https://next.qwik.dev/api/qwik-router-middleware-node.md): API reference for @qwik.dev/qwik-router-middleware-node.
- [@qwik.dev/qwik-router-middleware-request-handler](https://next.qwik.dev/api/qwik-router-middleware-request-handler.md): API reference for @qwik.dev/qwik-router-middleware-request-handler.
- [@qwik.dev/qwik-router-middleware-vercel-edge](https://next.qwik.dev/api/qwik-router-middleware-vercel-edge.md): API reference for @qwik.dev/qwik-router-middleware-vercel-edge.