diff options
Diffstat (limited to 'exampleSite/config.yaml')
| -rw-r--r-- | exampleSite/config.yaml | 108 |
1 files changed, 77 insertions, 31 deletions
diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index 96baa34..53b5864 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: "" @@ -9,10 +9,17 @@ disableKinds: ["taxonomy", "taxonomyTerm"] enableEmoji: true pygmentsUseClasses: true +module: + imports: + - 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" @@ -20,79 +27,118 @@ 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'. This file will contain only a redirect directive if this switch is enabled. + # 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. + # If this switch is enabled, all these "orphan" files will contain only a redirect directive. enforceSinglePage: false - # copyright flag generates a copyright notice in footer for your site. + # 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 # the icon to use. can be anything mentioned in "assets/sass/_icons.scss" + - type: twitter # references the icon to use url: "" - type: linkedin url: "" - type: github - url: github = "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 - -## Theme features: +## Additional theme features: Feat: - # useLazySizes to lazy load images with lazysizes (recommended) - useLazySizes: true - - # ajaxBasin uses Basin for a functional contact form. + # ajaxBasin requires Basin setup for a free contact form (see instructions in README). 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. + # structuredDataGitHubUser will tell the theme to use your USERNAME for querying the GitHub API to fetch more information about you 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. + # The library has been stripped-down to a minimum to only have the necessary functionality. useTermynal: true googleTagManager: "" + + # notifyOnNewThemeVersion enables a notification for every new minor/major version of this theme. + # Whenever there is a new one, a warning is printed to console. + notifyOnNewThemeVersion: true - # Expert mode: Configure image resizing (some of the settings are not yet publicly documented) + # 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 -## The 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: - name: "About" - identifier: about # the identifier controls the section type (and therewith the appearence). + # identifier controls the section type (and therewith the appearence). + identifier: about + # url must be an anchor, for smooth scrolling to it when clicking on the menu item. url: "/#about" + # weight controls the order of the menu items. weight: 1 - name: "Work" identifier: gallery @@ -106,8 +152,8 @@ Menu: 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 + # - name: "" + # # pre makes it possible to use arbitrary HTML before the name, e.g. referencing icons here is possible: + # pre: '<svg class="icon"><use xlink:href="#icon-external"/></svg> ' + # url: "https://pyotek.dev" + # weight: 5 |