hugo-notice
About
A Hugo theme component providing a shortcode: notice
to display nice notices. Four notice types are provided: warning
, info
, note
and tip
.
This component comes with 9 localizations: English, French, German, Italian, Portuguese, Chinese, Russian, Turkish and Arabic. Other languages welcome! Send your pull request.
Usage
- Add the
hugo-notice
as a submodule to be able to get upstream changes latergit submodule add https://github.com/martignoni/hugo-notice.git themes/hugo-notice
- Add
hugo-notice
as the left-most element of thetheme
list variable in your site's or theme's configuration fileconfig.yaml
orconfig.toml
. Example, withconfig.yaml
:or, withtheme: ["hugo-notice", "my-theme"]
config.toml
,theme = ["hugo-notice", "my-theme"]
- In your site, use the shortcode, this way:
or
{{< notice warning >}} This is a warning notice. Be warned! {{< /notice >}}
{{< notice tip >}} This is a very good tip. {{< /notice >}}
Credits
Copyright © 2019 onwards, Nicolas Martignoni nicolas@martignoni.net.
Thanks to
- Geraldo Ribeiro for the Portuguese localization.
- thatrocketx for the Italian localization.
- 理头张 for the Chinese localization.
- Алексей Корнеев for the Russian localization.
- Ahmad Al Maaz for the Turkish and Arabic localizations.