Shoutout - add unknown shoutout keyword to the class of the container

[DelPoint]

There is the possibility to define shoutouts, using this markdown:

::: info
This is an info.
:::

There are also specific keywords recodnized by the CSS, so, e.g. "info" rendered in blue, "error" in red, etc.
How about this? If an unknown keyword used, then you add this keyword as a class to the shoutout aside container?
Example:

::: comment
This is a comment.
:::

Rendered HTML output - note the word 'comment' in the class of 'aside':

<aside data-line="34" class="markdown-shoutout markdown-shoutout--info comment">
    <p class="markdown-shoutout__title">Info</p>
    <div class="markdown-shoutout__content">
      <p data-line="36">This one is a comment. Word 'comment' added to the class of 'aside'.</p>
    </div>
</aside>

The idea here: there is also possible to include a custom.css file. In other words: if somebody want a custom shoutout, then he can use any buzzword for it, this word will be in the class attribute of the container, so in that custom CSS file he can define whatever design he/she wants to display by overriding the CSS rule of the basic shoutout.

[perber]

What do you think about this?

Getting rid of the title entirely and using the keyword only for colors?

error -> red
info -> blue
warning -> orange

We could still inject custom classes, which would make the system more flexible.
However, the text "info" or "error" would no longer be part of the shoutout itself.
The user would have to add the title manually.

[DelPoint]

If any time a sw. developer asked me what about "option 2" instead of "option 1" when we've reached the point of a road fork, my answer is always: keep both "option 1" AND "option 2" if possible, because this is the most flexible solution for the majority of users.

What I mean by this? For example, I found "error", "warning" and "info" words useful as title. Imagine an "in-house" standard for documentations where the docs contain exactly these kind of shoutouts. Do I really need to remember the color of them? No. The colouring will be decided by the CSS automaticaly, while it will also provide a consistent look-and-feel across multiple documents.

So, yes:

• +1 vote for pre-defined colour names in the title
• +1 vote for custom titles (freely choosen word, which can be customized by custom.css if the user wants it)
• +1 vote for optional/manual titles as this will provide users total freedom

One side-note for pre-defined colour names in the title though: don't add the word "blue" as title text to the shoutout! What would be the point to do so? Even without the title "BLUE" it is obvious that this is a blue shoutout, isn't? (Except if somebody defines orange colour for "blue" shoutouts, but this is an other story, and "prankers" are always there to do these kind of jokes anyway.)

[Hugo-Galley]

Hey there,

I mostly agree with @DelPoint — both approaches are valid.

As mentioned, the default titles already provide something consistent and uniform, and for users who don’t want to overthink it (or aren’t sure how to customize things), they can simply stick with the default values.

That said, the idea of being able to create fully custom ones with your own titles is really nice.

So I’d vote for giving users the choice and supporting both options. That way, everyone gets what they need without degrading the overall experience for anyone.

[DelPoint]

Ok, let we give @perber a chance to show us what he has on his plate! We'll see what comes out of that... then we can complain about it later on anyway :-)

[perber]

Here the issue related to our discussion: #915

[perber]

The shoutout updates are implemented in the version v0.9.0. I will close the discussion.