Skip to content

Osprey Delight v5

Latest
Compare
Choose a tag to compare
@kdevo kdevo released this 30 Apr 19:43
· 16 commits to master since this release
50bdf7a

Launching v5 - Modular Manta

v5 of the theme goes by the nickname 'Modular Manta', since it packs many improvements that might not be that obvious on first sight by integrating Hugo Mods. I've started this project a few months ago to make website building with Hugo even more easy and modular. The goal is to have a high-quality selection of community-maintained Hugo modules for popular use-cases such as icon embedding, lazy image loading, static on-page discussions and more.

Hugo Modules

Behind the scenes: To create the modules, many parts of the theme's v4 version have been extracted and generalized, tested and then embedded into the theme again. This way everyone can profit even from a subset of the theme's functionality, with a great support for customization. 🚀

Changelog in commits: v4..v5
Changelog in plain english ⬇️

Improvements

  • Hugo Modules:
    • Switch from Fontello icon font to SVG icon system using hugo-mods/icons
    • Use hugo-mods/lazyimg for improved imaging support
    • Add hugo-mods/release-notify module to get a notification for every minor/major version
  • Visual:
    • Improve various screen size support for background image
    • Make button icons color transition compatible and ease the transition
  • Improve theming capabilities:
    • Use dedicated bundle folder for each theme, allowing to supply colors, fontface, fontsizing and custom SCSS for each theme
    • Fallback to default if respective theme-specific file is not found
    • Theme-specific _custom.scss (under sass/themes) is loaded before more generic _custom.scss (under sass)
    • Add new dedark theme which is a word-playing ancestor of the default delight theme
    • Add new origin theme which is a revival of the original Osprey theme - with the same colors, text alignment and fonts
  • Improve termynal integration and usage, extract to shortcode
  • Docs:
    • Explain additional customization possibilities such as custom section, theming and advanced module configuration
    • Extend exampleSite to reflect all new configuration options and features
    • Improve image sizing recommendations
    • Add and explain new config options in example config.yaml
    • Improve consistency
  • Add Oxanium and Rubik fonts locally in static folder

Bugs fixed

  • Visual:
    • Remove distortion when image exceeds container width
    • Make images in regular content files responsive by changing default height to auto
    • When using the GitHub project gallery entry feature: Emojify GitHub project descriptions
  • Remove obsolete visit GitHub link shortcode
  • Fix nil pointer when no social icons are configured
  • Remove old formspree URL from contact form
  • Cleanup, remove unused files and fix some typos
  • Repair custom section rendering

Breaking changes

  • The theme should now be installed as a Hugo module, please follow the Quickstart instructions
  • New icon mechanism potentially requires user intervention, see here
  • Images that are referenced by the theme must be moved from static to assets for the lazyimg module to resolve them correctly
  • Theming and color maps have been changed

See migration steps for more information.

Special thanks

This release has been sponsored by @gutzbenj who runs earthobservations with his friends, a GitHub organization dedicated to ease access to open weather data. Thanks! ❤️

Become a sponsor too - and support my open source projects!