Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unicef/inventory-hugo-theme

UNICEF Inventory theme, for use with Hugo static site generator. A simple knowledgebase to share information with others.
https://github.com/unicef/inventory-hugo-theme

hacktoberfest hugo hugo-theme knowledge-base knowledge-management knowledgebase unicef unicef-innovation

Last synced: 10 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
UNICEF Inventory theme

======================



UNICEF Inventory theme, for use with [Hugo](https://gohugo.io/) static site generator.

A simple knowledge-base to share information with others.



## :star2: 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](https://www.unicef.org/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**](https://unicef.github.io/inventory-hugo-theme/features/brand-identity/) (colors, fonts, logos managed in config file)

* **Frequently Asked Questions (F.A.Q.) shortcode** for a spoiler dropdown in any content

* [**Admonitions**](https://unicef.github.io/inventory-hugo-theme/features/admonitions/) to call out specific information and details in an article

* [**Author bylines**](https://unicef.github.io/inventory-hugo-theme/features/author-byline/) 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**](https://unicef.github.io/inventory-hugo-theme/features/redirect/) to redirect the user to a URL hosted on an external website



### UNICEF-specific features



* **Team Profiles** ([_example_](https://unicef.github.io/inventory/cohorts/)):

  Create a special post for a [UNICEF Venture Fund](https://www.unicefinnovationfund.org/) start-up company with an open source product description and other metadata.

* **DPG Standard indicators** ([_example_](https://unicef.github.io/inventory/dpg-indicators/)):

  Use two nested categories to highlight each of the nine [Digital Public Goods Standard](https://digitalpublicgoods.net/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.



* [UNICEF Open Source Inventory](https://unicef.github.io/inventory/)

* [SustainOSS Design & UX knowledgebase](https://sustainers.github.io/design/)

* UNICEF Toolkits:

    * [UNICEF Data Science & A.I. Toolkit](https://unicef.github.io/ooi-toolkit-ds/)

    * [UNICEF Drones Toolkit](https://unicef.github.io/drone-4sdgtoolkit/)

    * [UNICEF Software Development Toolkit](https://unicef.github.io/ooi-toolkit-software/)



## :electric_plug: Installation



See the [installation guide](https://unicef.github.io/inventory-hugo-theme/install/new-site/).

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



## :nut_and_bolt: Configuration



See [`exampleSite/config.yaml`](https://github.com/unicef/inventory-hugo-theme/blob/main/exampleSite/config.yaml) for the example site configuration file.



## :busts_in_silhouette: Contribute to the UNICEF Inventory theme



See the UNICEF Inventory theme [`CONTRIBUTING.md`](https://github.com/unicef/inventory-hugo-theme/blob/main/.github/CONTRIBUTING.md) for contribution guidelines, conventions and courtesies, and help with setting up a developer environments.



## :speaking_head: Share your feedback



Notice a bug or have an idea on how to improve the site?

Consider [opening a user story](https://github.com/unicef/inventory-hugo-theme/issues/new?assignees=&labels=C%3A+design+thinking%2C%3F%3A+needs+triage&template=04-user-story.yml&title=As+a+%5Btype+of+user%5D%2C+I+want+%5Ban+action%5D+so+that+%5Ba+benefit%2Fa+value%5D.) or use [another GitHub Issue template](https://github.com/unicef/inventory-hugo-theme/issues/new/choose) to report bugs and request new features.



## :memo: Legal



_Originally forked from [Dot](https://github.com/themefisher/dot-hugo), a Hugo theme by [ThemeFisher](https://themefisher.com/hugo-themes)_.



Licensed under [MPL-2.0](https://www.mozilla.org/en-US/MPL/ "About the Mozilla Public License").

From [_choosealicense.com_](https://choosealicense.com/licenses/mpl-2.0/):



> 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.