Starlight Pages Builder

Version updated for https://github.com/OzzyCzech/starlight to version v2.

  • This action is used across all versions by 1 repositories.

Action Type

This is a Composite action.

Go to the GitHub Marketplace to find the latest changes.

Action Summary

The Starlight Action is a GitHub Action designed to automate the process of building and deploying an Astro Starlight-based static site to GitHub Pages directly from a Markdown repository. It simplifies site creation by requiring minimal configuration and provides features like autogenerated sidebars, Open Graph image generation, internal link rewriting, and YouTube embedding. This action streamlines static site deployments by handling content transformation, templating, and publishing seamlessly.

What’s Changed

First Marketplace-ready release — registered on the GitHub Marketplace as Starlight Pages Builder. Major rewrite from v1 (which was wiki-specific) into a generic Astro Starlight builder with batteries-included content tooling.

What this action does

Builds an Astro Starlight site from a Markdown content repo and uploads it as a GitHub Pages artifact. Drop in your *.md files and ship.

Highlights

Core

  • Markdown + MDX → static Starlight site, GitHub Pages artifact
  • Optional starlight.config.mjs for full sidebar/theme/components control
  • src/components/ overlay + @components/* / @assets/* path aliases
  • README.md fallback as homepage when no index.md (respects existing src/content/docs/index.md from overlays)
  • Per-project starlight-version / astro-version overrides — no fork required
  • base input for project pages at /<repo>/
  • Default title derived from repo name when caller has no config

Content tooling

  • Auto-generated Open Graph images per page (Satori + Resvg). 1200×630 PNG at `/og/.png` with refined default layout (typography hierarchy, accent gradient bar, soft radial blooms). Configurable via the new `og:` block (brand, tagline, domain, accent gradient, logo, custom `bgGradient`). Per-page override via `ogImage:` frontmatter. Bring your own renderer by dropping `src/og/renderer.tsx` into your repo.
  • Bundled Inter (Regular + Bold) with full glyph coverage — Czech, Polish, Vietnamese and other Latin-extended scripts render correctly out of the box (no font-fetch at build time).
  • YouTube embed remark plugin: bare `youtube.com` and `youtu.be` links auto-render as embedded iframes with full `allow` attributes.
  • Internal-link rewriting rehype plugin — links pointing at your site host become relative URLs.
  • Built-in `/path.md` raw-markdown endpoint and `/rss.xml` feed.

Breaking from v1

v1 was wiki-specific with a hardcoded sidebar bundled in the action. v2 is generic — you must provide your own `starlight.config.mjs` if you want a custom sidebar. See README for the new layout.