hugo-scroll/README.md

2.4 KiB

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/ 🎯.

Quick Start

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=../..

Adjust configuration / config.toml

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

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

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