documentation icon indicating copy to clipboard operation
documentation copied to clipboard

The documentation contains a lot of broken admonitions

Open Ansis100 opened this issue 1 year ago • 1 comments

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

Ansis100 avatar Apr 15 '24 12:04 Ansis100

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.

gtjoseph avatar Apr 16 '24 12:04 gtjoseph