Starlight plugins offer an easy-to-share and reusable way to customize and extend Starlight, the fully-featured documentation theme built on top of the Astro framework.
This notebook is a collection of personal notes and examples I have gathered while working on many Starlight plugins. Checking out existing plugins is also a great way to learn how to create your own Starlight plugins.
Prerequisites
These notes and examples assume you have a basic understanding of Starlight, Astro, and TypeScript. Make sure to check out the Starlight and Astro documentation for more information and references.
Getting Started
- Published on - Reading time
How to create a Starlight plugin
Published on - Reading timeHow to create a Starlight theme
Published on - Reading time
Examples
Read and update the Starlight configuration in a Starlight plugin
Published on - Reading timeRead and update the Astro configuration in a Starlight plugin
Published on - Reading timeAdd support for user configuration in a Starlight plugin
Published on - Reading timeAdd custom CSS in a Starlight plugin
Published on - Reading timeExpose Astro components in a Starlight plugin
Published on - Reading timeOverride a Starlight component in a Starlight plugin
Published on - Reading timeCustomize Starlight's route data in a Starlight plugin
Published on - Reading timeExtend Starlight’s frontmatter schema in a Starlight plugin
Published on - Reading timeShare data between a Starlight plugin and Astro's runtime
Published on - Reading timeUse a remark or rehype plugin in a Starlight plugin
Published on - Reading timeUse custom translation strings in a Starlight plugin
Published on - Reading time