Merge remote-tracking branch 'origin/master'

This commit is contained in:
zjedi 2023-03-18 21:12:07 +01:00
commit 891f2b4125
6 changed files with 23 additions and 25 deletions

View file

@ -22,7 +22,7 @@ jobs:
hugo-version: latest hugo-version: latest
- name: Build local ./exampleSite - name: Build local ./exampleSite
run: hugo --minify --gc --destination ../public --source ./exampleSite --themesDir ../.. --baseURL https://janraasch.github.io/hugo-scroll/ run: hugo --minify --gc --destination ../public --source ./exampleSite --themesDir ../.. --baseURL https://zjedi.github.io/hugo-scroll/
- name: Deploy to GitHub Pages - name: Deploy to GitHub Pages
if: github.event_name == 'push' if: github.event_name == 'push'

View file

@ -1,21 +1,21 @@
# Hugo Scroll # Hugo Scroll
A [Hugo](https://gohugo.io/) theme for pretty, quick and simple single-page websites. A [Hugo](https://gohugo.io/) theme for pretty, quick and simple single-page websites.
For live demo of master branch, please visit https://janraasch.github.io/hugo-scroll/. For live demo of master branch, please visit https://zjedi.github.io/hugo-scroll/.
![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) ![Test](https://github.com/zjedi/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push)
As a fallback, see a screenshot which may be a bit outdated: ![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/janraasch/hugo-scroll/master/images/tn.png) As a fallback, see a screenshot which may be a bit outdated: ![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/zjedi/hugo-scroll/master/images/tn.png)
## Installation ## Installation
If you already have a hugo site on your machine, you can simply add this theme via 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 git submodule add https://github.com/zjedi/hugo-scroll.git themes/hugo-scroll
``` ```
Then, adjust the `config.toml` as detailed below & in the file comments. Then, adjust the `config.toml` as detailed below & in the file comments.
If you simply want to check out the `exampleSite`, you can run If you simply want to check out the `exampleSite`, you can run
``` ```
git clone https://github.com/janraasch/hugo-scroll.git hugo-scroll git clone https://github.com/zjedi/hugo-scroll.git hugo-scroll
cd hugo-scroll cd hugo-scroll
hugo server --source=exampleSite --themesDir=../.. hugo server --source=exampleSite --themesDir=../..
``` ```
@ -24,7 +24,7 @@ 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. 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 [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. Please check out the [config.toml](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/config.toml) included on 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) You can add **a new section to the homepage** by running `hugo new homepage/my-new-content.md` (or craft the file manually)
@ -49,19 +49,19 @@ Visit as at {{<extlink text="Instagram" href="https://www.instagram.com/yourInst
``` ```
### Customizing CSS ### Customizing CSS
Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag _or_ you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Checkout the [`custom_head.html`](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html)-file from the `exampleSite`-directory to get started and to find more detailed instructions. Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag _or_ you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Checkout the [`custom_head.html`](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html)-file from the `exampleSite`-directory to get started and to find more detailed instructions.
## Issues / Feedback / Contributing ## Issues / Feedback / Contributing
Please use [GitHub issues](https://github.com/janraasch/hugo-scroll/issues) and [Pull Requests](https://github.com/janraasch/hugo-scroll/pulls). Please use [GitHub issues](https://github.com/zjedi/hugo-scroll/issues) and [Pull Requests](https://github.com/zjedi/hugo-scroll/pulls).
See [contributing guideline](https://github.com/janraasch/hugo-scroll/blob/master/contributing.md) for more. See [contributing guideline](https://github.com/zjedi/hugo-scroll/blob/master/contributing.md) for more.
## Special Thanks 🎁 ## Special Thanks 🎁
- [Jan Raasch](https://www.janraasch.com), original author of theme
- Go to [Yonatan Wolowelsky](https://github.com/grmmph), for the great [GhostScroll](https://github.com/grmmph/GhostScroll)-theme which formed the basis of this [Hugo](https://gohugo.io/)-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.
- Go to [Pexels](https://www.pexels.com), for supplying those wonderful _free_ stock photos on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite). - [Pexels](https://www.pexels.com), for supplying those wonderful _free_ stock photos on the [exampleSite](https://github.com/zjedi/hugo-scroll/tree/master/exampleSite).
## License ## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License) © [Jan Raasch](https://www.janraasch.com) [MIT License](http://en.wikipedia.org/wiki/MIT_License)
[hugo-setup-guide]: https://gohugo.io/getting-started/installing [hugo-setup-guide]: https://gohugo.io/getting-started/installing
[fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/ [fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/

View file

@ -1,9 +1,9 @@
## [Pull Requests](https://github.com/janraasch/hugo-scroll/pulls) ## [Pull Requests](https://github.com/zjedi/hugo-scroll/pulls)
We're open to contributions by opening a pull request. We're open to contributions by opening a pull request.
When adding a new feature, please modify also `exampleSite` with an example of how the feature can be activated, configured and used. When adding a new feature, please modify also `exampleSite` with an example of how the feature can be activated, configured and used.
Mention new feature also in relevant `readme.md` section. Mention new feature also in relevant `readme.md` section.
## [GitHub issues](https://github.com/janraasch/hugo-scroll/issues) ## [GitHub issues](https://github.com/zjedi/hugo-scroll/issues)
Used for tracking more complex topics and features. Used for tracking more complex topics and features.

View file

@ -7,9 +7,7 @@
<section>{{ echoParam .Site.Params "hidebyline" }}</section> <section>{{ echoParam .Site.Params "hidebyline" }}</section>
{{ if ne .Site.Params.hidedesignbyline true }} {{ if ne .Site.Params.hidedesignbyline true }}
<section> <section>
<a href="https://themes.gohugo.io/hugo-scroll/">Design</a> template <a href="https://themes.gohugo.io/hugo-scroll/">Hugo Scroll</a> template
built with ♥️ by
<a href="https://www.janraasch.com" title="Jan Raasch">Jan Raasch</a>
</section>{{ end }} </section>{{ end }}
</div> </div>

View file

@ -10,7 +10,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/janraasch/hugo-scroll.git" "url": "git+https://github.com/zjedi/hugo-scroll.git"
}, },
"author": { "author": {
"name": "Jan Raasch", "name": "Jan Raasch",
@ -19,9 +19,9 @@
}, },
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/janraasch/hugo-scroll/issues" "url": "https://github.com/zjedi/hugo-scroll/issues"
}, },
"homepage": "https://github.com/janraasch/hugo-scroll#readme", "homepage": "https://github.com/zjedi/hugo-scroll#readme",
"devDependencies": { "devDependencies": {
"prettier": "^2.8.4", "prettier": "^2.8.4",
"prettier-plugin-go-template": "0.0.13" "prettier-plugin-go-template": "0.0.13"

View file

@ -3,10 +3,10 @@
name = "Hugo Scroll" name = "Hugo Scroll"
license = "MIT" license = "MIT"
licenselink = "https://github.com/janraasch/hugo-scroll/blob/master/LICENSE" licenselink = "https://github.com/zjedi/hugo-scroll/blob/master/LICENSE"
description = "A Hugo theme for pretty, quick and simple single-page websites." description = "A Hugo theme for pretty, quick and simple single-page websites."
homepage = "https://github.com/janraasch/hugo-scroll" homepage = "https://github.com/zjedi/hugo-scroll"
demosite = "https://janraasch.github.io/hugo-scroll/" demosite = "https://zjedi.github.io/hugo-scroll/"
tags = [ tags = [
"clean", "clean",
"contact", "contact",