blob: c46ac5fa00bd9753d444c1d301614d2b56b69b67 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Highlights
Highlights is a simple one page site originally created by [HTML5UP](http://html5up.net). This Hugo theme is a port of theme.
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
## Installation
Inside the folder of your Hugo site run:
$ cd themes
$ git clone https://github.com/schmanat/hugo-highlights-theme
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.
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)
2. Upload the generated site to your server
3. Send a dummy email yourself to confirm your account
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
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
The theme is licensed under the [Creative Commons Attribution 3.0 Unported](https://creativecommons.org/licenses/by/3.0/)
## Acknowledgements
Thanks to
- [HTML5UP](http://html5up.net) for creating this theme
- [Steve Francia](//github.com/spf13) for creating Hugo and the awesome community around the project.
|
