diff options
author | kdevo <kdevo@users.noreply.github.com> | 2022-04-30 20:13:29 +0300 |
---|---|---|
committer | kdevo <kdevo@users.noreply.github.com> | 2022-04-30 20:28:34 +0300 |
commit | b638f28ea93beb1be9aa3408f026c47acbecc3a2 (patch) | |
tree | bf28478523f593b4f19d885ece2b918fbd6f4f3e | |
parent | dbc2c439d93c5254a4203f7ac831254954b94e56 (diff) |
docs: enhance, describe new customization options
- CUSTOMIZING.md:
- add section
- configure modules
- create theme
- README.md:
- add shields
- clarify features
- clarify ways to support the theme
- new quickstart by just using hugo mod commands
- improve image recommendations
- clarify basin setup
- change headings for more learning resources
- update screenshot and thumbnail
- enhance config.yaml and add new config options
- cleanup unused images
Closes #30.
-rw-r--r-- | CUSTOMIZING.md | 79 | ||||
-rw-r--r-- | README.md | 115 | ||||
-rw-r--r-- | archetypes/gallery.md | 27 | ||||
-rw-r--r-- | exampleSite/config.yaml | 70 | ||||
-rw-r--r-- | exampleSite/data/icons.yaml | 2 | ||||
-rw-r--r-- | images/github-status.png | bin | 4828 -> 0 bytes | |||
-rw-r--r-- | images/screenshot-modal.png | bin | 101030 -> 0 bytes | |||
-rw-r--r-- | images/screenshot-work.png | bin | 68723 -> 0 bytes | |||
-rw-r--r-- | images/screenshot.png | bin | 54089 -> 2698411 bytes | |||
-rw-r--r-- | images/tn.png | bin | 35880 -> 1080544 bytes | |||
-rw-r--r-- | theme.toml | 2 |
11 files changed, 203 insertions, 92 deletions
diff --git a/CUSTOMIZING.md b/CUSTOMIZING.md index 8e97abe..e33e7d9 100644 --- a/CUSTOMIZING.md +++ b/CUSTOMIZING.md @@ -1,10 +1,10 @@ # Customizing -Osprey Delight makes heavy use of various Hugo features, e.g. directly benefits from Hugo's virtual file system and [directory structure](https://gohugo.io/getting-started/directory-structure/), [partials](https://gohugo.io/templates/partials/), as well as using the awesome [Hugo Pipes](https://gohugo.io/hugo-pipes/) whenever it makes sense. +Osprey Delight makes heavy use of various Hugo features, e.g. [modules](https://gohugo.io/hugo-modules/). It directly benefits from Hugo's virtual file system and [directory structure](https://gohugo.io/getting-started/directory-structure/), [partials](https://gohugo.io/templates/partials/), as well as using the awesome [Hugo Pipes](https://gohugo.io/hugo-pipes/) whenever it makes sense. -This also means that you normally do not need to maintain a separate fork. If you have built something nice, don't be afraid to share the customization via [PR](https://github.com/kdevo/osprey-delight/pulls), so that others can profit from it, too. :rocket: +This also means that you normally do not need to maintain a separate fork due to the wide availability of customization options. -## Custom SCSS +## Custom SCSS <a href="custom-scss"></a> Place a file named `_custom.scss` in your `assets/sass/` folder (create the directories if needed). This will override the theme's `_custom.scss` which is loaded in the internal main SCSS. @@ -12,12 +12,26 @@ Place a file named `_custom.scss` in your `assets/sass/` folder (create the dire ### Theming -Coming soon. -Take a look at [the themes directory](themes/osprey-delight/assets/sass/themes) for a sneak peek! +Get creative and build your own theme for Osprey Delight! +A theme ([example dark theme](./themes/osprey-delight/assets/themes/dedark)) consists of three optional files: + +File | Purpose | Recommendation +--------------------|------------------------------------------------------------------- |------------------------ +`_colors.scss` | Colors | Use a color scheme generator site (e.g. "coolors") to get some ideas, align with your logo's colors. +`_fontface.scss` | Font settings | Use [Google fonts](https://fonts.google.com/) for a font that fits. Tools such as [webfont helper](https://google-webfonts-helper.herokuapp.com/fonts) help you with independently self-hosting the font. +`_custom.scss` | Any other custom adaptions | Just like the [custom SCSS described before](#custom-scss), but theme-local instead globally scoped. + +Set the theme in your config.yaml, e.g.: + +```yaml +Params: + # ... + theme: "dedark" +``` ### Syntax Highlighting (for Blog) -Limiting external dependencies is important when it comes performance, therefore only Hugo's internal [Chroma Syntax Highlighting](https://gohugo.io/content-management/syntax-highlighting/) is supported. Here's how to use it: +Limiting external dependencies is important when it comes performance, therefore only Hugo's internal [Chroma Syntax Highlighting](https://gohugo.io/content-management/syntax-highlighting/) is supported out of the box. Here's how to use it: 1. Generate a Chromastyle of your choice (in this case `solarized-dark`) as `_custom.scss` in project root: `hugo gen chromastyles --style=solarized-dark > _custom.scss` 2. Move the file to `assets/sass/` folder @@ -25,12 +39,55 @@ Limiting external dependencies is important when it comes performance, therefore > Refer to [the official Hugo documentation](https://gohugo.io/content-management/syntax-highlighting/) for more info. -## Custom templates +## Templates + +In this section, you can learn how to adjust templates or theme structure to your needs. + +### Add your own sections + +Adjust the config.yaml file by adding another entry to `menu`, for instance one for music: + +```yaml +Menu: + Main: + # ... + - name: "Music" + identifier: "music" + url: "/#music" + weight: 2 +``` + +This will create a section with name "Music" in the nav bar and renders the content of `content/music.md` given by the identifier. + +If you need further styling of this section you can place a `music.html` partial in `layouts/partials/sections` (e.g. by using the `default.html` in the same folder as starting point). + +The weight determines the position on the page as well as in the nav bar. + +### Advanced: Extend the head + +In case you want to load custom HTML for additional scripts etc. inside the page's `head`: +Place a file named `head-extended.html` in your `layouts/partials/` folder (create the directories if needed). + +This file can e.g. contain additional `<script>` or `<link>` tags. + +## Module settings + +Osprey Delight makes heavy use of [Hugo Mods](https://github.com/hugo-mods) to enrich its functionality. +In this section, you can learn how to customize the modules. + +### [icons](https://github.com/hugo-mods/icons) + +To add an icon to the footer (say SoundCloud, [as in this discussion](https://github.com/kdevo/osprey-delight/discussions/19)): + +1. Create the file `data/icons.yml` in your project root (see also the [theme-internal `icons.yml`](./layouts/themes/osrprey-delight/data/icons.yml)) +2. Add the line `soundcloud: fab soundcloud` to it +3. Check out all options for [the pattern](https://github.com/hugo-mods/icons#data-pattern) used by this theme -### Extent the head +### [lazyimg](https://github.com/hugo-mods/lazyimg) -In case you want to load custom HTML for additional scripts etc. inside the page's `head`: Place a file named `head-extended.html` in your `layouts/partials/` folder (create the directories if needed). This file can e.g. contain additional `<script>` or `<link>` tags. +Customization options for experts are described in the [README](https://github.com/hugo-mods/lazyimg/README.md). -### Build your own sections +### [release-notify](https://github.com/hugo-mods/release-notify) -Coming soon.
\ No newline at end of file +For notifying about new bug/minor/major versions. Configurable in `data/release_notify.yaml`. +Can be disabled entirely by changing `notifyOnNewThemeVersion` to `false` in your `config.yaml`.
\ No newline at end of file @@ -7,8 +7,9 @@ --- [![GitHub Release](https://img.shields.io/github/v/release/kdevo/osprey-delight?style=flat-square&color=%230097a7&logo=github)](https://github.com/kdevo/osprey-delight/releases/latest) -[![Hugo Minimum Version](https://img.shields.io/badge/hugo-%3E=v0.80-%230097a7?logo=hugo&style=flat-square)](https://github.com/gohugoio/hugo/releases) -[![Project Status](https://img.shields.io/website?label=kdevo&style=flat-square&up_color=%230097a7&url=https%3A%2F%2Fkdevo.github.io)](#keep-it-up) +[![Discussions](https://img.shields.io/badge/GitHub-Discussions-%230097a7?logo=github&style=flat-square)](https://github.com/kdevo/osprey-delight/discussions) +[![Hugo Minimum Version](https://img.shields.io/badge/hugo-%3E=v0.83-%230097a7?logo=hugo&style=flat-square)](https://github.com/gohugoio/hugo/releases) +[![Built with hugo-mods](https://img.shields.io/static/v1?label=%E2%9D%A4&message=hugo-mods&color=0097a7&style=flat-square)](https://github.com/hugo-mods) ## Overview @@ -16,89 +17,95 @@ Osprey Delight is the free-minded artist's choice for a clutter-free and blazing It's perfectly suited to show off your awesome work! -> It tastes a bit different than [the original great Osprey theme](https://github.com/tomanistor/osprey) and adds awesome new functionality to your **delight**. +> It tastes a bit different than [the great Osprey theme](https://github.com/tomanistor/osprey) and adds awesome modular functionality to your **delight**. -### Showcase +### Showcase Check out how Osprey Delight performs in the real-world: -- [Protonaut Music](https://protonautmusic.com/) - Musician and top contributor whose highly individualized site got kickstarted by Osprey Delight. -- [KDEVO](https://kdevo.github.io/) - The maintainer's site. It wouldn't be me if I would not run this theme personally. It's basically in the vanilla version. +- [Hugo Mods](https://hugo-mods.github.io/) - This theme is built around the Hugo Mods presented on the site. This site also has the [complete source code available](https://github.com/hugo-mods/hugo-mods.github.io). +- [Protonaut Music](https://protonautmusic.com/) - Musician and top contributor whose highly recognizable site got kickstarted by the theme. +- [KDEVO](https://kdevo.github.io/) - It wouldn't be me if I would not run this theme personally to ensure that everything runs smoothly. ### Features -- Single page made out of extensible section building blocks +- Modular and made out of extensible section building blocks: - About: Introduce yourself - Gallery: Show your work using a grid-based gallery with interactive modal boxes - Blog: Lightweight blog features - Contact: Contact form with Basin support and built-in spambot protection -- Images are [asset-driven](https://gohugo.io/categories/asset-management). Use your high-quality images without the hassle of manually resizing them! - - Image lazy-loading via [lazySizes](https://github.com/aFarkas/lazysizes) +- Use your high-quality images [assets](https://gohugo.io/categories/asset-management): + - Lazy image loading plus completely automatic resizing using [lazyimg](https://github.com/hugo-mods/lazyimg) module - Blur-up technique using automatic low-quality image placeholders (LQIP) -- SEO-optimized - - [Score 100 at PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fkdevo.github.io%2F). Every bit is fine-tuned for performance + - Modern WebP support with fallback for older browsers +- SEO: + - [Score 100 at PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fkdevo.github.io%2F). Every bit is fine-tuned with performance in mind! - Auto-generated structured ensures that everyone finds you -- Delightful UX +- Delightful UX: + - Choose between different themes + - Awesome social icons in footer via [icons module](https://github.com/hugo-mods/icons) - Smooth scrolling plus scroll-spy - - Awesome social icons in footer - - Automatically fetches GitHub repo data for you + - Automatically fetches GitHub repo data - Sane fallbacks for No-Script/No-JS users - - Intelli-404: Automatically searches for suitable matches - never loose the link to your content - Heavily [customizable](#customize-it) - no need to maintain a fork! -In general, many [open issues](https://github.com/tomanistor/osprey/issues) of the original theme have been resolved. +In general, many [open issues](https://github.com/tomanistor/osprey/issues) of the original theme have been resolved and code has been rewritten. -### Contribute +### Contribute and show your support There are multiple ways to show your support if you like this project: + +- ❤️ [Become a sponsor](https://github.com/sponsors/kdevo) +- ⭐ Give the project a star to ensure everyone finds it - Start [contributing](https://github.com/kdevo/osprey-delight/blob/master/CONTRIBUTING.md) -- Become a sponsor or [donate anything to my non-profit organization](https://pyotek.dev/donate) via various options -- Push the [![GitHub stars](https://img.shields.io/github/stars/kdevo/osprey-delight?style=social)](https://github.com/kdevo/osprey-delight/stargazers) button - a small gesture with huge effect ## Quickstart +> Please make sure to have [Hugo's extended version](https://github.com/gohugoio/hugo/releases) and [Go](https://go.dev/) installed. +> If you're new to Hugo, [visit the docs](https://gohugo.io/getting-started/quick-start/) for more info and general site setup. -The recommended way to setup this theme is to use a git submodule so that further upgrades can be received without any hassle. -Invoke the following from your Hugo site directory: +Initialize your repo as a module (replace `<username>` and `<projectname>`): -```shell -git submodule add https://github.com/kdevo/osprey-delight.git themes/osprey-delight +```sh +hugo mod init github.com/<username>/<projectname> ``` -Now, simply copy the [exampleSite](/exampleSite) directory's *content* to your project's root, it's a great starting point. +Download the [documented config file](https://github.com/kdevo/osprey-delight/blob/master/exampleSite/config.yaml), e.g. via curl: + +```sh +curl https://raw.githubusercontent.com/kdevo/osprey-delight/master/exampleSite/config.yaml -O +``` -> [Visit the Hugo docs](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) for more info and general setup of a Hugo site. +Continue reading for [configuration options](#config). ### Upgrade -Receive the latest features of the theme by pulling the latest changes from `master`: +Receive the latest features of the theme: ``` -cd themes/osprey-delight -git pull +hugo mod get -u ``` > It is good practice to [check the release notes](https://github.com/kdevo/osprey-delight/releases) before upgrading (especially before using new major versions). +## Configuration and Usage <a href="config"></a> -## Configuration and Usage - -It's best if you simply check out the fully commented [config file](/exampleSite/config.yaml). +It's best if you simply check out the fully commented [config file](https://github.com/kdevo/osprey-delight/blob/master/exampleSite/config.yaml). This theme follows a learning-by-doing approach. ### Images This theme is asset-driven! It "knows" how to handle your precious assets, and there usually is no need for manual resizing. -Therefore, the recommended approach for images is to provide high-res images in the [`assets` directory](https://gohugo.io/hugo-pipes/introduction/#asset-directory). +For that to work, provide all of the following images in the [`assets` directory](https://gohugo.io/hugo-pipes/introduction/#asset-directory) (do not use the `static` directory). -The following table shows some guidelines regarding the assets: +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 format -Background | `background` (config.yaml) | 1200px | Optional, use a high-quality JPG +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 ### Content files @@ -107,7 +114,7 @@ Background | `background` (config.yaml) | 1200px To create an about section that renders on the home page, run: ```console -$ hugo new about.md +hugo new about.md ``` #### Gallery item @@ -115,33 +122,43 @@ $ hugo new about.md To create a new gallery item, run: ```console -$ hugo new gallery/item-name.md +hugo new gallery/my-item.md ``` -This is very helpful for the first time since you will get a fully documented file. - -> ⚠️ Please make sure that `item-name` is unique on the whole page because it will be used as an anchor/identifier! +You will get a fully documented file, which describes each config option separately. ### Contact form -Basin is a free AJAX contact form service that is used by this theme. To use set it up, [sign up for a free account](https://usebasin.com/users/sign_up) and create a form. Copy and paste your form's URL endpoint to the `ajaxBasin` config.yaml parameter. Select the `Submit this form via AJAX` option on your Basin dashboard. +Basin is a free AJAX contact form service that is used by this theme. + +To set it up: +1. [Sign up for a free account](https://usebasin.com/users/sign_up) and create a form. +2. Copy and paste your form's URL endpoint to the `ajaxBasin` config.yaml parameter. +3. Select the `Submit this form via AJAX` option on your Basin dashboard. ![Basin AJAX setup](https://raw.githubusercontent.com/kdevo/osprey-delight/master/images/basin-ajax-setup.png) -#### Spambot protection +#### Enable spambot protection -Under Setup/"Set a Custom Honeypot Field", enter `_anti_spam_honeypot`. +Under "Setup" → "Set a Custom Honeypot Field", input `_anti_spam_honeypot`. Basin will [ignore all messages that contain this specific field](https://usebasin.com/docs/features/spam-filtering). This should work since there is a hidden field that users normally do not use, but spambots will blindly input their data. ![Basin Anti Spambot](https://raw.githubusercontent.com/kdevo/osprey-delight/master/images/basin-custom-honeypot.png) -## Next +[Please do not make a tick in the "reCAPTCHA" checkbox](https://github.com/kdevo/osprey-delight/discussions/22), this service is not supported and also typically not necessary. -### Help wanted +## Learn more -This README probably needs some documentation improvements for the latest features. -Any PR regarding this is welcome and please also check out [how to contribute](CONTRIBUTING.md)! +### Customize it <a href="customize-it"></a> + +Want to have full control over appearance? Check out [how to customize the theme more granularly](https://github.com/kdevo/osprey-delight/blob/master/CUSTOMIZING.md). + +### Need help? -### Customize it +This theme has a GitHub-powered [community forum](https://github.com/kdevo/osprey-delight/discussions)! +Feel free to ask questions in the [Q&A](https://github.com/kdevo/osprey-delight/discussions/categories/q-a) (please make sure to completely read the docs and existing discussions/questions). -Want to have full control over appearance? Check out [how to customize the theme more granularly](https://github.com/kdevo/osprey-delight/blob/master/CUSTOMIZING.md).
\ No newline at end of file +### Help wanted + +This README probably needs some documentation improvements for the latest features. +Any PR regarding this is welcome. Please also check out [how to contribute](https://github.com/kdevo/osprey-delight/blob/master/CONTRIBUTING.md)! diff --git a/archetypes/gallery.md b/archetypes/gallery.md index 62a02db..c735b5e 100644 --- a/archetypes/gallery.md +++ b/archetypes/gallery.md @@ -10,35 +10,34 @@ title: "{{ replace .TranslationBaseName "-" " " | title }}" # You can use 'weight' to order (primarily) for more control (sometimes it makes sense to put old items before new ones). # The specifics are documented here: https://gohugo.io/templates/lists/#order-content date: "{{ .Date }}" -# [str] Gallery image file. -# If the specified image is found in the 'assets' directory the image will be normalized to a specified height. -# If ommited AND type is 'github' (see below), will attempt to fetch from '{repo_url}/.github/logo.png'. -image: "" +# [str] Gallery image file from the assets directory. +image: "images/{{ .File.BaseFileName }}.png" # [str] Alternative (image) description. -# If ommited with type 'github', will use 'description' field from GitHub API. alt: "" -# [css] Background color of the gallery item. +# [css] Optional background color of the gallery item (if omitted, will use theme's fallback). color: "#fff" -# [css] Optional gallery item hover color to set it individually. +# [css] Optional gallery item hover color (if omitted, will use theme's fallback). #hoverColor: "#fff" # [map] Configure github specific options here: # github: - # [str] Repo is a combination of "{user_or_org}/{repository_name}" - # repo: "kdevo/osprey-delight" + # [str] Repo is a combination of "<user_or_org>/<repository_name>" + # repo: "{{ default "<username>" site.Params.Feat.structuredDataGitHubUser }}/{{ default "<reponame>" (urlize .File.BaseFileName) }}" # [bool] Show repository information such project language below the buttons. # showInfo: true # showButtons: true -# [map] Configure optional terminal to be displayed when opening up the gallery item: +# [map] Optionally configure terminal to be displayed when opening up the gallery item: # Example (set "useTermynal" to true in config.yaml and comment out to test it): -terminal: +# terminal: # lines: # - type: input - # data: ls -ltra dummy/ + # data: hugo mod get -u github.com/hugo-mods/lazyimg # wait: 1250 # - type: progress # data: 100 # wait: 200 - # - data: ls: cannot access 'dummy/' directory. + # - data: ✓ Done. + # wait: 75 + # - data: exit # wait: 75 buttons: - i18n: view # i18n key (see i18n directory, see https://gohugo.io/functions/i18n/) @@ -49,5 +48,5 @@ buttons: icon: code url: "" # [bool] Draft mode will decide if file will be published to 'public/' directory. -draft: true +draft: false --- diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index 8bf6199..779b262 100644 --- a/exampleSite/config.yaml +++ b/exampleSite/config.yaml @@ -1,7 +1,7 @@ title: "Osprey Delight Demo" baseURL: "https://example.com" languageCode: "en-US" -theme: "osprey-delight" +theme: "github.com/kdevo/osprey-delight" tags: ["personal", "homepage", "portfolio"] #canonifyURLS: true #googleAnalytics: "" @@ -11,12 +11,15 @@ pygmentsUseClasses: true module: imports: - - path: github.com/kdevo/osprey-delight + - path: github.com/kdevo/osprey-delight + # useful for local development of the theme: + # replacements: + # - github.com/kdevo/osprey-delight -> ../../. ## Generic theme parameters: Params: author: "kdevo" - description: "Osprey Delight - Example Site" + description: "Osprey Delight: Example Site" # logoBig appears at the top of the page. Use a path relative to the assets dir for auto-resizing. logoBig: "osprey-delight.png" @@ -24,15 +27,27 @@ Params: # logoSmall is the logo that will be shown in the left corner of the nav bar. # Use a path relative to the assets dir for auto-resizing. logoSmall: "favicon.png" + + # background can optionally be specified as an image layer behind logoBig at the top of the page (parallax effect). + #background: "background.jpg" + + # opengraphImage specifies the image that is shown when previewing the site in a messenger or Google Search. + opengraphImage: "/images/osprey-delight.png" + + # favicon of the site (e.g. smaller version of logoSmall). + favicon: "favicon.png" + + # theme your site by choosing one of the themes under assets/sass/themes: + # - delight is the light version of osprey-delight + # - dedark is the dark version of "delight" + # - origin is the legacy version (similar to https://github.com/tomanistor/osprey) + theme: "delight" # tagline (followed by a cursor) is shown at the top, below the logo #tagline: "Welcome!" # mdTagline can be used instead to specify the tagline in Markdown for more customizability. # Note that {cursor} is a placeholder and will be replaced by the actual cursor HTML when rendering. mdTagline: "# Welcome!\n ## This is Osprey Delight{cursor}" - favicon: "favicon.png" - - opengraphImage: "/images/osprey-delight.png" # enforceSinglePage will enforce redirection to the baseURL for all sub-directories/-pages. # Example: If you create about.md, Hugo will also create a '/about/index.html' which might not be what you want for a *single* page site. @@ -42,23 +57,27 @@ Params: # copyright flag generates a copyright notice in footer of your site. copyright: true + # credit to the theme. If you want to support the theme by please leave this in, it's kept very tiny and short. + # credit: true + ## Social links in footer: +## The type specifies the icon to use. For more information, see: +## https://github.com/kdevo/osprey-delight/blob/dev/CUSTOMIZING.md#icons Social: - type: twitter # references the icon to use url: "" - type: linkedin url: "" - type: github - url: "https://github.com/kdevo/osprey-delight" + url: "https://github.com/hugo-mods/" + - type: heart + url: "https://github.com/sponsors/kdevo" - type: stackoverflow url: "" - type: spotify url: https://open.spotify.com/artist/5NhBOdJh6T1tgtM5Au1Opl - - type: bandcamp - url: https://protonautmusic.bandcamp.com - -## Theme features: +## Additional theme features: Feat: # ajaxBasin requires Basin setup for a free contact form (see instructions in README). ajaxBasin: "https://usebasin.com/f/{YOUR-12-CHAR-FORM-KEY-HERE}" @@ -80,16 +99,33 @@ Params: # Image resizing can be configured here (see README for more info): Image: Logo: - resize: "300x" + resize: "600x" Gallery: - resize: "400x" - - # Background: - # resize: "1920x" + resize: "600x" + + Background: + resize: "1920x" + resizeLQIP: "256x" + + # Advanced configuration for lazyimg module (comment out if needed): + # lazyimg: + # resizer: auto + # renderer: lqip-webp + + # # Resizer options: + # lqipSize: "120x Gaussian" + # maxSize: "1920x" + # responsiveSizes: ["320x", "640x", "768x", "1024x", "1366x", "1600x", "1920x"] + # resizeOptions: "Lanczos q95" + + # # Renderer options: + # #class: "" + # #alt: "" + # noscript: true -## Menu items are automatically added to navbar. Use content files for more advanced usage. +## Menu items are automatically added to navbar. ## See: https://gohugo.io/content-management/menus/#add-content-to-menus Menu: Main: diff --git a/exampleSite/data/icons.yaml b/exampleSite/data/icons.yaml index 00e56a6..233f8a0 100644 --- a/exampleSite/data/icons.yaml +++ b/exampleSite/data/icons.yaml @@ -1,6 +1,8 @@ # Add custom icons and use them accordingly as social icon as 'type' in config.yaml: spotify: fab spotify bandcamp: fab bandcamp +heart: fas heart +gift: fas gift # This rocket will be displayed in the about section (see about.md): rocket: fas rocket diff --git a/images/github-status.png b/images/github-status.png Binary files differdeleted file mode 100644 index 60e2b86..0000000 --- a/images/github-status.png +++ /dev/null diff --git a/images/screenshot-modal.png b/images/screenshot-modal.png Binary files differdeleted file mode 100644 index 5c4c7b4..0000000 --- a/images/screenshot-modal.png +++ /dev/null diff --git a/images/screenshot-work.png b/images/screenshot-work.png Binary files differdeleted file mode 100644 index 3be0569..0000000 --- a/images/screenshot-work.png +++ /dev/null diff --git a/images/screenshot.png b/images/screenshot.png Binary files differindex fd9d832..9b365f4 100644 --- a/images/screenshot.png +++ b/images/screenshot.png diff --git a/images/tn.png b/images/tn.png Binary files differindex 7a2a7f4..a447489 100644 --- a/images/tn.png +++ b/images/tn.png @@ -4,7 +4,7 @@ licenselink = "https://github.com/kdevo/osprey-delight/blob/master/LICENSE.md" description = "Blazingly fast, beautiful and modular portfolio theme perfectly suited to highlight your work." homepage = "https://github.com/kdevo/osprey-delight" -demo = "https://kdevo.github.io/" +demosite = "https://hugo-mods.github.io/" tags = ["portfolio", "projects", "minimal", "personal", "landing", "onepage", "single-page", "hugo-mods", "responsive", "blog"] features = [ |