Parcel Documentation

Getting started

Learn how to start a new project, or migrate an existing project to Parcel 2.

Building a webapp with Parcel

Learn how to set up a new web application from scratch with Parcel.

Building a library with Parcel

Learn how to set up a Parcel to build a JavaScript library.

Migrate an existing project from Parcel 1 to Parcel 2.

Features

Learn about Parcel's core features.

Learn about Parcel's dev server, hot reloading, lazy mode, caching, and more.

How to use dynamic imports and Parcel's automatic shared bundles.

How dependencies are resolved, url schemes, aliases, and more.

Bundle Inlining

How to inline the compiled contents of one bundle inside another.

How to compile your source code for multiple targets.

Minification, tree shaking, compression, content hashing, and more.

Dig into the details of how Parcel's tree shaking implementation works.

Using Node.js features like environment variables and builtin module polyfills.

A reference for all of the options available in the Parcel CLI.

Run Parcel builds programmatically to integrate into any build.

Overriding and extending Parcel's defaults using plugins.

Languages and Frameworks

Learn how to use the most common languages and frameworks with Parcel. See the side navigation for even more.

The entry of most Parcel apps. From here, you can reference scripts, styles, images, and more.

Using ES modules and CommonJS, setting up transpilation, JSX, workers, and more.

Using CSS with Parcel, including dependencies, CSS modules, PostCSS, and more.

Referencing SVG from HTML, CSS, JavaScript, and JSX, including scripts and styles, and more.

Using TypeScript with Parcel, including transpilation and generating typings.

Resizing, converting, and optimizing images.

Using React with Parcel, including Fast Refresh, styling, images, code splitting, and more.

Using Vue 3 SFCs with Parcel.

Plugin System

Learn how to customize and extend Parcel's defaults with your own plugins.

Concepts

An overview of Parcel's architecture and core data structures.

Authoring Plugins

An introduction to Parcel's Plugin APIs, and a guide to publishing a plugin package.

How to emit errors and logs using Parcel's unified diagnostics format.

How to work with Parcel's source maps library in your plugin.

Plugin Types

Compile individual source files and extract dependencies.

Resolve a dependency to a file path or virtual module.

Determine the name of an output file.

Combine multiple assets together into a single output file.

Minify, optimize, and transform output files.

Compress and encode output files in multiple formats.

Receive events on build progress and completion.

Share Parcel configuration between projects.