-
-
Notifications
You must be signed in to change notification settings - Fork 809
Description
What version of starlight
are you using?
0.36.0
What version of astro
are you using?
5.14.4
What package manager are you using?
npm
What operating system are you using?
Linux
What browser are you using?
Chrome, Firefox
Describe the Bug
We need to use a symlink in content/docs
that points to another folder higher up to make contribution of guides in our open source project (RIOT OS) more accessible.
We need a symlink so that we can still have the remark
and rehype
plugins that are applied by starlight
and only work with files from the content/docs
folder.
We found a strange impact on rendering of :::note
annotations with .mdx
files when they come from the symlink. Even more strange is that this works for normal .md
files. Only .mdx
files are affected.
Background
Normally in .mdx
files I can write this:
:::note
This is a note
:::
and it renders as this:
Note
This is a note
But in a .mdx
file that comes from a symlink this is ignored and the text is just printed normally without formatting.
Link to Minimal Reproducible Example
https://github.com/LasseRosenow/starlight-symlink-mdx-bug
Probably related:
Participation
- I am willing to submit a pull request for this issue.