Aside: Support custom icons #2261
Conversation
|
github-actions
bot
added
📚 docs
✅ Deploy Preview for astro-starlight ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hello! Thank you for opening your first PR to Starlight! ✨ Here’s what will happen next:
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
shubham-padia
force-pushed
the
support-custom-icons
branch
from
6f13b2b to
ba8211d
Compare
| Astro helps you build faster websites with [“Islands Architecture”](https://docs.astro.build/en/concepts/islands/). | ||
| ::: | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I'm not sure whether this should have a different header of its own or should we just specify it along with the custom aside title markdown
shubham-padia
force-pushed
the
support-custom-icons
branch
from
ba8211d to
999fbce
Compare
| iconPath = [s('path', properties)]; | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
This feels a bit ugly-ish to me, any pointers to improve this would be welcome!
| const iconName = attributes['icon'] as keyof typeof Icons; | ||
| if (!Object.keys(Icons).includes(iconName)) { | ||
| throw new AstroError("Icon name should be part of Starlight's icon list."); | ||
| } |
There was a problem hiding this comment.
I've put a placeholder error for now, please feel free to suggest another error message that might follow starlight's guidelines.
Only built-icons will be supported for now. This commit does not add support for the `:::` markdown shorthand for defining an aside, that will be done in the next commit.
shubham-padia
force-pushed
the
support-custom-icons
branch
from
999fbce to
da7a1b7
Compare
|
Bumping this up for review, thanks! |
Description
This PR adds the ability to pass icon attribute to the Aside component. This icon attribute can be any icon supported by starlight by default.