diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 9906df38447..bda4c30ef0a 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -70,6 +70,8 @@ export default defineConfig({ customCss: ['./src/assets/landing.css'], locales, sidebar: [ + // TODO(HiDeoo) Remove me + { slug: 'test', badge: { text: 'Remove me', variant: 'danger' } }, { label: 'Start Here', translations: { diff --git a/docs/package.json b/docs/package.json index 573f6e59594..3796c0e0436 100644 --- a/docs/package.json +++ b/docs/package.json @@ -18,6 +18,7 @@ "dependencies": { "@astro-community/astro-embed-youtube": "^0.5.6", "@astrojs/starlight": "workspace:*", + "@iconify-json/mdi": "^1.2.3", "@lunariajs/core": "^0.1.1", "@types/culori": "^2.1.1", "astro": "^5.5.3", diff --git a/docs/src/components/icons-list.astro b/docs/src/components/icons-list.astro index e0e37a98207..1498d5796bf 100644 --- a/docs/src/components/icons-list.astro +++ b/docs/src/components/icons-list.astro @@ -1,6 +1,6 @@ --- import { Icon } from '@astrojs/starlight/components'; -import { Icons, type StarlightIcon } from '../../../packages/starlight/components/Icons'; +import { Icons, type StarlightIcon } from '../../../packages/starlight/utils/icons'; interface Props { labels?: { diff --git a/docs/src/content/docs/components/asides.mdx b/docs/src/content/docs/components/asides.mdx index a28375b0d60..7137f51a5a8 100644 --- a/docs/src/content/docs/components/asides.mdx +++ b/docs/src/content/docs/components/asides.mdx @@ -132,6 +132,36 @@ A warning aside *with* a custom title. +### Use custom icons + +Override the default aside icons by using the [`icon`](#icon) attribute set to the name of [one of Starlight’s built-in icons](/reference/icons/#all-icons). + + + +```mdx 'icon="starlight"' +import { Aside } from '@astrojs/starlight/components'; + + +``` + + + +```markdoc 'icon="starlight"' +{% aside type="tip" icon="starlight" %} +A warning aside *with* a custom icon. +{% /aside %} +``` + + + + + + + ## `