Aside: Support custom icons #2261

shubham-padia · 2024-08-27T11:34:52Z

Description

Closes Ability to pass a custom icon to <Aside> #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-bot · 2024-08-27T11:34:56Z

🦋 Changeset detected

Latest commit: 84f8780

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

netlify · 2024-08-27T11:35:07Z

✅ Deploy Preview for astro-starlight ready!

Name	Link
🔨 Latest commit	`84f8780`
🔍 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.

astrobot-houston · 2024-08-27T11:35:21Z

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.

astrobot-houston · 2024-08-27T11:35:33Z

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.

shubham-padia · 2024-08-27T12:02:07Z

docs/src/content/docs/guides/authoring-content.md

+Astro helps you build faster websites with [“Islands Architecture”](https://docs.astro.build/en/concepts/islands/).
+:::
+```
+


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

packages/starlight/integrations/asides.ts

shubham-padia · 2024-10-01T05:29:45Z

Bumping this up for review, thanks!

shubham-padia · 2025-04-22T13:51:35Z

Bumping this up for a review, thanks! cc. @HiDeoo @delucis

shubham-padia · 2025-05-14T06:51:22Z

Bumping this up for a review, thanks :) !

HiDeoo · 2025-05-14T07:14:10Z

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.

shubham-padia · 2025-05-14T08:10:04Z

thank you for the update!

HiDeoo

Thanks for the amazing contribution and sorry again for the delay in getting back to you 🙌

After discussing and exploring custom icons in Starlight (e.g. from Iconify icon sets and also local ones), it looks we should be able to safely move on with your PR and later on, build on top of it to also support more custom icons in asides too.

I'm sharing a first review, mostly focused on the technical side of things, rather than the documentation, but this should help us get started in finalizing your great work.

Let me know if you have any questions or need any help with some points, do not hesitate to ask.

docs/src/content/docs/guides/authoring-content.mdx

packages/starlight/__tests__/remark-rehype/asides.test.ts

packages/starlight/integrations/asides.ts

docs/src/content/docs/components/asides.mdx

packages/starlight/user-components/Aside.astro

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 · 2025-06-16T07:37:25Z

@HiDeoo Thank you for the detailed review:)

I've addressed the review comments and made appropriate changes

HiDeoo

Amazing update 🙌 Thanks a lot for all your work 🌟 (love the new test you added for icons with multiple paths 👌)

Left a few tiny comments/suggestions but most of them are quite tiny wording changes or missing imports, nothing major.

docs/src/content/docs/guides/authoring-content.mdx

packages/starlight/__tests__/remark-rehype/asides.test.ts

packages/starlight/integrations/asides.ts

packages/starlight/__tests__/remark-rehype/asides.test.ts

* main: (26 commits) [ci] release (withastro#3296) Fix slug override with `/` value (withastro#3293) i18n(fr): update `guides/i18n.mdx` (withastro#3294) i18n(ko-KR): update `i18n.mdx` (withastro#3292) [ci] release (withastro#3286) Revert withastro#3281 (withastro#3291) i18n(de): update `guides/i18n.mdx` (withastro#3289) Fix Astro i18n config default locale issue (withastro#3288) docs: fix `t.exists()` documentation + example (withastro#3287) Make targeting sidebar links with CSS a little easier (withastro#3281) i18n(fr): update `resources/plugins.mdx` (withastro#3284) Extract main padding to CSS custom property (withastro#3282) i18n(de): update plugins translation (withastro#3285) i18n(ko-KR): update `plugins.mdx` (withastro#3283) Add link to the codeblock-fullscreen plugin (withastro#3279) Fix TabItem typo in zh-cn authoring-content.mdx (withastro#3268) (withastro#3269) [ci] format i18n(ru): update translations (withastro#3270) Update `sharp` in docs & examples to latest (withastro#3261) Add missing danish UI translations (withastro#3252) ...

HiDeoo · 2025-07-15T08:40:25Z

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.

* main: Small updates to `tailwind` template (withastro#3303) docs: showcase `astro-d2` and "Starlight Plugins by Example" (withastro#3302) [ci] release (withastro#3301) Fix `absolutePathToLang()` issue (withastro#3298)

* main: Exclude banner content from Pagefind indexing (withastro#3276) Restrict remark/rehype plugins usage (withastro#3274) [ci] release (withastro#3307) Fix Astro i18n default locale regression (withastro#3306) i18n(de): translate `plugins.mdx` and `community-content.mdx` (withastro#3304)

HiDeoo

Thanks for your amazing work and your patience 🙌

Hope you won't mind us tweaking some last details so we can push this over the finish line, but it now looks perfect to me and ready to released in our next minor version 🎉 🚀

Co-authored-by: HiDeoo <[email protected]> Co-authored-by: Chris Swithinbank <[email protected]>

github-actions bot added 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package labels Aug 27, 2024

shubham-padia force-pushed the support-custom-icons branch from 6f13b2b to ba8211d Compare August 27, 2024 12:00

shubham-padia commented Aug 27, 2024

View reviewed changes

shubham-padia force-pushed the support-custom-icons branch from ba8211d to 999fbce Compare August 27, 2024 12:03

shubham-padia commented Aug 27, 2024

View reviewed changes

packages/starlight/integrations/asides.ts Show resolved Hide resolved

shubham-padia commented Aug 27, 2024

View reviewed changes

packages/starlight/integrations/asides.ts Outdated Show resolved Hide resolved

shubham-padia marked this pull request as ready for review August 27, 2024 12:05

shubham-padia changed the title ~~Draft: Support custom icons~~ Support custom icons Aug 27, 2024

shubham-padia changed the title ~~Support custom icons~~ Aside: Support custom icons Aug 27, 2024

shubham-padia force-pushed the support-custom-icons branch from 999fbce to da7a1b7 Compare October 1, 2024 05:26

HiDeoo mentioned this pull request Jan 3, 2025

Fully support Obsidian Callout rendering HiDeoo/starlight-obsidian#40

Closed

HiDeoo mentioned this pull request Mar 26, 2025

Add support for custom icons #3024

Draft

13 tasks

shubham-padia force-pushed the support-custom-icons branch from da7a1b7 to c1029ae Compare April 22, 2025 13:48

HiDeoo requested changes May 30, 2025

View reviewed changes

shubham-padia force-pushed the support-custom-icons branch from c1029ae to 8a981cc Compare June 16, 2025 07:34

github-actions bot added the 🌟 markdoc Changes to Starlight’s Markdoc package label Jun 16, 2025

shubham-padia added 2 commits June 16, 2025 13:06

Aside: Add support for icons attribute.

353fcfc

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.

Aside: Add support for icon attribute to markdown shorthand.

1b6ade5

shubham-padia force-pushed the support-custom-icons branch from 8a981cc to 1b6ade5 Compare June 16, 2025 07:36

HiDeoo requested changes Jul 2, 2025

View reviewed changes

delucis added this to the v0.35 milestone Jul 14, 2025

HiDeoo added 6 commits July 15, 2025 09:48

fix: missing type import

655a4ff

test: tweak test names

375aa1d

test: remove md processor error logs

80c1900

docs: tweak authoring content docs

54e03e8

chore: add changesets

b1a0762

HiDeoo and others added 6 commits July 16, 2025 10:51

refactor: invalid aside icon error

152af78

Merge branch 'main' into support-custom-icons

f817a91

* main: Small updates to `tailwind` template (withastro#3303) docs: showcase `astro-d2` and "Starlight Plugins by Example" (withastro#3302) [ci] release (withastro#3301) Fix `absolutePathToLang()` issue (withastro#3298)

test: refactor icon tests

04c478f

Increase Starlight peer dependency version in Markdoc package

0d38ff3

Update type in icon attribute reference

84f4c63

HiDeoo approved these changes Jul 16, 2025

View reviewed changes

HiDeoo added 🌟 minor Change that triggers a minor release ✅ approved Pull requests that have been approved and are ready to merge when next cutting a release labels Jul 16, 2025

delucis merged commit 778b743 into withastro:main Jul 16, 2025
16 checks passed

astrobot-houston mentioned this pull request Jul 16, 2025

[ci] release #3308

Merged

trueberryless mentioned this pull request Jul 16, 2025

i18n(de): update asides.mdx & authoring-content.mdx #3309

Merged

This was referenced Jul 16, 2025

i18n(fr): update components/asides.mdx #3313

Merged

i18n(fr): update guides/authoring-content.mdx #3314

Merged

This was referenced Jul 17, 2025

i18n(ko-KR): update asides.mdx #3319

Merged

i18n(ko-KR): update authoring-content.mdx #3320

Merged

Yoxnear pushed a commit to Yoxnear/starlight-custom that referenced this pull request Jul 23, 2025

Aside: Support custom icons (withastro#2261)

c14e712

Co-authored-by: HiDeoo <[email protected]> Co-authored-by: Chris Swithinbank <[email protected]>

HiDeoo mentioned this pull request Jul 25, 2025

Prevent Cloudflare build issues due to Node.js builtins usage #3341

Merged

1 task

Uh oh!

Aside: Support custom icons #2261

Aside: Support custom icons #2261

Uh oh!

Conversation

shubham-padia commented Aug 27, 2024

Description

Uh oh!

changeset-bot bot commented Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

netlify bot commented Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for astro-starlight ready!

Uh oh!

astrobot-houston commented Aug 27, 2024

Uh oh!

astrobot-houston commented Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

shubham-padia Aug 27, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shubham-padia commented Oct 1, 2024

Uh oh!

shubham-padia commented Apr 22, 2025

Uh oh!

shubham-padia commented May 14, 2025

Uh oh!

HiDeoo commented May 14, 2025

Uh oh!

shubham-padia commented May 14, 2025

Uh oh!

HiDeoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shubham-padia commented Jun 16, 2025

Uh oh!

HiDeoo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HiDeoo commented Jul 15, 2025

Uh oh!

HiDeoo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Aug 27, 2024 •

edited

Loading

netlify bot commented Aug 27, 2024 •

edited

Loading

astrobot-houston commented Aug 27, 2024 •

edited

Loading

HiDeoo left a comment •

edited

Loading