Hugo Scroll πŸ“œ Demo

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:
![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 - [Fork Awesome Icons][fork-awesome-icons] out of the box - Header logo - Visual guards to guarantee readability - External links - JS/CSS Assets optimized (Minification, Fingerpriting, pipeline-processed into single file) - git info in footer (opt-in) ## πŸ”‘ Installation If you already have a Hugo site on your machine, you can simply add this theme via ``` 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. ### Playing around with our example site If you simply want to check out the `exampleSite`, you can run ``` 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 [config.toml](https://github.com/zjedi/hugo-scroll/blob/master/exampleSite/config.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 `