Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 5.05 KB

README.md

File metadata and controls

91 lines (59 loc) · 5.05 KB
Raw

UNICEF Inventory theme

UNICEF Inventory theme, for use with Hugo static site generator. A simple knowledge-base to share information with others.

🌟 Features

The UNICEF Inventory theme is designed to be a knowledge-base for thematic, indexed information. It was designed to meet a need for knowledge-transfer within the UNICEF Office of Innovation. The theme includes the following features:

General features

Created with Bootstrap v4.

  • Search bar with suggestions to perform simple searches across all content
  • Brand and identity customization (colors, fonts, logos managed in config file)
  • Frequently Asked Questions (F.A.Q.) shortcode for a spoiler dropdown in any content
  • Admonitions to call out specific information and details in an article
  • Author bylines to identify the author of an article and optionally their contact information
  • Responsive design for a mobile-friendly navigation and user experience
  • Multilingual support (U.S. English, Spanish/español included; others possible)
  • Google Analytics support
  • Contact form (e.g. Formspree)
  • OpenGraph tag support (i.e. Twitter card metadata and other social media websites supported)
  • Previous/Next buttons in articles for sequentially-ordered content
  • Redirect post types to redirect the user to a URL hosted on an external website

UNICEF-specific features

  • Team Profiles (example): Create a special post for a UNICEF Venture Fund start-up company with an open source product description and other metadata.
  • DPG Standard indicators (example): Use two nested categories to highlight each of the nine Digital Public Goods Standard indicators, provide more information about the indicator, and show site articles that describe the indicator.

Examples

Browse other sites deployed using the UNICEF Inventory theme. If you use the theme in your Hugo site, please add your website to this README section as an example.

🔌 Installation

See the installation guide. The guide provides recommended practices for deploying the UNICEF Inventory theme to GitHub Pages.

🔩 Configuration

See exampleSite/config.yaml for the example site configuration file.

👥 Contribute to the UNICEF Inventory theme

See the UNICEF Inventory theme CONTRIBUTING.md for contribution guidelines, conventions and courtesies, and help with setting up a developer environments.

🗣️ Share your feedback

Notice a bug or have an idea on how to improve the site? Consider opening a user story or use another GitHub Issue template to report bugs and request new features.

📝 Legal

Originally forked from Dot, a Hugo theme by ThemeFisher.

Licensed under MPL-2.0. From choosealicense.com:

Permissions of this weak copyleft license are conditioned on making available source code of licensed files and modifications of those files under the same license (or in certain cases, one of the GNU licenses). Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. However, a larger work using the licensed work may be distributed under different terms and without source code for files added in the larger work.