yann/hugo-scroll
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Tranferring repository ownership

Browse source
This commit is contained in:
zjedi 2023-03-18 20:56:52 +01:00
parent 4a848bb6ae
commit cbed08621d
6 changed files with 23 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View file

@ -22,7 +22,7 @@ jobs:
hugo-version: latest
- 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
if: github.event_name == 'push'

26
README.md
View file

@ -1,21 +1,21 @@
# Hugo Scroll
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/.
![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push)
For live demo of master branch, please visit https://zjedi.github.io/hugo-scroll/.
![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
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.
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
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.
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)
@ -49,19 +49,19 @@ Visit as at {{<extlink text="Instagram" href="https://www.instagram.com/yourInst
```
### 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
Please use [GitHub issues](https://github.com/janraasch/hugo-scroll/issues) and [Pull Requests](https://github.com/janraasch/hugo-scroll/pulls).
See [contributing guideline](https://github.com/janraasch/hugo-scroll/blob/master/contributing.md) for more.
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/zjedi/hugo-scroll/blob/master/contributing.md) for more.
## Special Thanks 🎁
- 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.
- 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).
- [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 those wonderful _free_ stock photos on the [exampleSite](https://github.com/zjedi/hugo-scroll/tree/master/exampleSite).
## 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
[fork-awesome-icons]: https://forkaweso.me/Fork-Awesome/icons/

4
contributing.md
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.
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.
## [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.

4
layouts/partials/footer.html
View file

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

6
package.json
View file

@ -10,7 +10,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/janraasch/hugo-scroll.git"
"url": "git+https://github.com/zjedi/hugo-scroll.git"
},
"author": {
"name": "Jan Raasch",
@ -19,9 +19,9 @@
},
"license": "MIT",
"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": {
"prettier": "^2.8.4",
"prettier-plugin-go-template": "0.0.13"

6
theme.toml
View file

@ -3,10 +3,10 @@
name = "Hugo Scroll"
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."
homepage = "https://github.com/janraasch/hugo-scroll"
demosite = "https://janraasch.github.io/hugo-scroll/"
homepage = "https://github.com/zjedi/hugo-scroll"
demosite = "https://zjedi.github.io/hugo-scroll/"
tags = [
"clean",
"contact",