Add theme

Author: james-d-mitchell

themes/hugo-scroll/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# 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"

themes/hugo-scroll/.github/stale.yml

@@ -0,0 +1,18 @@
+# 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

themes/hugo-scroll/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+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

themes/hugo-scroll/.gitignore

@@ -0,0 +1,6 @@
+public
+exampleSite/public
+exampleSite/resources
+node_modules
+*.lock
+hugo-scroll.code-workspace

themes/hugo-scroll/.prettierignore

@@ -0,0 +1,5 @@
+assets/css/fontawesome
+assets/css/normalize.css
+layouts/_default/index.html
+public
+resources

themes/hugo-scroll/.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "overrides": [
+    {
+      "files": ["*.html"],
+      "options": {
+        "parser": "go-template"
+      }
+    }
+  ]
+}

themes/hugo-scroll/CHANGELOG.md

@@ -0,0 +1,37 @@
+# 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

themes/hugo-scroll/LICENSE

@@ -0,0 +1,20 @@
+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.

themes/hugo-scroll/README.md

@@ -0,0 +1,144 @@
+<h1 align=center>Hugo Scroll 📜 <a href="https://zjedi.github.io/hugo-scroll/" rel="nofollow">Demo</a></h1>
+
+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:<br/>
+![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 `<style>` tag to embed the overrides (better performance-wise)
+- Alternatively you can `<link>` your own `custom.css`
+
+`CSS` variables `var(--some-var-name)` from `assets\css\variables.scss` can be overridden by adding
+
+```scss
+:root {
+  --some-var-name: blue!important;
+}
+```
+
+### Icons
+
+This theme includes the full set of [Font Awesome v6.6.0 icons][font-awesome-icons]. Use the `{{< icon >}}` [shortcode][hugo-shortcodes] with the respective `name` to use an icon directly in your `.md` files. For example:
+
+```html
+{{< icon name="envelope" >}}
+```
+
+If you want to use one of Font Awesome's brand icons—the ones that have a trademark warning and the `fa-brands` class—add `brand=true`. For example:
+
+```html
+{{< icon name="github" brand=true >}}
+```
+
+If you want to use these branded icons in your contact list, use the full class names in your `hugo.toml`:
+
+```toml
+[[params.contacts]]
+  label = "GitHub"
+  value = "github.com/zjedi/hugo-scroll"
+  url = "https://github.com/zjedi/hugo-scroll"
+  icon = "fa-brands fa-github"
+```
+
+### Header logo
+
+Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"`
+
+### Video cover
+
+Set `header_use_video: true` in `/exampleSite/content/_index.md` and define video source via custom partial, such as `exampleSite/layouts/partials/custom_header_video.html`.
+
+### Footer version information
+
+In order to see technical version information (extracted from Hugo's [GitInfo](https://gohugo.io/variables/git/))) set the following general option in your hugo.toml: `enableGitInfo = true`
+
+### External links
+
+You can add an external link in the menu, see `external.md` in the `exampleSite`.
+
+You can also use `extlink` shortcode to create a link opening in a new tab:
+
+```markdown
+Visit us at {{<extlink text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
+```
+
+Referencing and showing icons in front of the link text is possible with a new parameter `icon`:
+
+```markdown
+Visit us at {{<extlink icon="fa fa-instagram" text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}
+```
+
+## 🐛 Issues / 💡 Feedback / 👑 Contributing
+
+[Discussion](https://github.com/zjedi/hugo-scroll/discussions) for Q&A (when unsure),
+[Issues](https://github.com/zjedi/hugo-scroll/issues) for tracking,
+[Pull Requests](https://github.com/zjedi/hugo-scroll/pulls) for contributions.
+
+See [contributing guideline](https://github.com/zjedi/hugo-scroll/blob/master/contributing.md) for more.
+
+## 👏 Special Thanks
+
+- [Jan Raasch](https://www.janraasch.com), original author of theme
+- [Yonatan Wolowelsky](https://github.com/grmmph), author of [GhostScroll](https://github.com/grmmph/GhostScroll) theme, which formed the basis of this [Hugo](https://gohugo.io/) theme.
+- [Pexels](https://www.pexels.com), for supplying _free_ stock photos.
+
+[hugo-setup-guide]: https://gohugo.io/getting-started/installing
+[font-awesome-icons]: https://fontawesome.com/icons
+[hugo-shortcodes]: https://gohugo.io/content-management/shortcodes/

themes/hugo-scroll/archetypes/default.md

@@ -0,0 +1,5 @@
+---
+title: '{{ replace .Name "-" " " | title }}'
+---
+
+This is a page about »{{ replace .Name "-" " " | title }}«.