Skip to content

Commit

Permalink
[docs] add starlight overrides map link (#2417)
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Swithinbank <[email protected]>
  • Loading branch information
sarah11918 and delucis authored Oct 28, 2024
1 parent 1528a70 commit 57ab822
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/content/docs/guides/overriding-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Overriding Starlight’s default components can be useful when:
1. Choose the Starlight component you want to override.
You can find a full list of components in the [Overrides Reference](/reference/overrides/).

:::tip
Not sure which component you need to override? Use the [interactive Starlight Overrides Map](https://starlight-overrides-map.netlify.app/) to discover the names of Starlight's UI components.
:::

This example will override Starlight’s [`SocialIcons`](/reference/overrides/#socialicons) component in the page nav bar.

2. Create an Astro component to replace the Starlight component with.
Expand Down

0 comments on commit 57ab822

Please sign in to comment.