Guide

Documentation for people building an app with rooted.

If you have not opened the project yet, the main README is the place to start. This folder is the next step.

Getting started. Install, first component, app bootstrap.
Application model. The vertical-slice layout used by rooted apps.
Components. The component() factory, the mount context, and the lifecycle.
Routing. Typed routes, gates, navigation, and route discovery.
Localization. Locale-in-URL routing, overlay dictionaries, and hreflang.
Markdown. Build-time markdown rendering and the Markdown component.
Styling. The CSS layers a rooted app uses.
State. Sharing state between components with @rooted/store.
Storage. Reading and writing localStorage, sessionStorage, and cookies.
SEO. Per-route metadata, sitemaps, and llms.txt.
PWA. The service worker, caching, and how a new version reaches people.
Adapters. Deployment adapters for static hosts, Node servers, and PaaS providers.
FAQ. Things people get stuck on.

For low-level APIs (the element factory, page-level events, framework internals), see advanced/.

Guide ​