Support a new AsciiDoc admonition block: TIP #65
Labels
I: good first issue
Good for newcomers
T: new change
Adds new capabilities or functionality
X: wontfix
This will not be worked on
Summary
When an AsciiDoc
TIP
admonition is used, it should be more distinguished from the rest of the content on a page.Background
Is the new feature related to a problem? Describe the problem: AsciiDoc supports several kinds of admonitions, but when they are used, they are not visually distinguished:
What does the new feature look like to you?: Each admonition should use a unique icon and color to visually represent the admonition. It should be visually distinguished from the rest of the content on a page.
Details
There are many AsciiDoc admonitions, and a
TIP
is just one type. For icons, we should take an approach like using a common set of open source icons that can be used for all admonitions. This way, they will also be more similarly matched to each other. Additionally, when each admonition is used, AsciiDoc+Hugo will automatically create HTMLid
andclass
attributes so they can be styled further with layouts and CSS. To see these attributes, you will need to edit a content page, add the admonition, run the Hugo server, and use the browser tools to inspect the element on the rendered page to see what the HTML attributes are.For the
TIP
admonition, this could be a green color with an idea-like icon. It shouldn't be too distracting from the rest of the page—it is just a casual tip.Outcome
TIP
admonitions are supported with a unique appearance in the rendered site when used in content files.The text was updated successfully, but these errors were encountered: