Skip to content

Question/Ideas: Admonition standards #5

@ejm554

Description

@ejm554

I like that markdown-docs has a feature that formats admonitions. However, I noticed that they are not recognized by some Markdown viewers, e.g., GitHub.

What standard does markdown-docs use, and is there is a reason behind this decision? I'm guessing it is related to MyST.

Feature Ideas:

  • Read all common admonition styles when in Rich Text mode, not just one.
  • Allow the user to specify the preferred standard when creating admonitions.

Interesting resource:
Markdown Admonitions and Callouts: Complete Guide for Enhanced Documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions