Documentation

Start

Install the packages, choose the right entry point, and run the first examples.

Start here if you are new to Plumile JS. These pages separate package consumption from repository contribution so you can install only what you need.

Pages in this section

Installation - Install Plumile JS packages as a consumer or prepare the monorepo for contribution.
Quickstart - Create a typed route and parse URL filters with the core packages.
Full app shell - Compose a realistic React application shell with Plumile UI, Relay, and the router.
Package map - Choose the right package before reading detailed guides.