scalameta / mdoc

Typechecked markdown documentation for Scala
https://scalameta.org/mdoc/
Apache License 2.0
394 stars 80 forks source link

Mdoc's Modifiers Don't Work on Indented Code Blocks #837

Open khajavi opened 7 months ago

khajavi commented 7 months ago

Description:

When utilizing Mdoc's modifiers in documentation, it has been observed that these modifiers fail to apply correctly to indented code blocks. This issue significantly impacts the ability to convey precise information and formatting in documentation where code snippets are indented for clarity.

image

Expected Behavior:

The above code blocks are expected to be type-safe compiled using mdoc.

Current Behavior:

Mdoc is unable to identify the code blocks mentioned above.

### Tasks
tgodzik commented 6 months ago

Thanks for reporting! I can confirm this doesn't work currently. Would be great to support it, if anyone is willing to work on it I can try to help out, but the codebase is not large, so this shouldn't be too difficult