astro-project-site is one Astro integration that gives an open-source library or framework its website:
- a landing page written as config (hero, features, steps, gallery strip, call to action) or as your own page built from the same components;
- Starlight docs that mount your repo’s existing
docs/folder as it is: titles from the first heading,.mdlinks rewritten, “edit this page” links into the right folder, a generated sidebar, link checking, search,llms.txt; - live examples (
<Live>): the code on the page is the code that runs, inline or in an iframe, editable, with your own runner for JSON specs or DSLs; - a gallery of demos with posters and filters;
- mirrors: static HTML/JS folders (a playground, your library’s
src/) served byte for byte next to the docs; - generated docs blocks (
docs:gen/docs:check) so API tables cannot drift from the code; - Cloudflare Workers deploys with a preview URL per pull request,
nextfrommainand production from tags.
This site is built with it. The page you are reading is a local MDX page, and the reference tables are generated
from the package source. The starter, deployed as init
creates it, shows a mounted folder: its Reference
is plain markdown mounted with externalDocs.
What it is not
Section titled “What it is not”- Not a fork of Starlight. It configures Starlight for you and passes anything else through
(
starlightoption). Starlight plugins, components and frontmatter work as documented upstream. - Not a theme you copy and edit. Upgrades come from npm. You change the site with options, CSS tokens and component overrides.
- Not multilingual yet. One locale; see i18n.
- Not a server. The output is static files. The deploy tooling targets Cloudflare Workers static assets, but
dist/works on any static host. - GitHub-shaped. Edit links and links to source files use GitHub’s URL layout (
/edit/,/blob/,/tree/).
Requirements: Node 22.23.4+ (or 24), Astro 7.4.7+, Starlight 0.43+.
Where to go
Section titled “Where to go”For agents
Section titled “For agents”Everything an agent needs to configure a site is in Options (one table, generated
from the schema) and Components. The whole documentation is also served as
markdown at /llms.txt (index) and /llms-full.txt (every page in one file).
Options are validated before Astro starts, so a wrong key fails astro build with the field’s path.