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

Admonition shortcodes for note, tip and warning #130

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Sieboldianus
Copy link
Contributor

@Sieboldianus Sieboldianus commented Apr 28, 2020

I've pulled together shortcodes for note, tip and warning and used those for a while now in my blog:

image

The base code comes from the gohugoio-theme (e.g. used in the docs) from where I updated to match the Hermit Theme.

To produce the above, the following code in a markdown/content file is used:

{{% note %}}
Here is a piece of information I would like to draw your **attention** to.
{{% /note %}}

{{% warning %}}
This is a warning, which should be reserved for *important* information like breaking changes.
{{% /warning %}}

{{% tip %}}
Here's a bit of advice to improve your productivity with Hugo.
{{% /tip %}}

I've also added three svg-icons from the fontawesome, among others, explained in a blog post here.

I tried to include it in the most flexible way: fontawesome icons are only included as svg, and only those three (not the full library). There're 3 new colors added to _predefined.scss:

$admonition-note :#F8E45C;
$admonition-tip : #0594CB;
$admonition-warning :#ff725c;

Any admonition scss is stored in a separate file, admonition.scss.

Happy to discuss the colors or style, if anyone is interested in this feature. E.g.: I decided against round-corners, since I found that the theme has already so many round corners.

@Sieboldianus
Copy link
Contributor Author

Some more tests: switching colors for note and tip - I think this may look better:
image

@Sieboldianus
Copy link
Contributor Author

Sieboldianus commented Apr 29, 2020

Another option with reduced colors, perhaps with a cleaner look:

image

@Sieboldianus Sieboldianus changed the title Add admonition shortcodes for note, tip and warning Admonition shortcodes for note, tip and warning Apr 29, 2020
1bl4z3r added a commit to 1bl4z3r/hermit-V2 that referenced this pull request Oct 21, 2023
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.

1 participant