Skip to content

Conversation

AboveHero
Copy link
Contributor

This PR enables the use of admonitions, which offer a modern and contrasted way to highlight information.

Examples:

1.

Screenshot from 2025-04-25 14-57-40

2.

Screenshot from 2025-04-25 14-57-58

AboveHero and others added 2 commits April 25, 2025 14:52
This commit enables the use of admonitions, which offer a modern and contrasted way to highlight information.
@fghaas
Copy link
Contributor

fghaas commented Apr 25, 2025

We used to have admonitions, and removed them in d62071a for the reasons outlined in that commit message. You'll have to convince me that those concerns no longer apply. :)

@AboveHero
Copy link
Contributor Author

AboveHero commented Apr 25, 2025

We used to have admonitions, and removed them in d62071a for the reasons outlined in that commit message. You'll have to convince me that those concerns no longer apply. :)

I see, I was not aware. However, I will accept this challenge of yours.

Font size and color scheme could easily be addressed with our custom CSS, which (with your input) I could ship together with this change. That said, I don't think the color scheme "clashes" with our current color scheme or branding, and my personal opinion is they fit rather well. These are fairly common colors (although perhaps slightly special gradients) used for admonitions across platforms globally, and I don't think we need to be particularly unique in this regard.

I am not entirely sure if I understand the claim relating to conflict for preformatted text, however, admonition syntax (!!!) is already clearly distict from code blocks (```) and blockquotes (> ). Other mkdocs parsers handle admonition syntax correctly (to my knowledge) and differentiates it from code blocks.

To provide an example of from one of my screenshotted examples above, here's how they were written:

!!! note "General Note"
    This is a simple note admonition showcasing general information.

.. and I can not see which conflict you would be referring to. Furthermore, the admonition codeblock example looks like following:

!!! example "Usage Example"
    ```python
    def hello_world():
        print("Hello, world!")
    ```
    Here is an example of a simple Python function.

So yes, indeed it does necessitate indentations, but I don't see how this would interfere with other formatting as long as properly grouped.

As for Pandoc, my knowledge here is very limited, but I do feel the need to question what it is we are actually using it for when content is rendered as HTML. If you can help me understand why this is important, and how it is used, I will be better able to address this concern.

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

Successfully merging this pull request may close these issues.

2 participants