Skip to content

Commit

Permalink
Aside: Add support for icon attribute to markdown shorthand.
Browse files Browse the repository at this point in the history
  • Loading branch information
shubham-padia committed Aug 27, 2024
1 parent bb048e4 commit 6f13b2b
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/src/content/docs/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,20 @@ Astro helps you build faster websites with [“Islands Architecture”](https://
:::
```

### Custom aside icons

You can specify a custom icon for the aside in curly brackets following the aside type/title, e.g. `:::tip[Did you know?]{icon="heart"}`.

:::tip[Did you know?]{icon="heart"}
Astro helps you build faster websites with [“Islands Architecture”](https://docs.astro.build/en/concepts/islands/).
:::

```md
:::tip[Did you know?]{icon="heart"}
Astro helps you build faster websites with [“Islands Architecture”](https://docs.astro.build/en/concepts/islands/).
:::
```

### More aside types

Caution and danger asides are helpful for drawing a user’s attention to details that may trip them up.
Expand Down
13 changes: 13 additions & 0 deletions packages/starlight/__tests__/remark-rehype/asides.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,19 @@ Some text
);
});

describe('custom icons', () => {
test.each(['note', 'tip', 'caution', 'danger'])('%s with custom label', async (type) => {
const res = await processor.render(`
:::${type}{icon="heart"}
Some text
:::
`);
expect(res.code).includes(
'M20.16 5A6.29 6.29 0 0 0 12 4.36a6.27 6.27 0 0 0-8.16 9.48l6.21 6.22a2.78 2.78 0 0 0 3.9 0l6.21-6.22a6.27 6.27 0 0 0 0-8.84m-1.41 7.46-6.21 6.21a.76.76 0 0 1-1.08 0l-6.21-6.24a4.29 4.29 0 0 1 0-6 4.27 4.27 0 0 1 6 0 1 1 0 0 0 1.42 0 4.27 4.27 0 0 1 6 0 4.29 4.29 0 0 1 .08 6Z'
);
});
});

test('ignores unknown directive variants', async () => {
const res = await processor.render(`
:::unknown
Expand Down
16 changes: 15 additions & 1 deletion packages/starlight/integrations/asides.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import { visit } from 'unist-util-visit';
import type { StarlightConfig } from '../types';
import type { createTranslationSystemFromFs } from '../utils/translations-fs';
import { pathToLocale } from './shared/pathToLocale';
import { Icons } from '../components/Icons';
import { fromHtml } from 'hast-util-from-html';
import type { Element } from 'hast';

interface AsidesOptions {
starlightConfig: { locales: StarlightConfig['locales'] };
Expand Down Expand Up @@ -150,6 +153,7 @@ function remarkAsides(options: AsidesOptions): Plugin<[], Root> {
return;
}
const variant = node.name;
const attributes = node.attributes;
if (!isAsideVariant(variant)) return;

// remark-directive converts a container’s “label” to a paragraph added as the head of its
Expand All @@ -171,6 +175,16 @@ function remarkAsides(options: AsidesOptions): Plugin<[], Root> {
node.children.splice(0, 1);
}

let iconPath = iconPaths[variant];
if (attributes) {
if (attributes['icon']) {
const iconName = attributes['icon'] as keyof typeof Icons;
const { properties } = fromHtml(Icons[iconName], { fragment: true })
.children[0] as Element;
iconPath = [s('path', properties)];
}
}

const aside = h(
'aside',
{
Expand All @@ -188,7 +202,7 @@ function remarkAsides(options: AsidesOptions): Plugin<[], Root> {
fill: 'currentColor',
class: 'starlight-aside__icon',
},
iconPaths[variant]
iconPath
),
...titleNode,
]),
Expand Down

0 comments on commit 6f13b2b

Please sign in to comment.