Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/schmanat/hugo-highlights-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSchneider Manuel <manuel.schneider@dornbirn.at>2020-04-09 15:05:26 +0300
committerSchneider Manuel <manuel.schneider@dornbirn.at>2020-04-09 15:05:26 +0300
commitd83365d02a2aa84c5451fc90a8f946cc47890212 (patch)
tree9c57bf76083204e277daf802f5d7928de6da7a08 /README.md
parent3ccb5fbd3a4430a7d6fac8a55a9c2f633658c407 (diff)
fix issue #19 (fab fonts not displayed)
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 25 insertions, 5 deletions
diff --git a/README.md b/README.md
index 589dccf..c46ac5f 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@ Highlights is a simple one page site originally created by [HTML5UP](http://html
All the information for creating the site is stored at the [config.toml](https://raw.githubusercontent.com/schmanat/hugo-highlights-theme/master/exampleSite/config.toml).
This theme provides the following features
-* contact form (via formspree.io)
-* Google Analytics
-* responsive
+- contact form (via formspree.io)
+- Google Analytics
+- responsive
![Hugo Highlights Theme screenshot](https://raw.githubusercontent.com/schmanat/hugo-highlights-theme/master/images/screenshot.png)
@@ -20,26 +20,45 @@ Inside the folder of your Hugo site run:
For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
## Getting started
+
After installing the Hugo Highlights Theme it requires a just few more steps to get your site running.
### The config file
+
Take a look inside the [`exampleSite`](//github.com/schmanat/hugo-highlights-theme/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](//github.com/schmanat/hugo-highlights-theme/tree/master/exampleSite/config.toml)
### Change the background images
+
It's possible to change the background files for every section (about, services, ... ). To do this you could set every image in the [`config.toml`](//github.com/schmanat/hugo-highlights-theme/tree/master/exampleSite/config.toml) of your site. The files are stored at `static/images/`.
### Present your skills
+
This section should show your capabilities and skills. You can change this serverics at `[params.services` in the [`config.toml`](//github.com/schmanat/hugo-highlights-theme/tree/master/exampleSite/config.toml).
-All icons are part of Fontawesome's icon font. Look at the website of [Fontawesome](//fortawesome.github.io/Font-Awesome/icons/) for more icons. The icons are represented by their corresponding CSS class of Fontawesome. A skill is defined like this example:
+All icons are part of Fontawesome's icon font. Look at the website of [Fontawesome](//fortawesome.github.io/Font-Awesome/icons/) for more icons. The icons are represented by their corresponding CSS class of Fontawesome.
+Since [version 5 of Font Awesome](https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4) the prefix changes, so you have to decide which style you wont to use.
+
+The icontype could be:
+
+- fab (Font Awesome Brands)
+- fas or fa (Font Awesome Solid)
+- far (Font Aweseome Regular)
+- fal (Font Aweseome Light)
+- fad (Font Aweseome Duotone)
+
+far, fal and fad are only available for Pro
+
+A skill is defined like this example:
```toml
[[params.services]]
+ icontype = "fas"
icon = "fa-camera-retro"
title = "Magna Etiam"
```
### Make the contact form working
+
Since this page will be static, you can use [formspree.io](//formspree.io/) as proxy to send the actual email. Each month, visitors can send you up to one thousand emails without incurring extra charges. Begin the setup by following the steps below:
1. Enter your email address under 'email' in the [`config.toml`](//github.com/schmanat/hugo-highlights-theme/tree/master/exampleSite/config.toml)
@@ -48,8 +67,8 @@ Since this page will be static, you can use [formspree.io](//formspree.io/) as p
4. Click the confirm link in the email form www.formspree.io
5. Thats all. Enjoy mailing!
-
### Nearly finished
+
In order to see your site in action, run Hugo's built-in local server.
$ hugo server
@@ -57,6 +76,7 @@ In order to see your site in action, run Hugo's built-in local server.
Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.
## Contributing
+
Did you found a bug or got an idea for features? Feel free to use the [issue tracker](//github.com/schmanat/hugo-highlights-theme/issues) to let me know.
## License