Hugo scroll fork
Go to file
2020-08-25 07:06:06 +02:00
.github refactor(exampleSite/config.toml): remove themesDir-config 2020-08-16 12:29:13 +02:00
archetypes chore: initial commit 2020-07-07 17:50:41 +02:00
exampleSite docs: add »branding«-section to README 2020-08-25 07:03:48 +02:00
images chore: compress images & screenshots 2020-07-07 17:55:18 +02:00
layouts fix(header_image): remote relURL to make this work when hosted in a subdir 2020-08-01 15:48:07 +02:00
static chore: initial commit 2020-07-07 17:50:41 +02:00
.gitignore chore: gitignore destination directories 2020-07-09 11:22:57 +02:00
LICENSE chore: initial commit 2020-07-07 17:50:41 +02:00
README.md docs(README): add reference to exampleSite to »branding«-section 2020-08-25 07:06:06 +02:00
theme.toml chore: initial commit 2020-07-07 17:50:41 +02:00

Hugo Scroll Test

📜 A Hugo-theme for pretty, quick and simple single-page websites.

Screenshot Hugo Scroll Theme

Demo

For a current & working demo of this theme please check out https://janraasch.github.io/hugo-scroll/ 🎯.

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

Then, adjust the config.toml as detailed below.

If you simply want to check out the exampleSite, you can run

git clone https://github.com/janraasch/hugo-scroll.git hugo-scroll
cd hugo-scroll
hugo server --source=exampleSite --themesDir=../..

For more information read the official setup guide of Hugo.

Adjust configuration / config.toml

Please check out the config.toml included on the exampleSite of this theme.

Content & structure

Starting fresh

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.

Adding content

You can add a new section to the homepage via running

hugo new homepage/my-new-content.md

To create a page separate from the homepage, run

hugo new my-new-page.md

Adding your branding / colors / 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 override.css (in case you prefer to have a separate .css-file). Checkout the custom_head.html-file from the exampleSite-directory to get started and to find more detailed instructions.

Issues / Feedback / Contributing

Please use GitHub issues and Pull Requests.

If you do not have a GitHub-account, feel free to hit me up via e-mail (see janraasch.com).

Sponsor Pay me

Please consider supporting my work on this theme via PayPal.

Special Thanks 🎁

License

MIT License © Jan Raasch