Introduction
starlight-plugin-icons
enhances Starlight in 2 places:
- Sidebar entries: add an
icon
field to items in your sidebar config. - Code blocks: shows a matching Material Icon based on language or
title
.
Everything is build-time.
It also ships:
- An improved
<FileTree>
component that renders folder/file icons automatically based on their names. - Improved
<Card>
and<Aside>
components that can be used with any icon. - An
<IconLink>
component that renders a link card with an icon.
Continue with Installation, then learn about Sidebar Icons and Code Block Icons.