Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support a new AsciiDoc admonition block: TIP #65

Closed
jwflory opened this issue Mar 10, 2022 · 2 comments
Closed

Support a new AsciiDoc admonition block: TIP #65

jwflory opened this issue Mar 10, 2022 · 2 comments
Labels
I: good first issue Good for newcomers T: new change Adds new capabilities or functionality X: wontfix This will not be worked on

Comments

@jwflory
Copy link
Member

jwflory commented Mar 10, 2022

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:

Screenshot of an AsciiDoc admonition when used in the Inventory theme

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 HTML id and class 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.

Screenshot of an example TIP admonition from another site.

Outcome

TIP admonitions are supported with a unique appearance in the rendered site when used in content files.

@jwflory jwflory added I: good first issue Good for newcomers I: help wanted Extra attention is needed T: new change Adds new capabilities or functionality labels Mar 10, 2022
@BeeBombshell
Copy link
Contributor

Hi @jwflory, I'd like to work on this issue. I wish to propose similar changes as mentioned in PR #75. 😄

@jwflory
Copy link
Member Author

jwflory commented Mar 30, 2022

Per the note in #63 and the change in scope, I am closing this issue as wontfix and we can instead add new admonitions for #64 and #66.

@jwflory jwflory added X: wontfix This will not be worked on and removed I: help wanted Extra attention is needed labels Mar 30, 2022
@jwflory jwflory closed this as completed Mar 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: good first issue Good for newcomers T: new change Adds new capabilities or functionality X: wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants