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

https://github.com/sinetris/sine-die

Semantic HTML theme for Hugo
https://github.com/sinetris/sine-die

dark-mode dark-theme hugo hugo-theme semantic

Last synced: about 1 month ago
JSON representation

Semantic HTML theme for Hugo

Awesome Lists containing this project

README

          

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sinetris/sine-die/main.svg)](https://results.pre-commit.ci/latest/github/sinetris/sine-die/main)


Sine Die logo


Responsive Web Design Demo

---

Table of Content

- [Description](#description)
- [Prerequisites](#prerequisites)
- [Documentation](#documentation)
- [Credits and Acknowledgements](#credits-and-acknowledgements)
- [License](#license)

## Description

A simple and clean [Hugo][hugo] theme.

- Semantic HTML
- Minimalist CSS framework
- Lightweight
- Responsive Web Design
- Light/Dark Mode
- Easily customizable color palette
- Menubar
- Glossary templates
- Accessibility friendly
- Search functionality

## Prerequisites

- A [Hugo site][hugo-quick-start]
- [Git installed][git-getting-started]
- (optional) For the [Search functionality][sine-die-search-functionality]
- [Node.js][node-js] or [Python 3][python] (used by Pagefind)
- [Pagefind][pagefind]
- [Dart Sass][hugo-dart-sass]

## Documentation

Basic configuration instructions are available in the [documentation README][sine-die-documentation]
file.

More details are available on the [Sine Die website][sine-die-website].

## Credits and Acknowledgements

- [Pagefind][pagefind]: highly configurable client-side search
library with a script to index pages generated with any static site generator
using as low bandwidth as possible. It also provides a UI component that
supports searching, filtering, and metadata out of the box.
- [MDN Accessibility][mdn-accessibility]: web accessibility reference in
[MDN Web Docs][mdn-web-docs]
- [ARIA Authoring Practices Guide (APG)][aria-apg]: learn to use the accessibility
semantics defined by the [ARIA][aria] specification.
- [Material Design][material-design]: Google’s open-source design system.
- The color scheme for this theme is inspired by the [Material design color system][material-design-color-system].\
Their color palette is very similar to what I intended to cerate, and having
a good reference was definitely a great help.
- This theme also use [Material Symbols][material-symbols] for the icons.

## License

Licensed under the [MIT license][sine-die-license].

This software includes material copied from or derived from the example patterns
provided in the [ARIA Authoring Practices Guide (APG)][aria-apg] and distributed
under the [W3C® Software and Document License][w3c-software-license].

Specifically:

- [Breadcrumb Pattern][aria-apg-patterns-breadcrumb]
- [Menu and Menubar Pattern][aria-apg-patterns-menubar]

[aria-apg-patterns-breadcrumb]: "APG - Breadcrumb Pattern"
[aria-apg-patterns-menubar]: "APG - Menu and Menubar Pattern"
[aria-apg]: "ARIA Authoring Practices Guide (APG)"
[aria]: "Accessible Rich Internet Applications (WAI-ARIA)"
[git-getting-started]: "Git: Getting Started"
[hugo-dart-sass]: "Hugo: Install Dart Sass"
[hugo-quick-start]: "Hugo: Quick start"
[hugo]: "Hugo: open-source static site generators"
[material-design-color-system]: "Material design color system"
[material-design]: "Material Design"
[material-symbols]: "Material Symbols"
[mdn-accessibility]: "mdn - Accessibility"
[mdn-web-docs]: "mdn web docs"
[node-js]: "Node.js"
[pagefind]: "Pagefind"
[python]: "Python"
[sine-die-documentation]: "sine-die: Documentation"
[sine-die-license]: "sine-die: License"
[sine-die-search-functionality]: "sine-die: Search functionality"
[sine-die-website]: "sine-die: website"
[w3c-software-license]: "W3C Software and Document License"