Repository: janraasch/hugo-scroll Branch: master Commit: 54f7b8543f18 Files: 73 Total size: 102.3 KB Directory structure: gitextract_ytsfl82u/ ├── .github/ │ ├── dependabot.yml │ ├── stale.yml │ └── workflows/ │ └── ci.yml ├── .gitignore ├── .prettierignore ├── .prettierrc.json ├── CHANGELOG.md ├── LICENSE ├── README.md ├── archetypes/ │ ├── default.md │ └── homepage.md ├── assets/ │ ├── css/ │ │ ├── _index.scss │ │ ├── content.scss │ │ ├── fontawesome/ │ │ │ └── LICENSE.txt │ │ ├── fonts.css │ │ ├── generic.css │ │ ├── normalize.css │ │ ├── responsiveness.scss │ │ ├── theme.scss │ │ └── variables.scss │ └── js/ │ └── index.js ├── contributing.md ├── exampleSite/ │ ├── content/ │ │ ├── de/ │ │ │ ├── _index.md │ │ │ ├── homepage/ │ │ │ │ ├── about-me-local-img.md │ │ │ │ ├── contact.md │ │ │ │ ├── external.md │ │ │ │ ├── index.md │ │ │ │ ├── legal-brief.md │ │ │ │ ├── license.md │ │ │ │ ├── opener.md │ │ │ │ └── services.md │ │ │ ├── legal.md │ │ │ ├── license.md │ │ │ └── services.md │ │ └── en/ │ │ ├── _index.md │ │ ├── homepage/ │ │ │ ├── about-me.de.md │ │ │ ├── about-me.md │ │ │ ├── contact.md │ │ │ ├── credits.md │ │ │ ├── external.md │ │ │ ├── index.md │ │ │ ├── legal-brief.md │ │ │ ├── license.md │ │ │ ├── opener.md │ │ │ └── services.md │ │ ├── legal.md │ │ ├── license.md │ │ └── services.md │ ├── hugo.toml │ └── layouts/ │ └── partials/ │ ├── custom_head.html │ └── custom_header_video.html ├── i18n/ │ ├── de.toml │ └── en.toml ├── layouts/ │ ├── 404.html │ ├── _default/ │ │ ├── baseof.html │ │ ├── index.html │ │ ├── list.html │ │ └── single.html │ ├── partials/ │ │ ├── custom_body.html │ │ ├── custom_head.html │ │ ├── custom_header_video.html │ │ ├── footer.html │ │ ├── head.html │ │ └── header.html │ └── shortcodes/ │ ├── contact_list.html │ ├── email.html │ ├── extlink.html │ ├── icon.html │ ├── phone.html │ └── rawhtml.html ├── netlify.toml ├── package.json └── theme.toml ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/dependabot.yml ================================================ # see https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates version: 2 updates: # Maintain dependencies for GitHub Actions - package-ecosystem: "github-actions" directory: "/" schedule: interval: "daily" # Maintain dependencies for npm - package-ecosystem: "npm" directory: "/" schedule: interval: "daily" ================================================ FILE: .github/stale.yml ================================================ # Number of days of inactivity before an issue becomes stale daysUntilStale: 90 # Number of days of inactivity before a stale issue is closed daysUntilClose: 30 # 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 # Comment to post when marking an issue as stale. Set to `false` to disable markComment: false # Comment to post when closing a stale issue. Set to `false` to disable closeComment: false ================================================ FILE: .github/workflows/ci.yml ================================================ name: CI on: push: branches: - master pull_request: branches: - master jobs: build: runs-on: ubuntu-22.04 steps: - name: Checkout uses: actions/checkout@v4 - name: Setup Hugo uses: peaceiris/actions-hugo@v3.0.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/ - name: Deploy to GitHub Pages if: github.event_name == 'push' uses: peaceiris/actions-gh-pages@v4.0.0 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./public ================================================ FILE: .gitignore ================================================ public exampleSite/public exampleSite/resources node_modules *.lock hugo-scroll.code-workspace ================================================ FILE: .prettierignore ================================================ assets/css/fontawesome assets/css/normalize.css layouts/_default/index.html public resources ================================================ FILE: .prettierrc.json ================================================ { "overrides": [ { "files": ["*.html"], "options": { "parser": "go-template" } } ] } ================================================ FILE: CHANGELOG.md ================================================ # 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 ================================================ FILE: LICENSE ================================================ The MIT License (MIT) Copyright (c) 2020 Jan Raasch Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README.md ================================================

Hugo Scroll 📜 Demo

Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme. [![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) Promo image which may be a bit outdated:
![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png) ## ⭐ Feature highlights - 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) ## 🔑 Installation You need to install Hugo extended version. If you already have a Hugo site on your machine, you can simply add this theme via ```cli git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll ``` Then, adjust the `hugo.toml` as detailed below & in the file comments. ### Playing around with our example site If you simply want to check out the `exampleSite`, you can run ```cli git clone https://github.com/zjedi/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]. 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. You can add **a new section to the homepage** by running `hugo new homepage/my-new-content.md` (or craft the file manually) 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 ` --> {{ 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 }} ================================================ FILE: exampleSite/layouts/partials/custom_header_video.html ================================================ ================================================ FILE: i18n/de.toml ================================================ [email] other = "Email" [phone] other = "Telefon" ================================================ FILE: i18n/en.toml ================================================ [email] other = "Email" [phone] other = "Phone" ================================================ FILE: layouts/404.html ================================================ {{ define "main" }}

404 - Page Not Found

Give it another try: Back to the homepage.
{{ end }} ================================================ FILE: layouts/_default/baseof.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 }} {{- partial "custom_body.html" . -}} ================================================ FILE: layouts/_default/index.html ================================================ {{ 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 }}