Osprey Delight is the free-minded artist's choice for a clutter-free and blazingly fast single-page portfolio.
Osprey Delight is the free-minded artist's choice for a clutter-free and blazingly fast single-page portfolio.
It's perfectly suited to show off your awesome work!
It tastes a bit different than the great Osprey theme and adds awesome modular functionality to your delight.
Check out how Osprey Delight performs in the real-world:
In general, many open issues of the original theme have been resolved and code has been rewritten.
There are multiple ways to show your support if you like this project:
Please make sure to have Hugo's extended version and Go installed. If you're new to Hugo, visit the docs for more info and general site setup.
Initialize your repo as a module (replace <username>
and <projectname>
):
hugo mod init github.com/<username>/<projectname>
Download the documented config file, e.g. via curl:
curl https://raw.githubusercontent.com/kdevo/osprey-delight/master/exampleSite/config.yaml -O
Continue reading for configuration options.
Receive the latest features of the theme:
hugo mod get -u
It is good practice to check the release notes before upgrading.
It's best if you simply check out the fully commented config file. This theme follows a learning-by-doing approach.
This theme is asset-driven! It "knows" how to handle your precious assets, and there usually is no need for manual resizing.
For that to work, provide all of the following images in the assets
directory (do not use the static
directory).
The following table shows recommendations regarding the required assets:
Image Type | Config Key | Minimum Width | Note |
---|---|---|---|
Logo | logoBig (config.yaml) |
200px | Transparent, minimum margin top/bottom |
Navbar-Logo | logoSmall (config.yaml) |
96px | Transparent, small margin top/bottom, prefer square format |
Gallery | image (content/gallery/*) |
400px | Transparent, medium margin top/bottom/left/right, prefer square or landscape format |
Background | background (config.yaml) |
1920px | Optional, use a high-quality JPG |
To create an about section that renders on the home page, run:
hugo new about.md
To create a new gallery item, run:
hugo new gallery/my-item.md
You will get a fully documented file, which describes each config option separately.
Basin is a free AJAX contact form service that is used by this theme.
To set it up:
ajaxBasin
config.yaml parameter.Submit this form via AJAX
option on your Basin dashboard.Under "Setup" → "Set a Custom Honeypot Field", input _anti_spam_honeypot
.
Basin will ignore all messages that contain this specific field. This should work since there is a hidden field that users normally do not use, but spambots will blindly input their data.
Please do not make a tick in the "reCAPTCHA" checkbox, this service is not supported and also typically not necessary.
Want to have full control over appearance? Check out how to customize the theme more granularly.
This theme has a GitHub-powered community forum! Feel free to ask questions in the Q&A (please make sure to completely read the docs and existing discussions/questions).
This README probably needs some documentation improvements for the latest features. Any PR regarding this is welcome. Please also check out how to contribute!