ndg-commonmark docs aren't rendered on the site

[toonn]

Issue

I was looking for documentation on admonitions, to find out which ones are supported and how to nest them.

The former is documented in ndg-commonmark/docs/SYNTAX.md but I couldn't find it on the site.

More of a question I didn't want to open a separate issue for

The latter seems to be only supported by accident? I've achieved nested admonitions by mixing admonition syntax from ndg-commonmark and GFM Alerts:

:::{.example}
This is an example.

> [!NOTE]
> With a nested note!
:::

With a little additional CSS to give nested admonitions and code blocks a small left and right margin, it looks pretty nice.

GFM treats the admonition type case-insensitively, NDG (2.10.1) currently requires all caps.

GFM doesn't allow for nested admonitions even though the syntax would allow for it elegantly : (

Will this nesting always be supported or should I rather fall back to plain HTML, manually specifying a div with the appropriate classes (including the title paragraph)?

[NotAShelf]

I was hoping to stop using cargo doc for API documentation and design something with ndg for Rust documentation too. Since that's taking me too long, I've included the ndg-commonmark documentation for now.

On your question, I've documented the supported behaviour in the documentation. You cannot nest GFM alerts in GFM alerts, but you can nest GFM alerts inside admonitions. I don't have any plans to break nesting behaviour, unless comrak itself decides to break it.