[ { "path": ".github/dependabot.yml", "content": "# see https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates\nversion: 2\nupdates:\n # Maintain dependencies for GitHub Actions\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"daily\"\n\n # Maintain dependencies for npm\n - package-ecosystem: \"npm\"\n directory: \"/\"\n schedule:\n interval: \"daily\"\n" }, { "path": ".github/stale.yml", "content": "# Number of days of inactivity before an issue becomes stale\ndaysUntilStale: 90\n# Number of days of inactivity before a stale issue is closed\ndaysUntilClose: 30\n# Issues with these labels will never be considered stale\nexemptLabels:\n - pinned\n - security\n - bug\n - priority-high\nexemptProjects: true\nexemptMilestones: true\n# Label to use when marking an issue as stale\nstaleLabel: no-activity\n# Comment to post when marking an issue as stale. Set to `false` to disable\nmarkComment: false\n# Comment to post when closing a stale issue. Set to `false` to disable\ncloseComment: false" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n push:\n branches:\n - master\n pull_request:\n branches:\n - master\n\njobs:\n build:\n runs-on: ubuntu-22.04\n\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n\n - name: Setup Hugo\n uses: peaceiris/actions-hugo@v3.0.0\n with:\n hugo-version: latest\n extended: true\n\n - name: Build local ./exampleSite\n run: hugo --minify --gc --destination ../public --source ./exampleSite --themesDir ../.. --baseURL https://zjedi.github.io/hugo-scroll/\n\n - name: Deploy to GitHub Pages\n if: github.event_name == 'push'\n uses: peaceiris/actions-gh-pages@v4.0.0\n with:\n github_token: ${{ secrets.GITHUB_TOKEN }}\n publish_dir: ./public\n" }, { "path": ".gitignore", "content": "public\nexampleSite/public\nexampleSite/resources\nnode_modules\n*.lock\nhugo-scroll.code-workspace\n" }, { "path": ".prettierignore", "content": "assets/css/fontawesome\nassets/css/normalize.css\nlayouts/_default/index.html\npublic\nresources\n" }, { "path": ".prettierrc.json", "content": "{\n \"overrides\": [\n {\n \"files\": [\"*.html\"],\n \"options\": {\n \"parser\": \"go-template\"\n }\n }\n ]\n}\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n* Added for new features.\n* Changed for changes in existing functionality.\n* Deprecated for soon-to-be removed features.\n* Removed for now removed features.\n* Fixed for any bug fixes.\n* Security in case of vulnerabilities.\n\n## [Unreleased](https://github.com/zjedi/hugo-scroll/compare/v.1.0.0...master)\n\n* **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.\n* New features: #70 , #46 , #118\n* More features #116 , #119\n\n## [1.0.0 Legacy Snapshot](https://github.com/zjedi/hugo-scroll/releases/tag/v.1.0.0)\n\n## Template for new releases\n\n## [x.y.z](https://github.com/zjedi/hugo-scroll/compare/v1.0.0...vx.y.z)\n\n### Added\n\n### Changed\n\n### Deprecated\n\n### Removed\n\n### Fixed\n\n### Security\n" }, { "path": "LICENSE", "content": "The MIT License (MIT)\n\nCopyright (c) 2020 Jan Raasch\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\nthe Software, and to permit persons to whom the Software is furnished to do so,\nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\nFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\nIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\nCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n" }, { "path": "README.md", "content": "

Hugo Scroll 📜 Demo

\n\nClean, responsive, single-page [Hugo](https://gohugo.io/) website theme.\n\n[![hugo-scroll](https://img.shields.io/badge/Hugo--Themes-HugoScroll-blue)](https://themes.gohugo.io/themes/hugo-scroll/)\n![Test](https://github.com/zjedi/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/a56faf45-76fa-4bdf-b9d4-35cfc7d620cf/deploy-status)](https://app.netlify.com/sites/hugo-scroll/deploys)\n[![GitHub](https://img.shields.io/github/license/zjedi/hugo-scroll)](https://github.com/zjedi/hugo-scroll/blob/master/LICENSE)\n![code-size](https://img.shields.io/github/languages/code-size/zjedi/hugo-scroll)\n\nPromo image which may be a bit outdated:
\n![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png)\n\n## ⭐ Feature highlights\n\n- Responsive to screen size/shape\n- SEO friendly\n- Customizable\n- Video cover\n- [Font Awesome v6.6.0 Icons][font-awesome-icons] out of the box\n- Header logo\n- Visual guards to guarantee readability\n- External links\n- JS/CSS Assets optimized (Minification, Fingerprinting, pipeline-processed\ninto single file)\n- git info in footer (opt-in)\n\n## 🔑 Installation\n\nYou need to install Hugo extended version.\nIf you already have a Hugo site on your machine, you can simply add this theme via\n\n```cli\ngit submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll\n```\n\nThen, adjust the `hugo.toml` as detailed below & in the file comments.\n\n### Playing around with our example site\n\nIf you simply want to check out the `exampleSite`, you can run\n\n```cli\ngit clone https://github.com/zjedi/hugo-scroll.git hugo-scroll\ncd hugo-scroll\nhugo server --source=exampleSite --themesDir=../..\n```\n\nFor more information, read the official [Hugo setup guide][hugo-setup-guide].\n\nIf 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.\n\nPlease 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.\n\nYou can add **a new section to the homepage** by running `hugo new homepage/my-new-content.md` (or craft the file manually)\n\nTo create **a page separate from the homepage**, run `hugo new my-new-page.md`\n\n## 🔧 Feature details 🔨\n\n### Customizing CSS\n\nAdd a [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html) file to your `layouts/partials` directory.\n\n- You can use `\n-->\n\n\n\n\n\n\n\n\n\n{{ with resources.Get \"images/apple-touch-icon.png\" }}{{ end }}\n{{ with resources.Get \"images/favicon.svg\" }}{{ end }}\n{{ range seq 9 4 }}{{ $size := pow 2 . }}{{ $file := replace \"images/favicon-##x##.png\" \"##\" $size }}{{ with resources.Get $file }}\n{{ end }}{{ end }}\n\n" }, { "path": "exampleSite/layouts/partials/custom_header_video.html", "content": "\n" }, { "path": "i18n/de.toml", "content": "[email]\nother = \"Email\"\n\n[phone]\nother = \"Telefon\"\n" }, { "path": "i18n/en.toml", "content": "[email]\nother = \"Email\"\n\n[phone]\nother = \"Phone\"\n" }, { "path": "layouts/404.html", "content": "{{ define \"main\" }}\n
\n
\n
\n \n {{ .Site.Title }}\n \n
\n

404 - Page Not Found

\n
\n Give it another try:\n Back to the homepage.\n
\n
\n
\n{{ end }}\n" }, { "path": "layouts/_default/baseof.html", "content": "\n\n \n {{- partial \"head.html\" . -}}\n \n \n {{- partial \"header.html\" . -}}\n {{- block \"main\" . }}{{- end }}\n {{- partial \"footer.html\" . -}}\n\n \n\n {{ $scriptJquery := resources.Get \"js/jquery-3.6.3.min.js\" }}\n\n \n {{ $scriptIndex := resources.Get \"js/index.js\" }}\n {{ $scriptPolyfill := resources.Get \"js/css-vars-ponyfill.min.js\" }}\n {{ $js := slice $scriptJquery $scriptIndex $scriptPolyfill | resources.Concat \"js/script.js\" | resources.Minify | resources.Fingerprint }}\n\n \n\n \n \n\n \n {{- partial \"custom_body.html\" . -}}\n \n\n" }, { "path": "layouts/_default/index.html", "content": "{{ define \"main\" }}\n{{ $headless := .GetPage \"./homepage\" }}\n{{ if hugo.IsMultihost }}\n {{ $headless := .Site.GetPage \"/homepage\" }}\n{{ end }}\n{{ $sections := $headless.Resources.ByType \"page\" }}\n{{ $sections := cond .Site.BuildDrafts $sections (where $sections \"Draft\" \"==\" false) }}\n{{ $content := where (where $sections \"Params.external\" \"==\" nil) \"Params.detailed_page_homepage_content\" \"ne\" false }}\n{{ $langs := .Page.AllTranslations }}\n{{ if hugo.IsMultihost }}\n {{ $langs = .Site.Languages }}\n{{ end }}\n\n\n{{ if not .Params.header_use_video }}\n {{ with $img := resources.Get .Params.header_image }}\n {{ $image_options := $.Site.Params.image_options | default \"webp q90 lanczos photo\" -}}\n \n {{ end }}\n
\n{{ else }}\n
\n{{ end }}\n\n
\n\n {{ if .Params.header_use_video }}\n \n {{- partial \"custom_header_video.html\" . -}}\n {{ end }}\n\n {{ $num_lang := len $langs }}\n {{ if and (gt $num_lang 1) $.Site.Params.language_menu }}\n\t
\n {{ range $langs }}\n {{ $condition := eq .Lang $.Lang }}\n {{ $lang_func := .Language.LanguageName }}\n {{ $href := .RelPermalink }}\n {{ if hugo.IsMultihost }}\n {{ $langs = site.Sites }}\n {{ $condition = eq . $.Site }}\n {{ $lang_func = .LanguageName }}\n {{ $href = .Home.Permalink }}\n {{ end }}\n {{ $lang_title := or $lang_func (.Lang | strings.ToUpper) }}\n {{ if $condition }}\n {{ if $.Site.Params.show_current_lang }}\n {{ $lang_title }}\n {{ end }}\n {{ else }}\n {{ $lang_title }}\n {{ end }}\n {{ end }}\n\t
\n\t{{ end }}\n\n
\n\t {{ with resources.Get .Params.header_logo }}\"\"{{ end }}\n\n {{ if .Site.Params.title_guard }}
{{ end }}\n {{ with .Params.header_headline }}

{{ . | safeHTML }}

{{ end }}\n {{ with .Params.header_subheadline }}

{{ . | safeHTML }}

{{ end }}\n {{ if .Site.Params.title_guard }}
{{ end }}\n\n {{ range where $sections \".Params.header_menu\" \"eq\" true }}\n {{ $button_title := .Title }}\n {{ with .Params.header_menu_title }}{{ $button_title = . }}{{ end }}\n\n {{ if isset .Params \"external\" }}\n {{ $button_title }} \n {{ else if isset .Params \"detailed_page_path\" }}\n {{ $button_title }}\n {{ else }}\n {{ $fnav_title := .Title }}{{ with .Params.navigation_menu_title }}{{ $fnav_title = . }}{{ end }}\n {{ $button_title }}\n {{ end }}\n {{ end }}\n\n {{ with (index $content 0) }}\n {{ $first_title := .Title }}{{ with .Params.navigation_menu_title }}{{ $first_title = . }}{{ end }}\n \n {{ end }}\n
\n
\n
\n\n
\n \n
\n {{ if eq .Params.nav_to_top_weight \"first\" }}\n {{ $fnav_title := \"Start\" }}{{ with .Params.nav_to_top_title }}{{ $fnav_title = . }}{{ end }}\n {{ $fnav_title | safeHTML }}\n {{ end }}\n {{ $last_index_val := 0 }}\n {{ range $index_val, $elem_val := $content }}\n {{ $fnav_title := .Title }}{{ with .Params.navigation_menu_title }}{{ $fnav_title = . }}{{ end }}\n {{ $fnav_title | safeHTML }}\n {{ $last_index_val = $index_val }}\n {{ end }}\n {{ if eq .Params.nav_to_top_weight \"last\" }}\n {{ $fnav_title := \"Start\" }}{{ with .Params.nav_to_top_title }}{{ $fnav_title = . }}{{ end }}\n {{ $fnav_title | safeHTML }}\n {{ end }}\n
\n\n \n {{ range $index_val, $elem_val := $content }}\n {{ if .Title }}\n {{ $fnav_title := .Title }}{{ with .Params.navigation_menu_title }}{{ $fnav_title = . }}{{ end }}\n
\n
\n
\n

{{ .Title | emojify | safeHTML }}

\n
\n
\n {{ .Content }}\n
\n
\n
\n
\n {{ end }}\n {{ end }}\n
\n{{ end }}\n" }, { "path": "layouts/_default/list.html", "content": "" }, { "path": "layouts/_default/single.html", "content": "{{ define \"main\" }}\n
\n \n
\n{{ end }}\n" }, { "path": "layouts/partials/custom_body.html", "content": "\n" }, { "path": "layouts/partials/custom_head.html", "content": "\n" }, { "path": "layouts/partials/custom_header_video.html", "content": "\n\n" }, { "path": "layouts/partials/footer.html", "content": "{{ $headless := .Site.GetPage \"/homepage\" }}\n{{ $sections := $headless.Resources.ByType \"page\" }}\n{{ $sections := cond .Site.BuildDrafts $sections (where $sections \"Draft\" \"==\" false) }}\n\n\n" }, { "path": "layouts/partials/head.html", "content": "\n\n\n{{ if and site.Params.combine_page_and_site_title .Title .Site.Title }}\n{{ .Title | plainify }} | {{ .Site.Title | plainify }}\n{{ else }}\n{{ with or .Title .Site.Title | plainify }}\n{{ . }}\n{{ end }}\n{{ end }}\n\n{{ with resources.Get .Site.Params.favicon }}\n {{ end }}\n\n{{ with or .Description .Site.Params.description | plainify }}\n {{ end }}\n{{ with or (delimit .Keywords \", \") .Site.Params.meta.keywords }}\n {{ end }}\n\n\n\n\n\n\n{{ $stylesheetNormalize := resources.Get \"css/normalize.css\" }}\n{{ $stylesheetFA := resources.Get \"css/fontawesome/fontawesome.min.css\" }}\n{{ $stylesheetFABrands := resources.Get \"css/fontawesome/brands.min.css\" }}\n{{ $stylesheetFASolid := resources.Get \"css/fontawesome/solid.min.css\" }}\n{{ $stylesheetFonts := resources.Get \"css/fonts.css\" }}\n{{ $stylesheetGeneric := resources.Get \"css/generic.css\" }}\n\n{{ $stylesheetScreen := ( resources.Get \"css/_index.scss\" | css.Sass ) }}\n\n{{ $stylesheet := slice $stylesheetNormalize $stylesheetFA $stylesheetFABrands $stylesheetFASolid $stylesheetFonts $stylesheetGeneric $stylesheetScreen | resources.Concat \"css/style.css\" | resources.Minify | resources.Fingerprint }}\n\n\n{{ template \"_internal/opengraph.html\" . }}\n{{ template \"_internal/twitter_cards.html\" . }}\n{{ template \"_internal/schema.html\" . }}\n\n\n{{- partial \"custom_head.html\" . -}}\n" }, { "path": "layouts/partials/header.html", "content": "" }, { "path": "layouts/shortcodes/contact_list.html", "content": "{{ range .Site.Params.contacts }}\n

 {{ .value }}

\n{{ end }}\n" }, { "path": "layouts/shortcodes/email.html", "content": "{{ .Site.Params.contact.email }}\n" }, { "path": "layouts/shortcodes/extlink.html", "content": "{{ with .Get \"href\" }}{{ end }}{{ with .Get \"icon\" }} {{ end }}{{ with .Get \"text\" }}{{ . }}{{ end }}\n" }, { "path": "layouts/shortcodes/icon.html", "content": "{{ if .Get \"brand\" }}\n {{ with .Get \"name\" }}{{ end }}\n{{ else }}\n {{ with .Get \"name\" }}{{ end }}\n{{ end }}\n" }, { "path": "layouts/shortcodes/phone.html", "content": "{{ .Site.Params.contact.phone }}\n" }, { "path": "layouts/shortcodes/rawhtml.html", "content": "\n{{.Inner}}\n" }, { "path": "netlify.toml", "content": "[build]\n publish = \"exampleSite/public\"\n\n[build.environment]\n HUGO_VERSION = \"0.134.2\"\n HUGO_THEME = \"repo\"\n\n[context.production]\n command = \"cd exampleSite && hugo --minify --gc --themesDir ../.. -b ${URL}\"\n [context.production.environment]\n HUGO_ENV = \"production\"\n\n[context.branch-deploy]\n command = \"cd exampleSite && hugo --minify --gc --themesDir ../.. -b ${DEPLOY_PRIME_URL}\"\n\n[context.deploy-preview]\n command = \"cd exampleSite && hugo --minify --gc --themesDir ../.. -b ${DEPLOY_PRIME_URL}\"\n\n[[plugins]]\n package = \"netlify-plugin-hugo-cache-resources\"\n\n [plugins.inputs]\n # If it should show more verbose logs (optional, default = true)\n debug = true\n # Relative path to source directory in case you use Hugo's \"--s\" option\n srcdir = \"exampleSite\"\n" }, { "path": "package.json", "content": "{\n \"private\": true,\n \"name\": \"hugo-scroll\",\n \"version\": \"1.0.0\",\n \"description\": \"A Hugo theme for pretty, quick and simple single-page websites.\",\n \"main\": \"index.js\",\n \"scripts\": {\n \"test\": \"prettier --check . \",\n \"format\": \"prettier --write . \"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/zjedi/hugo-scroll.git\"\n },\n \"author\": {\n \"name\": \"Jan Raasch\",\n \"email\": \"jan@janraasch.com\",\n \"url\": \"https://www.janraasch.com\"\n },\n \"license\": \"MIT\",\n \"bugs\": {\n \"url\": \"https://github.com/zjedi/hugo-scroll/issues\"\n },\n \"homepage\": \"https://github.com/zjedi/hugo-scroll#readme\",\n \"devDependencies\": {\n \"prettier\": \"^2.8.8\",\n \"prettier-plugin-go-template\": \"0.0.13\"\n }\n}\n" }, { "path": "theme.toml", "content": "# theme.toml template for a Hugo theme\n# See https://github.com/gohugoio/hugoThemes#themetoml for an example\n\nname = \"Hugo Scroll\"\nlicense = \"MIT\"\nlicenselink = \"https://github.com/zjedi/hugo-scroll/blob/master/LICENSE\"\ndescription = \"A Hugo theme for pretty, quick and simple single-page websites.\"\nhomepage = \"https://github.com/zjedi/hugo-scroll\"\ndemosite = \"https://zjedi.github.io/hugo-scroll/\"\ntags = [\n \"clean\",\n \"contact\",\n \"fontawesome\",\n \"landing page\",\n \"onepage\",\n \"one page\",\n \"personal\",\n \"projects\",\n \"simple\",\n \"single page\",\n \"starter\",\n \"responsive\",\n \"theme\"\n]\nfeatures = [\"cover-image\", \"favicon\", \"header-menu\", \"auto-scroll\"]\nmin_version = \"0.132.0\"\n\nauthors = [\n {name = \"Jan Raasch\", homepage = \"https://www.janraasch.com\"},\n {name = \"Zdenek Kedaj\", homepage = \"https://github.com/zjedi\"}\n]\n\n[original]\n name = \"GhostScroll\"\n homepage = \"https://github.com/grmmph/GhostScroll\"\n repo = \"https://github.com/grmmph/GhostScroll\"\n" } ]