starlight
starlight copied to clipboard
withastro
Aside: Support custom icons
Description
- Closes https://github.com/withastro/starlight/discussions/2251
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.
🦋 Changeset detected
Latest commit: 84f8780bcbf68c716ad2a529d9b59cf3afadd07f
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 2 packages
| Name | Type |
|---|---|
| @astrojs/starlight-markdoc | Minor |
| @astrojs/starlight | Minor |
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
![changeset-bot[bot] avatar](https://avatars.githubusercontent.com/in/28616?v=4 "Published by a pub.dev verified publisher"){kind=small}
Deploy Preview for astro-starlight ready!
| Name | Link |
|---|---|
| Latest commit | 84f8780bcbf68c716ad2a529d9b59cf3afadd07f |
| Latest deploy log | https://app.netlify.com/projects/astro-starlight/deploys/68779cf49a032f00082079ab |
| Deploy Preview | https://deploy-preview-2261--astro-starlight.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
Lighthouse |
1 paths audited Performance: 96 (🔴 down 4 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 100 (no change from production) PWA: - View the detailed breakdown and full score reports |
To edit notification comments on pull requests, go to your Netlify project configuration.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hello! Thank you for opening your first PR to Starlight! ✨
Here’s what will happen next:
-
Our GitHub bots will run to check your changes. If they spot any issues you will see some error messages on this PR. Don’t hesitate to ask any questions if you’re not sure what these mean!
-
In a few minutes, you’ll be able to see a preview of your changes on Netlify 🤩
-
One or more of our maintainers will take a look and may ask you to make changes. We try to be responsive, but don’t worry if this takes a few days.
Lunaria Status Overview
🌕 This pull request will trigger status changes.
Learn more
By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.
You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.
Tracked Files
| Locale | File | Note |
|---|---|---|
| en | components/asides.mdx | Source changed, localizations will be marked as outdated. |
| en | guides/authoring-content.mdx | Source changed, localizations will be marked as outdated. |
Warnings reference
| Icon | Description |
|---|---|
| 🔄️ | The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied. |
Really sorry for the delayed response.
As we have been thinking and exploring support for custom icons in Starlight (e.g. from Iconify icon sets and also local ones), we also have been investigating how such support for aside icons could be implemented to make sure there would be no conflict or breaking changes between your PR and later, when we implement custom icons.
I'll make sure to bring this up with Chris next time we chat, so we can get back to you with a concrete plan and a review of your PR as soon as possible.
@HiDeoo Thank you for the detailed review:)
I've addressed the review comments and made appropriate changes
Hope you won't mind but I just updated the branch and also pushed the last suggestions I made during my last review so we can more easily evaluate with the team what remains to be done exactly before we can release your amazing work.