# astro-project-site > A whole site for your open-source project, from one Astro integration. Documentation for astro-project-site. Source: https://github.com/pavelpascari/astro-project-site ## Docs - [Overview](https://astro-project-site.pascaripavel.workers.dev/docs/): astro-project-site turns an open-source library's repo into a site - landing page, Starlight docs that mount your markdown, live examples, a gallery, static demos, Cloudflare deploys. - [Reference](https://astro-project-site.pascaripavel.workers.dev/docs/reference/): Every option, component, prop, command, schema and token of astro-project-site, generated from the package source. - [Quick start](https://astro-project-site.pascaripavel.workers.dev/docs/quick-start/): Create a site with project-site init, run it, make the first edits and build it. - [Add it to an existing repo](https://astro-project-site.pascaripavel.workers.dev/docs/existing-repo/): The realistic setup - a website/ folder inside your library's repo, mounting ../docs and serving ../ demos, with CI from the repo root. ## Guides - [Configure the site](https://astro-project-site.pascaripavel.workers.dev/docs/guides/configure/): Identity, navigation, version, social images, footer and accent colour - the options every site sets. - [Landing page](https://astro-project-site.pascaripavel.workers.dev/docs/guides/landing-page/): The landing page from config (hero, live demo, features, steps, gallery strip, call to action), or your own page built from the same components. - [Docs](https://astro-project-site.pascaripavel.workers.dev/docs/guides/docs/): Local MDX pages, mounting markdown from your repo or another one (titles, link rewriting, order, exclude, edit links), and the generated sidebar. - [Live examples](https://astro-project-site.pascaripavel.workers.dev/docs/guides/live-examples/): Write an example once; the page shows the code and runs it - inline or in an iframe, editable, or through your own runner module. - [Markdown](https://astro-project-site.pascaripavel.workers.dev/docs/guides/markdown/): Everything GitHub-flavoured markdown renders, on every page - alerts, task lists, footnotes, math, Mermaid diagrams, emoji - plus code blocks with titles, terminals, diffs, line numbers and copy buttons. - [Gallery](https://astro-project-site.pascaripavel.workers.dev/docs/guides/gallery/): Gallery entries (YAML, JSON or Markdown), posters, kinds and tags, the /gallery/ page with filters, and the strip on the landing page. - [Mirrors](https://astro-project-site.pascaripavel.workers.dev/docs/guides/mirrors/): Serve static HTML/JS folders (a playground, demos, your library's src/) byte for byte next to the docs, with their relative layout intact. - [Docs generation](https://astro-project-site.pascaripavel.workers.dev/docs/guides/docs-generation/): Keep API tables and other facts in your markdown in sync with the code - docs:gen fills marked blocks, docs:check fails CI when one is stale. - [Theming](https://astro-project-site.pascaripavel.workers.dev/docs/guides/theming/): Restyle the whole site - landing, gallery and docs - from a few CSS tokens, for light and dark, with custom CSS and fonts. - [Overriding components](https://astro-project-site.pascaripavel.workers.dev/docs/guides/overriding-components/): Replace the header, footer, hero, landing body, gallery card or gallery page with your own components, and pass anything else through to Starlight. - [Deploying](https://astro-project-site.pascaripavel.workers.dev/docs/guides/deploying/): Deploy from your machine with npm run deploy, or opt into CI (init --ci) for checks, a preview per pull request and production from tags; Cloudflare Workers static assets, custom domains and API token permissions. - [Upgrading](https://astro-project-site.pascaripavel.workers.dev/docs/guides/upgrading/): Update the package, the reusable workflow pin and the files init copied, and what to check afterwards. ## Recipes - [Monorepo with external docs](https://astro-project-site.pascaripavel.workers.dev/docs/recipes/monorepo/): One site for a multi-package repo - each package's docs folder mounted under its own route, examples mirrored, the site as an npm workspace member, CI from the root. - [Separate site repo](https://astro-project-site.pascaripavel.workers.dev/docs/recipes/separate-repo/): Keep the website in its own repository and read the library's docs from it with a git source, or its docs and demos from a second checkout, locally and in CI with source-repo. - [Search and analytics](https://astro-project-site.pascaripavel.workers.dev/docs/recipes/search-and-analytics/): Pagefind search out of the box, swapping in another search through Starlight, and adding an analytics script to every page. - [Languages](https://astro-project-site.pascaripavel.workers.dev/docs/recipes/i18n/): A site in one language other than English, right-to-left languages, changing the template's words, and what multilingual sites can expect. - [Accessibility](https://astro-project-site.pascaripavel.workers.dev/docs/recipes/accessibility/): What the template does for keyboard, screen-reader and low-vision readers, and how each change is checked. - [Troubleshooting](https://astro-project-site.pascaripavel.workers.dev/docs/recipes/troubleshooting/): Link validator failures, mirror collisions, edit links without git, a page missing from the sidebar, option errors and deploy problems. ## Reference - [Options](https://astro-project-site.pascaripavel.workers.dev/docs/reference/options/): Every projectSite() option with its type, default and description, generated from options.mjs and index.d.ts. - [Components](https://astro-project-site.pascaripavel.workers.dev/docs/reference/components/): Every component exported from astro-project-site/components, with its props, defaults and slots. - [Live and runners](https://astro-project-site.pascaripavel.workers.dev/docs/reference/live/): The component's props and the contract for custom runner modules (LiveRunner, LiveContext). - [Content collections](https://astro-project-site.pascaripavel.workers.dev/docs/reference/content/): projectSiteCollections(), the gallery item schema and docs frontmatter. - [CLI](https://astro-project-site.pascaripavel.workers.dev/docs/reference/cli/): The project-site command - init, docs:gen, docs:check, deploy:preview. - [Theme tokens](https://astro-project-site.pascaripavel.workers.dev/docs/reference/theme-tokens/): The --site-* CSS custom properties every page (docs included) is styled from, with their default values. - [Exports and virtual modules](https://astro-project-site.pascaripavel.workers.dev/docs/reference/exports/): The package's entry points, its public types, and the virtual modules behind astro-project-site/config. ## Blog - [How the docs mount works](https://astro-project-site.pascaripavel.workers.dev/blog/2026/how-the-docs-mount-works/): A markdown folder written for GitHub becomes Starlight pages without moving a file. What happens to each page on the way, and why. (2026-11-18) - [Introducing astro-project-site](https://astro-project-site.pascaripavel.workers.dev/blog/2026/introducing-astro-project-site/): One Astro integration that gives an open-source project a landing page, docs mounted from its own markdown, live examples, a gallery, a blog and preview deploys. (2026-11-10) ## Optional - [Full documentation as one file](https://astro-project-site.pascaripavel.workers.dev/llms-full.txt): every page above, as markdown