diff --git a/README.md b/README.md index 55f48bf..6a81aac 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,52 @@ Clean, responsive, single-page [Hugo](https://gohugo.io/) website theme. 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 +- Responseive to screen size/shape +- SEO friendly +- Customizable +- [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) + +## Feature details +### Icons +This theme includes the full set of [Fork Awesome 1.2.0 Icons][fork-awesome-icons]. Use the `{{}}`-[shortcode][hugo-shortcodes] with the respective "fa fa-ICONNAME"-`class` to use an icon directly in your `.markdown` files à la +```markdown +Look at this nice »envelope«-icon: `{{}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-) +``` +### Header logo +Configured in `_index.md`, see `exampleSite`: `header_logo: "images/chef-hat.png"` + +### Footer version information +In order to see technical version information (extracted from Hugo's [GitInfo](https://gohugo.io/variables/git/))) set the following general option in your config.toml: `enableGitInfo = true` + +### External links +You can add an external link in the menu, see `external.md` in the `exampleSite`. + +You can also use `extlink` shortcode to create a link opening in a new tab: +```markdown +Visit as at {{}} +``` +Referencing and showing icons in front of the link text is possible with a new parameter `icon`: +```markdown +Visit as at {{}} +``` + +### 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 ` +--> - /* Header Buttons on Startpage */ - a.btn { - color: white; - background-color: #ced067; - } - a.btn:hover { - background-color: #b6b84c; - } - - /* Scroll Menu on Startpage */ - a.fn-item.active { - color: #b6b84c; - } - a.fn-item:hover { - color: #ced067; - } - - /* Content / Sections */ - .post-holder.odd { - background: #B80135; - color: white; - } - .post-holder { - background: #f2efe8; - } - body { - color: #3A4145; - } - - /* Footer */ - .site-footer { - color: #BBC7CC; - background-color: #22343A; - } - --> +