Skip to content
A Hugo theme component to display nice notices
HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
i18n Portuguese translation Jul 8, 2019
layouts/shortcodes Make it work with newer Font Awesome release too May 14, 2019
.gitignore Create .gitignore Mar 2, 2019
LICENSE Add new Hugo component Mar 2, 2019
README.md Typo fixed Jul 11, 2019
screenshot.png
theme.yaml Add new Hugo component Mar 2, 2019

README.md

hugo-notice

Awesome

About

This is not a standalone theme. It is a Hugo theme component providing a shortcode: notice to display nice notices. Four notice types are provided: warning, info, note and tip.

This components comes with english, french, german and portuguese localizations for the notice headings. Other languages welcome! Send your pull request.

Screenshot

Usage

  1. Add the hugo-notice as a submodule to be able to get upstream changes later git submodule add https://github.com/martignoni/hugo-notice.git themes/hugo-notice
  2. Add hugo-notice as the left-most element of the theme list variable in your site's or theme's configuration file config.yaml or config.toml. Example, with config.yaml:
    theme: ["hugo-notice", "my-theme"]
    or, with config.toml,
    theme = ["hugo-notice", "my-theme"]
  3. In your site, use the shortcode, this way:
    {{< notice warning >}}
    This is a warning notice. Be warned!
    {{< /notice >}}
    or
    {{< 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.

You can’t perform that action at this time.