StellarAdmin Website
Documentation site for the StellarAdmin components, built with TanStack Start and Fumadocs.
Stack
- TanStack Start (Vite) — app framework, static prerendering (SSG)
- Fumadocs (
fumadocs-core / fumadocs-ui / fumadocs-mdx) — docs engine + MDX content
- Tailwind CSS v4 + shadcn/ui (base-ui,
base-vega style) with the Fumadocs shadcn theme
- oxlint / oxfmt — lint & format
Requirements
This project uses pnpm and blocks other package managers (engine-strict + only-allow pnpm). Install pnpm first.
pnpm install
Scripts
pnpm dev # start the dev server (http://localhost:3000)
pnpm build # build + static prerender to .vercel/output
pnpm preview # preview the production build
pnpm lint # oxlint + oxfmt check
pnpm format # oxfmt (write)
pnpm types:check # regenerate .source types + tsc --noEmit
Content
- Docs live in
content/docs (the ui section). Navigation is driven by meta.json files. MDX partials under _include/ are pulled in with <include> and are not standalone pages.
- Blog posts live in
content/blog.
- Static component demos are served from
public/demo and embedded via the <Demo> component. They are exported by DocsSamplesGenerator in the separate stellar-admin product repo, which injects a script into every page so demos follow the site's light/dark mode (the next-themes theme localStorage key) — same-origin localStorage plus storage events, no iframe messaging. The demos use the default theme. The theme builder's presets ship under stable names in public/demo/ui/assets/presets/ (one variable file each, listed in presets.json, exported from the product's theme fixtures in util/theme-check/presets/). The variable manifest for the theme builder is assets/stellar-admin.theme-variables.json.
Notes
- OG image generation (the old Next.js
/og/docs/... route) is not yet ported; it needs a satori/takumi-based renderer on TanStack Start and is tracked as a follow-up.
Contributing
Read contributor guidance for verification, generated-content ownership, and cross-repository work. This website builds independently; a product checkout is needed only when changing or regenerating product samples.
