diff --git a/README.md b/README.md index dc983e0..c6efd2f 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,56 @@ -# Hugo Scroll ![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) +# Hugo Scroll +A [Hugo](https://gohugo.io/) theme for pretty, quick and simple single-page websites. -📜 A [Hugo](https://gohugo.io/)-theme for pretty, quick and simple single-page websites. +For live demo of master branch, please visit https://janraasch.github.io/hugo-scroll/. +![Test](https://github.com/janraasch/hugo-scroll/workflows/CI/badge.svg?branch=master&event=push) -![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/janraasch/hugo-scroll/master/images/tn.png) - -## Demo - -For a current & working demo of this theme please check out https://janraasch.github.io/hugo-scroll/ 🎯. +As a fallback, see a screenshot which may be a bit outdated: ![Screenshot Hugo Scroll Theme](https://raw.githubusercontent.com/janraasch/hugo-scroll/master/images/tn.png) ## 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][hugo-setup-guide] of Hugo. - -## Adjust configuration / config.toml - -Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme. - -## Content & structure - -### Starting fresh +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. -### Adding content +Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme. -You can add **a new section to the homepage** via running +You can add **a new section to the homepage** by running `hugo new homepage/my-new-content.md` (or craft the file manually) -``` -hugo new homepage/my-new-content.md -``` - -To create **a page separate from the homepage**, run - -``` -hugo new my-new-page.md -``` - -### Using icons - -This theme includes the full set of [Fork Awesome 1.1.7 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 +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][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/ :-) +Look at this nice »envelope«-icon: `{{}}`. I took this from https://forkaweso.me/Fork-Awesome/icon/envelope/ :-) ``` -For the full list of icons, see [Fork Awesome 1.1.7 Icons][fork-awesome-icons]. +### External links +You can add external link in the menu, see `external.md` in the `exampleSite`. -### Adding your branding / colors / css +You can also use `extlink` shortcode to create a link opening in new tab: +```markdown +Visit as at {{}} +``` +### Customizing CSS Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `