A component and styling framework for building Astro sites, designed around efficiency, scalability and accessibility.

Documentation lives at lumosframework.com.

Beta. Every 0.x release is allowed to break things, and the component props and their placements are the parts still moving — the tokens, layers and CSS are not. v1.0.0 is where the API gets committed to; breaking it after that would take a v2.0.0.

Starting a site before then does not strand it. create-lumos stamps the commit your site came from, and /lumos-upgrade-version three-way merges each release into your own changes and pixel-diffs every page, so an upgrade is a reviewed diff rather than a rewrite. The badge above carries the current release.

Getting started

npm create lumos@latest portfolio

That scaffolds a new site from this repository and installs its dependencies with whichever package manager you ran it with. Then:

cd portfolio
npm run dev

Script	What it does
npm run dev	Starts the dev server
npm run build	Builds the site to dist/
npm run preview	Serves the built site
npm run check	Type-checks every .astro file
npm run format	Formats the project with Oxfmt
npm run lint	Lints the project with Oxlint

Install tools with mise. mise.toml requests the current Node.js LTS (node = "lts"), and mise.lock records the release that resolved to. Then:

mise install
mise run dev

Documentation

Component reference, styling guides and examples are at lumosframework.com.

Contributing

Read CONTRIBUTING.md first — a pull request needs the CLA signed before it can be merged.

License

MIT