diff options
author | kdevo <kdevo@users.noreply.github.com> | 2021-04-24 00:46:29 +0300 |
---|---|---|
committer | kdevo <kdevo@users.noreply.github.com> | 2021-04-24 00:46:29 +0300 |
commit | ff1db4571313bf3d7ea2d7d57b7dc665f06d182d (patch) | |
tree | 073bf13ba832e805097a98544fe61f0d5b7739bd | |
parent | 8346b2c63f2002044ef1e22197608edbe1acaeb4 (diff) |
:pencil: :recycle: Document exampleSite and adapt docs
-rw-r--r-- | CONTRIBUTING.md | 12 | ||||
-rw-r--r-- | README.md | 107 | ||||
-rw-r--r-- | archetypes/default.md | 12 | ||||
-rw-r--r-- | archetypes/gallery.md | 27 | ||||
-rw-r--r-- | exampleSite/assets/kd.png (renamed from exampleSite/static/images/kd.png) | bin | 20974 -> 20974 bytes | |||
-rw-r--r-- | exampleSite/assets/osprey-delight-logo.png | bin | 0 -> 19840 bytes | |||
-rw-r--r-- | exampleSite/assets/osprey-delight.png | bin | 0 -> 17947 bytes | |||
-rw-r--r-- | exampleSite/assets/osprey-logo.png | bin | 0 -> 26739 bytes | |||
-rw-r--r-- | exampleSite/assets/sass/_custom.scss | 1 | ||||
-rw-r--r-- | exampleSite/config.toml | 112 | ||||
-rw-r--r-- | exampleSite/config.yaml | 113 | ||||
-rw-r--r-- | exampleSite/content/about.md | 10 | ||||
-rw-r--r-- | exampleSite/content/gallery/hugo.md | 25 | ||||
-rw-r--r-- | exampleSite/content/gallery/kdevo.md | 24 | ||||
-rw-r--r-- | exampleSite/content/gallery/osprey-delight.md | 11 | ||||
-rw-r--r-- | exampleSite/content/gallery/osprey.md | 23 | ||||
-rw-r--r-- | exampleSite/content/gallery/toma-nistor.md | 23 | ||||
-rw-r--r-- | history.md (renamed from MOTIVATION.md) | 0 | ||||
-rw-r--r-- | theme.toml | 2 |
19 files changed, 258 insertions, 244 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d0552ae --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +## Contributing + +Contributions are welcome! Fork this repo and create a merge request if you implemented a feature or a bug fix that everyone can profit from. + +The necessary requirements for merge requests are: +1. Theme should be kept leightweight +2. Keep it modular: New features should be made optional if possible or if they influence performance in any way +3. Document your changes; most importantly your config changes in **config.toml** (if there are any) + +## License + +This theme is released under the Apache 2.0 license, just like its predecessor. For more information read the [license](https://github.com/kdevo/osprey-delight/blob/master/LICENSE.md).
\ No newline at end of file @@ -1,57 +1,59 @@ <a href="https://git.io/osprey-delight" target="_blank"> <img alt="Osprey Delight Logo" src="https://raw.githubusercontent.com/kdevo/osprey-delight/master/images/osprey-delight-logo.png" width="250"> </a> - <a href="https://kdevo.netlify.app/" target="_blank"> <img align="right" alt="Nelify Continous Deployment Status" src="https://api.netlify.com/api/v1/badges/aff9a674-45e1-4437-89f7-2aabb281780f/deploy-status"> </a> --- [![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.65-%230097a7?logo=hugo&style=flat-square)](https://github.com/gohugoio/hugo/releases) +[![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) -# Osprey Delight +## Overview -Osprey **De**light is a sugar-free version of the [awesome Osprey theme](https://github.com/tomanistor/osprey) by [Toma Nistor](https://tomanistor.com/) for [Hugo](https://gohugo.io/), a fast static site generator. +Osprey Delight is the free-minded artist's choice for a clutter-free and blazingly fast single-page portfolio. -It's a blazingly fast minimalistic single page portfolio perfectly suited to show off your awesome work! +It's perfectly suited to show off your awesome work! -> 💡 The theme tastes a bit different than the original (hence the *light* in the name) but also adds great new functionality - hopefully to your ***delight***. Read more about the motivation and differences of the fork [here](./MOTIVATION.md), but also check out the feature summary below! +> Osprey Delight tastes a bit different than [the original great Osprey theme](https://github.com/tomanistor/osprey) and adds awesome new functionality to your **delight**. -## Features +### Features -- Gallery items with different types - - `normal`: Just as you are used to with the original Osprey theme - - `github`: Magic GitHub API integration -- Gallery images can optionally be normalized with Hugo's [amazing image processing](https://gohugo.io/content-management/image-processing/) -- Blazingly fast loading speeds - - Minified JS/CSS/icon bundles using Hugo Pipes - - Lazy-loading of images using lazysizes -- Contact form using Basin with Honeypot protection -- Fancy UX - - Smooth scrolling plus scroll-spy - - Nice CSS animations - - Awesome icons in the footer -- Modular theme, enable features as you want -- Intelli-404: Automatically searches for suitable matches - never loose the link to your content +- Single page made out of extensible section building blocks: + - About: introduce yourself + - Gallery: show your work using a grid-based gallery + - Blog: lightweight blog features + - Contact: Contact form with Basin support and built-in spambot protection +- [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) +- Minified JS/CSS/icon bundles generated by [Hugo Pipes](https://gohugo.io/hugo-pipes/) +- Blur-up technique using an optional low-quality image placeholders (LQIP) - SEO-optimized - - High PageSpeed Insights score (98~100) - - Automatically generated structured data based on public information ensures that everyone finds you + - 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 + - Auto-generated structured ensures that everyone finds you +- Delightful UX + - Awesome social icons in footer + - Smooth scrolling plus scroll-spy + - Sane fallbacks for No-Script/No-JS users + - Intelli-404: Automatically searches for suitable matches - never loose the link to your content +- Endlessly customizable - no need to maintain a fork! + - Enable features as you want + - Use custom SCSS + - Coming soon: Full theming support In general, many [open issues](https://github.com/tomanistor/osprey/issues) of the original theme have been resolved. - -## Keep it up +### Contribute There are multiple ways to show your support if you like this project: -- Start [contributing](#Contributing) if you are familiar with Hugo themes/templating +- If you are familiar with Hugo themes/templating: [Start contributing](CONTRIBUTING.md)! - [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 -## Screenshots +### Screenshots -Osprey Delight works with gallery items which are organized in a Flexbox grid: +Osprey Delight uses gallery items which are organized in a grid: ![Screenshot of gallery items](https://raw.githubusercontent.com/kdevo/osprey-delight/master/images/screenshot-work.png) @@ -61,9 +63,6 @@ The items can be opened and a modal will show up: ![Screenshot of opened gallery item](https://raw.githubusercontent.com/kdevo/osprey-delight/master/images/screenshot-modal.png) -> If you've used the original Osprey theme before, this looks pretty familiar, right? -> To taste the differences, it's best to simply try Osprey Delight out! - ## Quickstart @@ -92,9 +91,22 @@ git pull ## Configuration and Usage -It's best if you simply check out the commented **[exampleSite/config.toml](/exampleSite/config.toml)**! +It's best if you simply check out the fully commented [config file](/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 automatically, 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). + +Some recommendations: + +Image Type | Recommended Width | Note +-------------|-------------------|--------------------------------------------------- +Logo | 200px | Logo should not have a transparent border +Gallery | 400px | Gallery images can have a small transparent border for best displaying +Background | 1280px | Optional and not documented right now + ### Content files #### About section @@ -117,7 +129,6 @@ This is very helpful for the first time since you will get a fully documented fi > ⚠️ Please make sure that `item-name` is unique on the whole page because it will be used as an anchor/identifier! - ### Custom (S)CSS 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. @@ -138,42 +149,24 @@ Limiting external dependencies is important when it comes to privacy as well as 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 -3. Add `pygmentsUseClasses = true` to your config.toml +3. Add `pygmentsUseClasses = true` to your config.yaml > Refer to [the official Hugo documentation](https://gohugo.io/content-management/syntax-highlighting/) for more info. -### Data directory (optional) - -Optionally, Osprey Delight makes use of the [Hugo's data folder](https://gohugo.io/templates/data-templates/#the-data-folder). -Currently, the following files can be used to configure the theme in more detail: - -- **terminal.json**: Configure several parameters for optional Termynal (see **config.toml** for an explanation) - ### Contact form: Basin -Basin is a free AJAX contact form service. To use Basin, [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.toml parameter. Select the `Submit this form via AJAX` option on your Basin dashboard. +Basin is a free AJAX contact form service. To use Basin, [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 AJAX setup](https://raw.githubusercontent.com/kdevo/osprey-delight/master/images/basin-ajax-setup.png) #### Spambot protection Under Setup/"Set a Custom Honeypot Field", enter `_anti_spam_honeypot`. -Basin will [ignore all messages that contain this specific field](https://usebasin.com/docs/features/spam-filtering). This will work since there is a hidden field that users normally do not use, but spambots will blindly input their data. +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) -Feel free to open an issue if the protection did not work for you. - - -## Contributing - -Contributions are welcome! Fork this repo and create a merge request if you implemented a feature or a bug fix that everyone can profit from. - -The necessary requirements for merge requests are: -1. Theme should be kept leightweight -2. Keep it modular: New features should be made optional if possible or if they influence performance in any way -3. Document your changes; most importantly your config changes in **config.toml** (if there are any) - -## License +## Help wanted! -This theme is released under the Apache 2.0 license, just like its predecessor. For more information read the [license](https://github.com/kdevo/osprey-delight/blob/master/LICENSE.md). +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)!
\ No newline at end of file diff --git a/archetypes/default.md b/archetypes/default.md index 2661a12..45f8b88 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -1,6 +1,6 @@ -+++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" -date = {{ .Date }} -draft = true -description = "" -+++ +--- +title: "{{ replace .TranslationBaseName "-" " " | title }}" +date: "{{ .Date }}" +draft: true +description: "" +--- diff --git a/archetypes/gallery.md b/archetypes/gallery.md index 48a4196..e5037e7 100644 --- a/archetypes/gallery.md +++ b/archetypes/gallery.md @@ -14,29 +14,22 @@ date: "{{ .Date }}" # 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] Alternatively, you can specify an absolute image URL (comment out the following line). -# imageUrl: "" # [str] Alternative (image) description. # If ommited with type 'github', will use 'description' field from GitHub API. alt: "" # [css] Background color of the gallery item. color: "#fff" -# [enum] Possible types: -# - normal: Just as in the original Osprey theme -# - github: Fetch repo data using GitHub API -type: "normal" -# [str] Link to view the project. -linkView: "" -# [str] Link to show the project's code. -# If ommited with type 'github', will use 'html_url' field from GitHub API. -linkCode: "" -# [map] Configure 'github'-type specific options here: +# [css] Optional gallery item hover color to set it individually. +#hoverColor: "#fff" +# [map] Configure github specific options here: github: # [str] Repo is a combination of "{user_or_org}/{repository_name}", e.g. "kdevo/osprey-delight. - repo: "YOUR-GITHUB-NAME/{{ .TranslationBaseName }}" + #repo: "YOUR-GITHUB-NAME/{{ .TranslationBaseName }}" # [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: +# Example (set "useTermynal" to true in config.yaml and comment out to test it): terminal: # lines: # - type: input @@ -47,6 +40,14 @@ terminal: # wait: 200 # - data: ls: cannot access 'dummy/' directory. # wait: 75 +buttons: + - i18n: view # i18n key (see i18n directory, see https://gohugo.io/functions/i18n/) + icon: angle-circled-right # optional: use an icon (in this case arrow right) + newTab: false # optional: controls if url should be opened in new tab + url: "" + - i18n: code + icon: code + url: "" # [bool] Draft mode will decide if file will be published to 'public/' directory. draft: true --- diff --git a/exampleSite/static/images/kd.png b/exampleSite/assets/kd.png Binary files differindex 7d4bf68..7d4bf68 100644 --- a/exampleSite/static/images/kd.png +++ b/exampleSite/assets/kd.png diff --git a/exampleSite/assets/osprey-delight-logo.png b/exampleSite/assets/osprey-delight-logo.png Binary files differnew file mode 100644 index 0000000..07606f0 --- /dev/null +++ b/exampleSite/assets/osprey-delight-logo.png diff --git a/exampleSite/assets/osprey-delight.png b/exampleSite/assets/osprey-delight.png Binary files differnew file mode 100644 index 0000000..48ec38c --- /dev/null +++ b/exampleSite/assets/osprey-delight.png diff --git a/exampleSite/assets/osprey-logo.png b/exampleSite/assets/osprey-logo.png Binary files differnew file mode 100644 index 0000000..64fdca7 --- /dev/null +++ b/exampleSite/assets/osprey-logo.png diff --git a/exampleSite/assets/sass/_custom.scss b/exampleSite/assets/sass/_custom.scss index 8e37fe9..2392b73 100644 --- a/exampleSite/assets/sass/_custom.scss +++ b/exampleSite/assets/sass/_custom.scss @@ -1,3 +1,4 @@ +/* This file has been generated via hugo gen chromastyles. See README for more information */ /* Background */ .chroma { color: #93a1a1; background-color: #002b36 } /* Other */ .chroma .x { color: #cb4b16 } /* Error */ .chroma .err { } diff --git a/exampleSite/config.toml b/exampleSite/config.toml deleted file mode 100644 index 04f7cdf..0000000 --- a/exampleSite/config.toml +++ /dev/null @@ -1,112 +0,0 @@ -title = "Osprey Delight Demo" -baseURL = "https://example.com" -languageCode = "en-US" -theme = "osprey-delight" -tags = ["personal", "homepage", "portfolio"] -# canonifyURLS = true -# googleAnalytics = "" -disableKinds = ["taxonomy", "taxonomyTerm"] # This theme does not currently use "tag" and "category" taxonomies -enableEmoji = true -pygmentsUseClasses = true - -## Generic theme parameters: -[Params] - author = "kdevo" - email = "" - description = "osprey-delight example site" - # [str] logoBig appears at the top of the page (functioning as your page's mascot) - logoBig = "/images/osprey-delight-logo.png" - # [str] tagline (followed by a cursor) is shown at the top, below the logo - tagline = "Hi there! Check out this theme." - # [md] mdTagline is for advanced users: You can specify the above tagline in Markdown for more customizability. - # Note that {cursor} is a placeholder and will be replaced by the actual cursor HTML when rendering. - #mdTagline = "# Hi there!\n## Check out this theme{cursor}" - # [str] logoSmall is the logo that will be shown in the left corner of the nav bar. - # Usually, you would like to use something bigger than a favicon - but not too big either. - # Make sure that the image does not overlay the nav links. Don't be afraid of experimenting! - logoSmall = "favicon.png" - favicon = "favicon.png" - opengraphImage = "/images/osprey-delight.png" - googleTagManager = "" - # [bool] 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'. - # This file will contain only a redirect directive if this switch is enabled. - # Make sure that you do not enable this switch if you also set useBlog to true. - enforceSinglePage = false - # [bool] copyright flag generates a copyright notice in footer for your site. - copyright = true - # [bool] credit is much appreciated. It will be displayed in a small way in your footer. - #credit = false - # [str] CSS color for accent on the website (applied to links, hovering on links/buttons) - #accentColor = "#e37009" - # [str] If the "image" specified within a gallery item file resides in the 'assets/' directory, - # it will be resized to the given size accordingly, see https://gohugo.io/content-management/image-processing/#resize - resizeGalleryImage = "x450" - - -## Social media links in footer: -[Params.Social] - twitter = "" - linkedin = "" - github = "https://github.com/kdevo/osprey-delight" - stackoverflow = "" - spotify="https://open.spotify.com/artist/5NhBOdJh6T1tgtM5Au1Opl" - ravelry="" - #facebook = "" - #instagram = "" - #tiktok = "" - #itunes = "" - #vkontakte = "" - #medium = "" - # ... basically everything in "_icons.scss" can be referenced! - - -## Theme features: -[Params.Feat] - # [bool] useTermynal enables Termynal (https://github.com/ines/termynal) a small JS library for showing a terminal "animation" from within your gallery item. - # The good thing is that the library has been stripped-down to a minimum to only have the necessary functionality. - useTermynal = true - # [bool] lazyLoading of images with lazysizes basically speeds up your loading time (SEO-friendly). - lazyloading = true - # [str] ajaxBasin uses Basin for a functional contact form. - ajaxBasin = "https://usebasin.com/f/{YOUR-12-CHAR-FORM-KEY-HERE}" - googleTagManager = "" - # [bool] structuredData for your own https://schema.org/Person (SEO-friendly). - # The theme attempts to "guess" your information by using the information you give it in the configuration. - # For more specific usage, you can override the JSON-LD by supplying your own 'person.json' under 'assets/' - structuredData = true - # [str] structuredDataFromGithub needs your USERNAME so that the GitHub API is used to fetch more information for structured data. - # This will use information that is publically available about your GitHub user profile at https://api.github.com/users/{USERNAME}. - # structuredDataFromGithub = "USERNAME" - # [bool] useBlog enables the optional blog module (only set to true if you really want to use the blog - disabling it will save some KBs) - useBlog = true - -## Configure contact form: -[Params.Contact] - # [str[]] select i18n keys used to display in the additional matter drop-down in the contact form. Comment out if you want to disable it. - select = ["generic", "coop", "business", "project"] - - -# Feel free to modify the name field in the following menu, but do not change the url anchor, they are hardcoded within the templates! -[[menu.main]] - name = "About" - url = "/#about" - weight = 1 -[[menu.main]] - name = "Work" - url = "/#work" - weight = 2 -[[menu.main]] - name = "Blog" - url = "/#blog" - weight = 3 -[[menu.main]] - name = "Contact" - url = "/#contact" - weight = 4 -[[menu.main]] - # Use icon here to neatly back reference an external site/blog/whatever: - pre = "<i class='icon icon-link-ext'></i> " - name = "" - url = "https://pyotek.dev" - weight = 5 diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml new file mode 100644 index 0000000..96baa34 --- /dev/null +++ b/exampleSite/config.yaml @@ -0,0 +1,113 @@ +title: "Osprey Delight Demo" +baseURL: "https://example.com" +languageCode: "en-US" +theme: "osprey-delight" +tags: ["personal", "homepage", "portfolio"] +#canonifyURLS: true +#googleAnalytics: "" +disableKinds: ["taxonomy", "taxonomyTerm"] +enableEmoji: true +pygmentsUseClasses: true + +## Generic theme parameters: +Params: + author: "kdevo" + 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" + + # 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" + + # 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'. This file will contain only a redirect directive if this switch is enabled. + enforceSinglePage: false + + # copyright flag generates a copyright notice in footer for your site. + copyright: true + +## Social links in footer: + Social: + - type: twitter # the icon to use. can be anything mentioned in "assets/sass/_icons.scss" + url: "" + - type: linkedin + url: "" + - type: github + url: github = "https://github.com/kdevo/osprey-delight" + - type: stackoverflow + url: "" + - type: spotify + url: https://open.spotify.com/artist/5NhBOdJh6T1tgtM5Au1Opl + + +## Theme features: + Feat: + # useLazySizes to lazy load images with lazysizes (recommended) + useLazySizes: true + + # ajaxBasin uses Basin for a functional contact form. + ajaxBasin: "https://usebasin.com/f/{YOUR-12-CHAR-FORM-KEY-HERE}" + + # useStructuredData for your own https://schema.org/Person (SEO-friendly). + # This will be auto-generated dependent on the information you provide in this configuration. + useStructuredData: false + + # structuredDataGitHubUser needs your USERNAME so that the GitHub API is used to fetch more information for structured data. + # This will use information that is publically available about your GitHub user profile at https://api.github.com/users/{USERNAME}. + #structuredDataGitHubUser = "USERNAME" + + # useTermynal enables Termynal (https://github.com/ines/termynal), a small JS library for showing a terminal "animation" from within your gallery item. + # The cool thing is that the library has been stripped-down to a minimum to only have the necessary functionality. + useTermynal: true + + googleTagManager: "" + + # Expert mode: Configure image resizing (some of the settings are not yet publicly documented) + Image: + Logo: + resize: "300x" + + Gallery: + resize: "400x" + + # Background: + # resize: "1920x" + + +## The menu items are automatically added to navbar. Use content files for more advanced usage. +## See: https://gohugo.io/content-management/menus/#add-content-to-menus +Menu: + Main: + - name: "About" + identifier: about # the identifier controls the section type (and therewith the appearence). + url: "/#about" + weight: 1 + - name: "Work" + identifier: gallery + url: "/#work" + weight: 2 + - name: "Blog" + identifier: blog + url: "/#blog" + weight: 3 + - name: "Contact" + identifier: contact + url: "/#contact" + weight: 4 + # Use icon here to back reference an external site: + - pre: "<i class='icon icon-link-ext'></i> " + name: "" + url: "https://pyotek.dev" + weight: 5 diff --git a/exampleSite/content/about.md b/exampleSite/content/about.md index 715e3c0..2ea1d23 100644 --- a/exampleSite/content/about.md +++ b/exampleSite/content/about.md @@ -1,13 +1,11 @@ +++ -title = "It's the Osprey Delight demo site." +title = "About" date = "2017-06-27T17:39:21-07:00" draft = false +++ -## And [here's my repo!](https://github.com/kdevo/osprey-delight) +Osprey Delight is the free-minded artist's choice for a clutter-free and fast single-page portfolio. -Osprey **De**light is a sugar-free version of the [awesome Osprey theme](https://github.com/tomanistor/osprey) by [Toma Nistor](https://tomanistor.com/) for [Hugo](https://gohugo.io/). +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 original (hence the "light" in the name) but also adds some new functionality -- hopefully to your **delight**. - -Have fun using it! {{< icon "rocket icon-pulse-fast" >}}
\ No newline at end of file +It's perfectly suited to show off your awesome work! {{< icon "rocket icon-pulse-fast" >}}
\ No newline at end of file diff --git a/exampleSite/content/gallery/hugo.md b/exampleSite/content/gallery/hugo.md index afd3891..8dcd05c 100644 --- a/exampleSite/content/gallery/hugo.md +++ b/exampleSite/content/gallery/hugo.md @@ -1,13 +1,18 @@ -+++ -weight = 1 -date = "2017-05-12T22:25:02-07:00" -title = "Hugo" -image = "hugo.png" -alt = "Hugo - a fast and modern static website engine" -color = "#0a1922" -linkView = "http://gohugo.io/" -linkCode = "https://github.com/spf13/hugo" -+++ +--- +weight: 10 +date: "2017-05-12T22:25:02-07:00" +title: "Hugo" +image: "hugo.png" +alt: "Hugo - a fast and modern static website engine" +color: "#0a1922" +buttons: + - icon: gift + i18n: download + url: https://gohugo.io/ + - icon: code + i18n: code + url: "https://github.com/spf13/hugo" +--- Hugo is one of the most popular open-source static site generators. With its amazing speed and flexibility, Hugo makes building websites fun again.
\ No newline at end of file diff --git a/exampleSite/content/gallery/kdevo.md b/exampleSite/content/gallery/kdevo.md index 76abfaa..eea02f4 100644 --- a/exampleSite/content/gallery/kdevo.md +++ b/exampleSite/content/gallery/kdevo.md @@ -1,13 +1,15 @@ -+++ -weight = 20 -date = "2019-05-17T22:25:16-07:00" -title = "kdevo" -# Note that this image will be loaded from the static directory because it is not available under 'assets/': -image = "images/kd.png" -alt = "kdevo" -color = "#263238" -linkView = "https://kdevo.github.io" -linkCode = "https://github.com/kdevo/" -+++ +--- +weight: 10 +date: "2019-05-17T22:25:16-07:00" +title: "KDEVO" +image: "kd.png" +alt: "kdevo" +color: "#263238" +buttons: + - i18n: view + url: "https://kdevo.github.io" + - i18n: code + url: "https://github.com/kdevo/" +--- Author of Osprey Delight.
\ No newline at end of file diff --git a/exampleSite/content/gallery/osprey-delight.md b/exampleSite/content/gallery/osprey-delight.md index b4f7bf5..e263674 100644 --- a/exampleSite/content/gallery/osprey-delight.md +++ b/exampleSite/content/gallery/osprey-delight.md @@ -1,9 +1,9 @@ --- -weight: 20 +weight: 1 date: "2019-09-18T21:57:17-07:00" title: "Osprey Delight" -image: "images/osprey-delight.png" -color: "#C0C0C0 " +image: "osprey-delight-logo.png" +color: "#ffffff" type: "github" github: repo: "kdevo/osprey" @@ -29,6 +29,5 @@ terminal: wait: 500 --- -{{! github-description !}} - -Check it out.
\ No newline at end of file +{github-description} +Check it out!
\ No newline at end of file diff --git a/exampleSite/content/gallery/osprey.md b/exampleSite/content/gallery/osprey.md index 3a1ab2f..11ba86e 100644 --- a/exampleSite/content/gallery/osprey.md +++ b/exampleSite/content/gallery/osprey.md @@ -1,12 +1,11 @@ -+++ -weight = 10 -date = "2017-05-15T21:57:17-07:00" -title = "Osprey" -imageUrl = "images/osprey.png" -color = "#F7F7F7" -linkView = "https://themes.gohugo.io/theme/osprey/" -type = "github" -[github] - repo = "tomanistor/osprey" - showInfo = true -+++ +--- +weight: 40 +date: "2017-05-15T21:57:17-07:00" +title: "Osprey" +image: "osprey-logo.png" +color: "#F7F7F7" +type: "github" +github: + repo: "tomanistor/osprey" + showInfo: true +--- diff --git a/exampleSite/content/gallery/toma-nistor.md b/exampleSite/content/gallery/toma-nistor.md index 7acf5ca..858a069 100644 --- a/exampleSite/content/gallery/toma-nistor.md +++ b/exampleSite/content/gallery/toma-nistor.md @@ -1,12 +1,15 @@ -+++ -weight = 10 -date = "2017-05-15T20:00:16-07:00" -title = "Toma Nistor" -image = "toma-nistor.png" -alt = "Toma Nistor" -color = "#212121" -linkView = "https://tomanistor.com" -linkCode = "https://github.com/tomanistor/tomanistor.com" -+++ +--- +weight: 30 +date: "2017-05-15T20:00:16-07:00" +title: "Toma Nistor" +image: "toma-nistor.png" +alt: "Toma Nistor" +color: "#212121" +buttons: + - i18n: view + url: "https://tomanistor.com" + - i18n: code + url: "https://github.com/tomanistor/tomanistor.com" +--- Author of the original Osprey theme.
\ No newline at end of file diff --git a/MOTIVATION.md b/history.md index eb92256..eb92256 100644 --- a/MOTIVATION.md +++ b/history.md @@ -5,7 +5,7 @@ description = "Osprey Delight is a sugar-free version of the Osprey theme by Tom homepage = "https://github.com/kdevo/osprey-delight" tags = ["portfolio", "gallery", "minimalist", "responsive", "flexbox", "projects", "onepage", "fast"] features = ["portfolio", "contact-form", "github", "lazyload", "blog"] -min_version = "0.74.0" +min_version = "0.80.0" authors = [ {name = "kdevo", homepage = "https://kdevo.github.io/"} |