Hugo scroll fork
Find a file
Ian Cook 390ad61694
Enable inverting homepage section styling
Add invert Param to the config file. Add the 'odd' class to the
post-holders and the 'even' class to the post-afters using Hugo if
statements instead of using JS. Marking invert = true in the config file
flips which sections are marked odd and even.
2023-03-20 19:45:44 -05:00
.github Merge pull request #108 from zjedi/dependabot/github_actions/peaceiris/actions-hugo-2.6.0 2023-03-18 21:36:00 +01:00
archetypes style: add & run prettier 2020-09-09 18:00:59 +02:00
assets Enable inverting homepage section styling 2023-03-20 19:45:44 -05:00
exampleSite Enable inverting homepage section styling 2023-03-20 19:45:44 -05:00
images chore: compress images & screenshots 2020-07-07 17:55:18 +02:00
layouts Enable inverting homepage section styling 2023-03-20 19:45:44 -05:00
static/fonts - documented external links usage 2023-03-11 22:46:22 +01:00
.gitignore use recommended style for fontawesom lists 2023-03-11 10:42:38 -05:00
.prettierignore chore: move from font-awesome to fork-awesome (#23) 2021-03-26 09:58:40 +01:00
.prettierrc.json style: add & run prettier 2020-09-09 18:00:59 +02:00
contributing.md Tranferring repository ownership 2023-03-18 20:56:52 +01:00
LICENSE chore: initial commit 2020-07-07 17:50:41 +02:00
package-lock.json chore(deps-dev): bump prettier from 2.8.4 to 2.8.5 2023-03-20 16:11:13 +00:00
package.json chore(deps-dev): bump prettier from 2.8.4 to 2.8.5 2023-03-20 16:11:13 +00:00
README.md Tranferring repository ownership 2023-03-18 20:56:52 +01:00
theme.toml Merge remote-tracking branch 'origin/master' 2023-03-18 21:12:07 +01:00

Hugo Scroll

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

For live demo of master branch, please visit https://zjedi.github.io/hugo-scroll/. Test

As a fallback, see a screenshot which may be a bit outdated: Screenshot Hugo Scroll Theme

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.

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.

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 included on the 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

Features

Icons

This theme includes the full set of Fork Awesome 1.2.0 Icons. Use the {{<icon>}}-shortcode with the respective "fa fa-ICONNAME"-class to use an icon directly in your .markdown files à la

Look at this nice »envelope«-icon: `{{<icon class="fa fa-envelope">}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-)

Configured in _index.md, see exampleSite: header_logo: "images/chef-hat.png"

You can add external link in the menu, see external.md in the exampleSite.

You can also use extlink shortcode to create a link opening in new tab:

Visit as at {{<extlink text="Instagram" href="https://www.instagram.com/yourInstagramName/">}}

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-file from the exampleSite-directory to get started and to find more detailed instructions.

Issues / Feedback / Contributing

Please use GitHub issues and Pull Requests. See contributing guideline for more.

Special Thanks 🎁

License

MIT License