PlatformKit Docs
How the platform works — for the people who edit a site and the people who build one.
Running a site
The admin, in one tour
Where everything is edited, how a change becomes live, and what the rail's groups hold.
9 minPublishing basics
The Published switch, titles and descriptions for search, share images, access levels, and writing in the editor.
3 minSeveral sites on one host
Run local and separately owned sites through one development workspace and deploy them from independent repositories.
4 minContent
Landing pages and the page builder
The home page, the pricing page, the about page and any other page built from sections.
11 minArticles, wiki and docs
The three prose collections — a magazine, a canon, and a manual — and how each is arranged.
2 minMedia
The library — every picture and file the site uses in one place; addresses instead of files beside records; the picker on every file field; the same library in git mode and cloud mode
5 minBooks and companions
A book's file, its chapters, the editorial highlights, the introduction, the companion with its summaries and quizzes, the free chapters, and the spoken version.
4 minContent models
Any kind of content the site needs — teachers, events, testimonials — defined in the admin as a model of fields with rules, its entries edited as forms and kept as markdown, delivered as data, pages, JSON or a landing section.
7 minSelling
The store
The storefront, products, collections, shipping, guest checkout, and how Stripe is kept in step with the files.
9 minPrint editions
Putting a book on sale in print and as files — the block on the book, the Print editions page, setting the editions, proofs, the publisher's note.
5 minProviders and payouts
How a site lets providers offer their own services, agree to terms, and see earnings and payouts.
1 minMemberships and pricing
Tiers, the pricing page, buying from a landing page, switching up and down, and what a membership unlocks.
3 minOrders
What happens to a sale after it is paid for — the lines, the money, the parcels and the returns.
4 minSelling garments
Upload a design, pick a product type from the supplier's catalogue, and what the buyer sees.
2 minBookings
Sessions and coaching
The ways to book a session — on the site's own calendar or cal.com's — a host's hours, where a session happens, the paid session, the members' chat with the coaches, and the coach's inbox.
22 minTeams
A group of people the site can point work at — declared as a file, with who is in it kept as rows.
4 minCommunity
A person's own page
What somebody is called, the face they wear, and the page at /p/<username> — private until they say otherwise.
11 minAchievements and traits
Two things out of one stream — what somebody has done that is worth saying out loud, and what the site has come to believe about them.
3 minThe support desk
The support chat people see, the inbox the staff answer from, the prompts that start conversations, and the emails around it.
6 minSpaces and communities
How spaces gather people, rooms, conversations, events, and shared community features.
1 minEvents in a community
How a community lists events, repeats a schedule, takes RSVPs, and keeps attendees informed.
1 minMarketing
Forms
A form is a document — its slides, fields and logic — built in the admin, answered on its own page, on a landing page or on another site, every answer kept the moment it is given.
8 minEmails
The email designs, the editor, test sends, subjects, and which email goes when.
3 minFunnels and blasts
Drip campaigns, one-off sends, the audience rules, the policy, chat prompts, and what comes back.
4 minAds and experiments
Calls to action in three placements, chosen by audience and topic; A/B tests as their own records.
3 minSocial automations
Configure staff-only, account-scoped bot replies to verified provider comments and DMs.
3 minSettings
Site settings and UI strings
The site's name and look, and every word of the interface, editable in one place.
10 minAccounts and roles
Find accounts, assign staff roles, and distinguish account, content, and staff access.
4 minAnalytics and notifications
The dashboard, the per-feature numbers, and the push notifications a staff browser can receive.
11 minCloud mode
Store editable content in Supabase, publish it from the live admin, and understand what requires a repository or a deploy.
3 minUsing a site
Building a site
Architecture
The three layers — the kit, the theme, a site — the rules that decided every placement, and how the repository is laid out.
2 minThe three deployment shapes
A site ships in three shapes — static, git and cloud — and which features each one carries is declared in build/modes.mjs and derived from the code rather than remembered.
7 minYour first site
Create a PlatformKit site, install its dependencies, and run it locally or from its own repository.
3 minConfiguration
Every key of platformkit.config.js, what it registers, and where the kit reads it.
8 minDeclarations and state
The one question that decides where anything lives, the manifest every table appears in, and the checks that make the wrong answer impossible.
4 minModules
The fifteen switches, what each turns on, and what the deploy asks for when it is on.
13 minThe content pipeline
How markdown becomes the site — velite, the collections and their fields, the published rule, the post-steps, and a site's own collections.
7 minStrings
The rule that no user-facing word lives in a component, the scopes, the merge, the grammar, the helpers, and the one tooling hazard.
2 minLooks and landing sections
One design, a palette per look, skins, and how a section type is three things that must agree.
11 minThe theme and overrides
The theme's manifest, the virtual modules the plugin answers, replacing a component by name, and the /app shell.
4 minThe database
A declared schema instead of migrations — the files, the plan, renames, the destructive guard, the assembled supabase tree, and the local reset.
24 minEdge functions
Every function the kit ships, what calls it, what it trusts, and how they run locally.
13 minDev, build and deploy
The dev server and the local stack, the production build, and the deploy — with the environment checks that refuse it whole.
22 minTesting
What platformkit test runs, the phone probe, screenshots before reporting, and the specs as the edge of what is verified.
25 minThe spec workflow
How PlatformKit requirements are proposed, implemented, verified and recorded with OpenSpec.
1 minCommerce internals
The offers as files, Stripe made to match, the checkout, the ledger, the mock, guest checkout, memberships' switching, and print orders.
18 minEmails and funnels internals
The designs' compile and fill, the auth emails, the funnel grammar, the audience query, the runner, identity and tracking, and chat prompts.
7 minThe chats and push, internally
The coaching chat's tables and policies, the support desk's function and its live channel, the push triggers, and the two queues the staff answer from.
17 minEncrypted channels
A channel the server cannot read — what it costs, how a room is sealed, where the keys live, and what goes dark.
8 minComments
One conversation system for anything — an article, a wiki page, a book, a product, an event — on the page, in the community as a forum thread, or embedded on somebody else's site at Disqus's own address.
12 minForms internals
The document, the parser and its model, the vendored parts of forms.md, the runner, the function, the embed, the builder's writer.
8 minBots, tools and commands
An agent loop that survives its own function — durable, resumable, cancellable and budgeted — with bots, tools and slash commands declared as markdown, and the kit's own customer-service bot.
48 minVotes and reactions
Two ways of answering something without writing a reply — an emoji and a judgement — for a comment and for a message in a room, from one pair of tables and one rule.
3 minContent models internals
The model record and its grammar, one derivation for velite and the admin, the rules module over validatorjs, the entry check, the builder's endpoints, the pages, the JSON, the section.
6 minAnalytics from any site: PostHog's SDKs and the script
Any official PostHog SDK pointed at this site, or one script with PostHog's API; the door every event goes through; a site's own events and sources in the config.
5 minThe content API, Contentful's
Every collection and model on a site served as Contentful's Delivery, Preview, GraphQL, Sync and Images APIs, and in cloud mode written through the Management API with its webhooks, under keys — an open-source Contentful any Contentful client reads and writes with the host swapped. The guide; the reference lists every route, argument and field.
10 minThe Forms API, Typeform's
A site's forms served as Typeform's Create (read, and written in cloud mode), Responses, Webhooks and Insights APIs, and Typeform's embed pointed at the site — the guide; the reference lists every route, argument and field.
6 minThe Scheduling API, cal.com's
A site's sessions served as cal.com's API v2 — event types, slots, bookings, schedules, webhooks — a booking page for cal.com's embed, and the kit's own cal.com client pointed at the site; the guide. The reference lists every route, argument and field.
5 minThe Store API, Shopify's
A site's store served as Shopify's Storefront API — products, collections and the cart at Shopify's endpoint under a public token — with a cart's checkout landing in the site's own bag; the guide. The reference lists every type and field served.
5 minThe Support API, Chatwoot's
The support desk served as Chatwoot's Client and Application APIs with webhooks, Chatwoot's website snippet mounting the site's widget on any page, and window.$chatwidget; the guide. The reference lists every route and field.
5 minThe community as a Matrix homeserver
The site's spaces and channels served as Matrix's Client-Server API, so Element and every other Matrix client works against it — how it is built, how a session stays the person's own, and what is deliberately absent.
5 minThe social network
A page per person, follows, a timeline and posts that each say who may read them — closed to the site's own people by default, and served to Bluesky's app and every atproto client over the same tables.
18 minPrint production
From a book's block to files at the printer — the editions, the typesetting, the covers, the EPUB, the printers behind one shape, the registry, and the store's pictures.
14 minSpoken books
The text-to-speech pipeline — made locally, named by the text, stored in the bucket, generated in the browser where missing — and its rules.
5 minReference
CLI commands
PlatformKit commands for developing, testing, building and deploying sites.
3 minEnvironment variables
Every setting, where it is read, and which the deploy refuses to run without.
19 minConfig keys
platformkit.config.js in one table, with defaults.
7 minFrontmatter by collection
Every field of every shared content record, as the files hold them and the admin edits them.
22 minFile map
Where things are — in a site, in the kit, in the theme — and the handful of places that are generated rather than written.
4 minThe content API reference
Every route, argument, operator, field, header and error of the Contentful-compatible content API a site serves, the Management API's writes and webhooks included — the reference; the guide is under Building a site.
9 minThe Forms API reference
Every route, argument, field, header and error of the Typeform-compatible Forms API a site serves — the reference; the guide is under Building a site.
5 minThe Scheduling API reference
Every route, argument, field, header and error of the cal.com-compatible Scheduling API a site serves — the reference; the guide is under Building a site.
5 minThe Store API reference
Every type, field, mutation and error of the Shopify-compatible Store API a site serves, the products' mapping and the cart's rules — the reference; the guide is under Building a site.
5 minThe Support API reference
Every route, field, event and error of the Chatwoot-compatible Support API a site serves, the snippet and window.$chatwidget — the reference; the guide is under Building a site.
5 minThe Matrix API reference
Every endpoint, id shape, error code and table of the Matrix Client-Server API a site serves — the reference; the guide is under Building a site.
7 minThe atproto API reference
Every method, identity path, token and refusal of the atproto server a site with the social network serves — the reference; the guide is under Building a site.
5 minSuppliers
The one interface anything that makes or sends a thing wears, and how a site adds its own.
4 min