Support <aside> in markdown (.md) files the same way as github flavored md

[onionhammer]

What version of starlight are you using?

0.31.0

What is your idea?

It would be nice if

Note

Highlights information that users should take into account, even when skimming.

were supported in markdown and styled the same way as starlight aside components

Why is this feature necessary?

Currently you have to drop down to '.mdx' format, which is not as friendly for things like CMSs (ala https://pagescms.org/ )

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this feature.

[HiDeoo]

Currently you have to drop down to '.mdx' format, which is not as friendly for things like CMSs (ala pagescms.org )

Asides are supported in Markdown files in Starlight without to switch to .mdx format.

Aside blocks can be indicated using a pair of triple colons ::: to wrap the content, and can be of type note, tip, caution or danger.

For example, the following Markdown content in a .md file:

:::note
Starlight is a documentation website toolkit built with [Astro](https://astro.build/). You can get started with this command:

```sh
npm create astro@latest -- --template starlight
```

:::

Will be rendered as:

You can find more information about asides in Markdown files in this documentation: https://starlight.astro.build/guides/authoring-content/#asides

This is not exactly the same syntax as GitHub Markdown Alerts but definitely avoid the need of switching to MDX.

[onionhammer]

That's helpful, thanks!

That said, I think this proposal should still be considered - The syntax I proposed could be supported in addition to the existing syntax, and it's used by both github and vs code

preview comparison