Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

The documentation contains a lot of broken admonitions #79

Open
Ansis100 opened this issue Apr 15, 2024 · 1 comment
Open

The documentation contains a lot of broken admonitions #79

Ansis100 opened this issue Apr 15, 2024 · 1 comment

Comments

@Ansis100
Copy link

Admonitions are the call-outs that contain valuable information, for example, Note or Warning.
A lot of these are broken in the documentation.

I suspect it might be because of a missing newline, but I'm not sure.

Here is an example from the official docs:
image

@gtjoseph
Copy link
Member

gtjoseph commented Apr 16, 2024

That's weird. I guess I'm going to have to scan the rendered HTML for !!! to see if there are any more.

Ah. I think it's because there are other things like code blocks in the admonition and the conversion process didn't handle them. We'll get them fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants