diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..3d62184 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +custom: ["https://www.paypal.me/janraasch/29,00"] +github: ["janraasch"] diff --git a/.github/stale.yml b/.github/stale.yml index 86c4885..dc90e5a 100644 --- a/.github/stale.yml +++ b/.github/stale.yml @@ -1,18 +1,17 @@ # Number of days of inactivity before an issue becomes stale -daysUntilStale: 90 +daysUntilStale: 60 # Number of days of inactivity before a stale issue is closed -daysUntilClose: 30 +daysUntilClose: 7 # Issues with these labels will never be considered stale exemptLabels: - pinned - security - - bug - - priority-high -exemptProjects: true -exemptMilestones: true # Label to use when marking an issue as stale -staleLabel: no-activity +staleLabel: wontfix # Comment to post when marking an issue as stale. Set to `false` to disable -markComment: false +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. # Comment to post when closing a stale issue. Set to `false` to disable -closeComment: false \ No newline at end of file +closeComment: false diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f931a91..569bd32 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -10,24 +10,23 @@ on: jobs: build: - runs-on: ubuntu-22.04 + runs-on: ubuntu-18.04 steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v3 - name: Setup Hugo - uses: peaceiris/actions-hugo@v3.0.0 + uses: peaceiris/actions-hugo@v2.5.0 with: hugo-version: latest - extended: true - name: Build local ./exampleSite - run: hugo --minify --gc --destination ../public --source ./exampleSite --themesDir ../.. --baseURL https://zjedi.github.io/hugo-scroll/ + run: hugo --minify --gc --destination ../public --source ./exampleSite --themesDir ../.. --baseURL https://janraasch.github.io/hugo-scroll/ - name: Deploy to GitHub Pages if: github.event_name == 'push' - uses: peaceiris/actions-gh-pages@v4.0.0 + uses: peaceiris/actions-gh-pages@v3.8.0 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public diff --git a/.gitignore b/.gitignore index 0c3b764..ea47378 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,3 @@ public exampleSite/public -exampleSite/resources node_modules -*.lock -hugo-scroll.code-workspace diff --git a/.prettierignore b/.prettierignore index 7cace38..f8ebd30 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,5 +1,6 @@ -assets/css/fontawesome -assets/css/normalize.css -layouts/_default/index.html -public +build resources +public +static/fork-awesome +static/css/normalize.css +layouts/index.html diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index f5284ff..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,37 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -* Added for new features. -* Changed for changes in existing functionality. -* Deprecated for soon-to-be removed features. -* Removed for now removed features. -* Fixed for any bug fixes. -* Security in case of vulnerabilities. - -## [Unreleased](https://github.com/zjedi/hugo-scroll/compare/v.1.0.0...master) - -* **JS cleanup / CSS refactoring**, possibly causing some pain if you have extensive CSS customisations in screen.css #4, #61, #102. For backwards compatibility, a released tag `v1.0.0` was created just in case some projects needed to fix the legacy version. However, I won't actively support the legacy branch. -* New features: #70 , #46 , #118 -* More features #116 , #119 - -## [1.0.0 Legacy Snapshot](https://github.com/zjedi/hugo-scroll/releases/tag/v.1.0.0) - -## Template for new releases - -## [x.y.z](https://github.com/zjedi/hugo-scroll/compare/v1.0.0...vx.y.z) - -### Added - -### Changed - -### Deprecated - -### Removed - -### Fixed - -### Security diff --git a/README.md b/README.md index f95e63d..f2ca754 100644 --- a/README.md +++ b/README.md @@ -1,144 +1,97 @@ -

Hugo Scroll 📜 Demo

+# Hugo Scroll ![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) [![Pay me][paypal-svg]][paypal-dot-me] [![Sponsor me][github-sponsors-svg]][github-sponsors] -Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme. +📜 A [Hugo](https://gohugo.io/)-theme for pretty, quick and simple single-page websites. -[![hugo-scroll](https://img.shields.io/badge/Hugo--Themes-HugoScroll-blue)](https://themes.gohugo.io/themes/hugo-scroll/) -![Test](https://github.com/zjedi/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) -[![Netlify Status](https://api.netlify.com/api/v1/badges/a56faf45-76fa-4bdf-b9d4-35cfc7d620cf/deploy-status)](https://app.netlify.com/sites/hugo-scroll/deploys) -[![GitHub](https://img.shields.io/github/license/zjedi/hugo-scroll)](https://github.com/zjedi/hugo-scroll/blob/master/LICENSE) -![code-size](https://img.shields.io/github/languages/code-size/zjedi/hugo-scroll) +![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/janraasch/hugo-scroll/master/images/tn.png) -Promo image which may be a bit outdated:
-![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png) +## Demo -## ⭐ Feature highlights +For a current & working demo of this theme please check out https://janraasch.github.io/hugo-scroll/ 🎯. -- Responsive to screen size/shape -- SEO friendly -- Customizable -- Video cover -- [Font Awesome v6.6.0 Icons][font-awesome-icons] out of the box -- Header logo -- Visual guards to guarantee readability -- External links -- JS/CSS Assets optimized (Minification, Fingerprinting, pipeline-processed -into single file) -- git info in footer (opt-in) +## Sponsor 💟 -## 🔑 Installation +Support my work on this theme via [GitHub Sponsors][github-sponsors] (recurring) or [PayPal][paypal-dot-me] (one-time). -You need to install Hugo extended version. -If you already have a Hugo site on your machine, you can simply add this theme via +[![GitHub Stats](https://github-readme-stats.vercel.app/api/?username=janraasch)][github-sponsors] -```cli -git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll +## Installation + +If you already have a hugo site on your machine, you can simply add this theme via + +``` +git submodule add https://github.com/janraasch/hugo-scroll.git themes/hugo-scroll ``` -Then, adjust the `hugo.toml` as detailed below & in the file comments. - -### Playing around with our example site +Then, adjust the `config.toml` as detailed below. If you simply want to check out the `exampleSite`, you can run -```cli -git clone https://github.com/zjedi/hugo-scroll.git hugo-scroll +``` +git clone https://github.com/janraasch/hugo-scroll.git hugo-scroll cd hugo-scroll hugo server --source=exampleSite --themesDir=../.. ``` -For more information, read the official [Hugo setup guide][hugo-setup-guide]. +For more information read the official [setup guide][hugo-setup-guide] of Hugo. + +## Adjust configuration / config.toml + +Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme. + +## Content & structure + +### Starting fresh If you are starting fresh, simply copy over the contents of the `exampleSite`-directory included in this theme to your source directory. That should give you a good idea about how things work, and then you can go on from there to make the site your own. -Please check out the [hugo.toml](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/hugo.toml) included in the [exampleSite](https://github.com/zjedi/hugo-scroll/tree/master/exampleSite) of this theme. +### Adding content -You can add **a new section to the homepage** by running `hugo new homepage/my-new-content.md` (or craft the file manually) +You can add **a new section to the homepage** via running -To create **a page separate from the homepage**, run `hugo new my-new-page.md` - -## 🔧 Feature details 🔨 - -### Customizing CSS - -Add a [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html) file to your `layouts/partials` directory. - -- You can use ` ---> + /* Header Buttons on Startpage */ + a.btn { + color: white; + background-color: #ced067; + } + a.btn:hover { + background-color: #b6b84c; + } + + /* Scroll Menu on Startpage */ + a.fn-item.active { + color: #b6b84c; + } + a.fn-item:hover { + color: #ced067; + } + + /* Content / Sections */ + .post-holder.odd { + background: #B80135; + color: white; + } + .post-holder { + background: #f2efe8; + } + body { + color: #3A4145; + } + + /* Footer */ + .site-footer { + color: #BBC7CC; + background-color: #22343A; + } + --> -{{ with resources.Get "images/apple-touch-icon.png" }}{{ end }} -{{ with resources.Get "images/favicon.svg" }}{{ end }} -{{ range seq 9 4 }}{{ $size := pow 2 . }}{{ $file := replace "images/favicon-##x##.png" "##" $size }}{{ with resources.Get $file }} -{{ end }}{{ end }} - + + + diff --git a/exampleSite/layouts/partials/custom_header_video.html b/exampleSite/layouts/partials/custom_header_video.html deleted file mode 100644 index 49ff1f5..0000000 --- a/exampleSite/layouts/partials/custom_header_video.html +++ /dev/null @@ -1,11 +0,0 @@ - diff --git a/exampleSite/assets/favicon.ico b/exampleSite/static/favicon.ico similarity index 100% rename from exampleSite/assets/favicon.ico rename to exampleSite/static/favicon.ico diff --git a/exampleSite/assets/images/apple-touch-icon.png b/exampleSite/static/images/apple-touch-icon.png similarity index 100% rename from exampleSite/assets/images/apple-touch-icon.png rename to exampleSite/static/images/apple-touch-icon.png diff --git a/exampleSite/static/images/board-bunch-cooking-food-349609.jpg b/exampleSite/static/images/board-bunch-cooking-food-349609.jpg index 00fcf8a..2f5ee35 100644 Binary files a/exampleSite/static/images/board-bunch-cooking-food-349609.jpg and b/exampleSite/static/images/board-bunch-cooking-food-349609.jpg differ diff --git a/exampleSite/assets/images/cover-image.jpg b/exampleSite/static/images/cover-image.jpg similarity index 100% rename from exampleSite/assets/images/cover-image.jpg rename to exampleSite/static/images/cover-image.jpg diff --git a/exampleSite/assets/images/favicon.png b/exampleSite/static/images/favicon.png similarity index 100% rename from exampleSite/assets/images/favicon.png rename to exampleSite/static/images/favicon.png diff --git a/exampleSite/static/images/happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg b/exampleSite/static/images/happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg new file mode 100644 index 0000000..86438dc Binary files /dev/null and b/exampleSite/static/images/happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg differ diff --git a/exampleSite/static/images/photography-of-tomatoes-near-basil-leaves-1391487.jpg b/exampleSite/static/images/photography-of-tomatoes-near-basil-leaves-1391487.jpg new file mode 100644 index 0000000..271a8a5 Binary files /dev/null and b/exampleSite/static/images/photography-of-tomatoes-near-basil-leaves-1391487.jpg differ diff --git a/exampleSite/static/images/selective-focus-photography-of-pasta-with-tomato-and-basil-1279330.jpg b/exampleSite/static/images/selective-focus-photography-of-pasta-with-tomato-and-basil-1279330.jpg index e49f5e9..9a4d936 100644 Binary files a/exampleSite/static/images/selective-focus-photography-of-pasta-with-tomato-and-basil-1279330.jpg and b/exampleSite/static/images/selective-focus-photography-of-pasta-with-tomato-and-basil-1279330.jpg differ diff --git a/exampleSite/static/images/static-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg b/exampleSite/static/images/static-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg deleted file mode 100644 index 71ebeb5..0000000 Binary files a/exampleSite/static/images/static-happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg and /dev/null differ diff --git a/exampleSite/static/images/woman-pouring-juice-on-glass-3184192.jpg b/exampleSite/static/images/woman-pouring-juice-on-glass-3184192.jpg index 3f881e0..1824a4d 100644 Binary files a/exampleSite/static/images/woman-pouring-juice-on-glass-3184192.jpg and b/exampleSite/static/images/woman-pouring-juice-on-glass-3184192.jpg differ diff --git a/i18n/de.toml b/i18n/de.toml deleted file mode 100644 index 7563e59..0000000 --- a/i18n/de.toml +++ /dev/null @@ -1,5 +0,0 @@ -[email] -other = "Email" - -[phone] -other = "Telefon" diff --git a/i18n/en.toml b/i18n/en.toml deleted file mode 100644 index 87afd30..0000000 --- a/i18n/en.toml +++ /dev/null @@ -1,5 +0,0 @@ -[email] -other = "Email" - -[phone] -other = "Phone" diff --git a/images/screenshot.png b/images/screenshot.png index be4eeac..2b7e54e 100644 Binary files a/images/screenshot.png and b/images/screenshot.png differ diff --git a/images/tn.png b/images/tn.png index be4eeac..4daa6bc 100644 Binary files a/images/tn.png and b/images/tn.png differ diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index cc95895..b192fa0 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -1,27 +1,17 @@ - - - {{- partial "head.html" . -}} - + + {{- partial "head.html" . -}} {{- partial "header.html" . -}} {{- block "main" . }}{{- end }} {{- partial "footer.html" . -}} - - {{ $scriptJquery := resources.Get "js/jquery-3.6.3.min.js" }} + - {{ $scriptIndex := resources.Get "js/index.js" }} - {{ $scriptPolyfill := resources.Get "js/css-vars-ponyfill.min.js" }} - {{ $js := slice $scriptJquery $scriptIndex $scriptPolyfill | resources.Concat "js/script.js" | resources.Minify | resources.Fingerprint }} - - - - - - + + diff --git a/layouts/_default/index.html b/layouts/_default/index.html deleted file mode 100644 index 0fa0938..0000000 --- a/layouts/_default/index.html +++ /dev/null @@ -1,161 +0,0 @@ -{{ define "main" }} -{{ $headless := .GetPage "./homepage" }} -{{ if hugo.IsMultihost }} - {{ $headless := .Site.GetPage "/homepage" }} -{{ end }} -{{ $sections := $headless.Resources.ByType "page" }} -{{ $sections := cond .Site.BuildDrafts $sections (where $sections "Draft" "==" false) }} -{{ $content := where (where $sections "Params.external" "==" nil) "Params.detailed_page_homepage_content" "ne" false }} -{{ $langs := .Page.AllTranslations }} -{{ if hugo.IsMultihost }} - {{ $langs = .Site.Languages }} -{{ end }} - - -{{ if not .Params.header_use_video }} - {{ with $img := resources.Get .Params.header_image }} - {{ $image_options := $.Site.Params.image_options | default "webp q90 lanczos photo" -}} - - {{ end }} -