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

## Core Concepts

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

## Routing and Server

- [Routing](https://qwik.dev/docs/routing.md): File-based routing fundamentals, route folders, params, and navigation concepts.
- [Advanced Routing](https://qwik.dev/docs/advanced/routing.md): Advanced matching behavior and route structure patterns for larger applications.
- [Route Loader](https://qwik.dev/docs/route-loader.md): Server-side data loading with `routeLoader$`, typed access, and route-level data dependencies.
- [Action](https://qwik.dev/docs/action.md): Mutations and form actions with `routeAction$`, validation, and progressive enhancement.
- [server$](https://qwik.dev/docs/server$.md): RPC-style server functions callable from the client with serialization and request context support.

## API Packages

- [@qwik.dev/qwik](https://qwik.dev/api/qwik.md): Core framework API reference, including components, QRLs, signals, JSX types, and hooks.
- [@qwik.dev/qwik-router](https://qwik.dev/api/qwik-router.md): Router API reference for routing, loaders, actions, middleware, and server utilities.
- [@qwik.dev/qwik-server](https://qwik.dev/api/qwik-server.md): Server rendering and serialization APIs for rendering Qwik applications outside the browser.
- [@qwik.dev/qwik-optimizer](https://qwik.dev/api/qwik-optimizer.md): Optimizer API reference for the compiler and transform pipeline that powers lazy loading.
- [@qwik.dev/qwik-testing](https://qwik.dev/api/qwik-testing.md): Testing helpers and utilities for unit, DOM, and integration-style Qwik tests.

## Optional

- [Playground](https://qwik.dev/playground.md): Interactive playground for trying Qwik code, shareable examples, and quick experiments.
- [React Cheat Sheet](https://qwik.dev/docs/guides/react-cheat-sheet.md): Maps common React concepts to Qwik primitives for teams migrating or comparing frameworks.
- [Upgrade](https://qwik.dev/docs/upgrade.md): Migration notes, upgrade guidance, and version transition details.
- [@qwik.dev/qwik-insights](https://qwik.dev/api/qwik-insights.md): Insights package API reference for performance tracing and analytics integration.
- [@qwik.dev/qwik-router-ssg](https://qwik.dev/api/qwik-router-ssg.md): API reference for @qwik.dev/qwik-router-ssg.
- [@qwik.dev/qwik-router-vite-azure-swa](https://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://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://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://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://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://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://qwik.dev/api/qwik-router-vite-ssg.md): API reference for @qwik.dev/qwik-router-vite-ssg.
- [@qwik.dev/qwik-router-vite-vercel](https://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://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://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://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://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://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://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://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://qwik.dev/api/qwik-router-middleware-vercel-edge.md): API reference for @qwik.dev/qwik-router-middleware-vercel-edge.