Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Bug render alerts in doc website #13

Open
vinceAmstoutz opened this issue Oct 1, 2024 · 0 comments
Open

Bug render alerts in doc website #13

vinceAmstoutz opened this issue Oct 1, 2024 · 0 comments
Assignees
@ginifizz

Comments

@vinceAmstoutz
Copy link
Contributor

vinceAmstoutz commented Oct 1, 2024 •
edited
Loading

API Platform version(s) affected: 4.0.0

Description
By following the GitHub Alerts syntax, we expected rendering in docs website (with the actual code when using the GitHub preview):
image

But in the documentation website we have this rendering:
image

Real-world example : https://api-platform.com/docs/core/getting-started/#installing-api-platform

How to reproduce

Adding a caution alert message for example like this one:

> [!CAUTION]
> If you are migrating from an older version of API Platform, make sure you read the [Upgrade Guide](upgrade-guide.md).

Possible Solution
It's probably a bug in the site's MD parser.
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@ginifizz ginifizz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ginifizz @vinceAmstoutz