Skip to main content
Starlight

Search documentation

Type to search this documentation.

On this pageOverview

Community Content

Here is a collection of posts and articles to learn more about Starlight and other people's experiences:

Recipes are typically short, focused how-to guides that walk a reader through completing a working example of a specific task. Recipes are a great way to add new features or behavior to your Starlight project by following step-by-step instructions! Other guides might explain concepts related to an area of content, such as using images or working with MDX.

Explore community-produced content maintained by Starlight users:

Versioned documentation with Starlight & Vercel

A guide to implementing separate versions of documentation for each major version of a project.

Add links to Starlight headings

A guide to using a rehype plugin to share links to specific sections of your documentation.

Add sponsors to your Starlight site

A guide to implement a custom sponsors component in your documentation sidebar.

Add Open Graph images to Starlight

A guide to generating social images and the corresponding meta tags for your pages.

Use third-party icon sets in Starlight

A guide to using unplugin-icons to expand the selection of available icons for Starlight.

Edit the HTML head of Starlight pages

Learn how to add common head content such as web analytics, fonts, and scripts.

Publishing Documentation with Astro Starlight

Getting started with Starlight documentation.

Enable View Transitions

Add support for view transitions, client-side routing, and SPA-like navigation to your Starlight documentation site.

Adding Structured Data to Starlight Pages

Learn how to build dynamic JSON-LD structured data for your documentation pages.

Starlight Examples

A collection of StackBlitz embeds demonstrating practical ways of doing stuff in Starlight documentation sites.

Starlight Plugins by Example

A collection of notes and examples about Starlight plugins and common patterns used to build them.

Add a reading progress indicator

Find out how to add a horizontal reading progress bar to your Starlight site.

Apply custom styles to your Starlight sidebar

Using a little bit of CSS to adjust fonts, colours and more of the Starlight sidebar.

Starlight Topics Dropdown on mobile, List on desktop

Combine two plugins to have the best of both on desktop and mobile devices.

Processing Starlight sidebars with middleware

Use route middleware to control sidebar ordering and group labels, inspired by Nuxt Content’s conventions.

Add social links with custom icons to Starlight

Learn how to use custom icons for social links in Starlight website header.

Paste images to Starlight pages with Visual Studio Code

Improve your Starlight documentation workflow by pasting images to your documentation pages using Visual Studio Code.

Add diagrams to your Starlight documentation using D2

Learn how to use D2 to add diagrams to your Starlight documentation.

Generate Open Graph images for Starlight using the Cloudinary Astro SDK

Learn how to use the Cloudinary Astro SDK to generate Open Graph images for your Starlight documentation website.

List recent GitHub releases in Starlight using the Astro Content Layer API

Learn how to use the Astro Content Layer API to list the recent GitHub releases in a Starlight project.

Add a sitewide banner to Starlight

Learn how to create a sitewide banner using Starlight's built-in per-page banner feature.

Customizing Astro Starlight Sidebar for Gated Content with Authentication

Secure your course material by using Clerk and SSR to dynamically hide or reveal Starlight sidebar chapters based on user login.

Collect user feedback with Encatch

Add in-page reader feedback, suggested edits, and issue reports to your Starlight docs.

Discover videos and channels with Starlight content, including live streams and educational content.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu