Closed mikimih closed 4 months ago
As I explained in my initial PR comment:
The default Starlight Aside component cannot be overridden, which results in the default Starlight icon on "tip" admonitions with triple colons (:::) syntax.
To address this, I created a custom Aside component to use the correct icons per our design. This custom component should be used in MDX files for accurate "tip" annotations.
I've now pushed updates to the MDX files, replacing the triple colon syntax with a custom Aside component.
Thanks @mikimih! Just to note that there are admonitions left to change to <Aside>
, but I opened issue #37 to track this earlier. I'll send a PR to change them docs-wide.
Restyle Starlight Admonitions Based on Design
This PR adds a new Aside component to match the design for admonitions.
How to Use in MDX Files
There are two ways to create admonitions:
:::tip[Did you know?] Astro helps you build faster websites with Islands Architecture. :::
:::caution Think twice before using Starlight if you're unsure. :::
Notes
and
We recommend using the second option with the Aside component, as it uses the icons from our design.