Git Product home page Git Product logo

hugo-highlights-theme's Introduction

Highlights

Highlights is a simple one page site originally created by HTML5UP. This Hugo theme is a port of theme. All the information for creating the site is stored at the config.toml. This theme provides the following features

  • contact form (via formspree.io)
  • Google Analytics
  • responsive

Hugo Highlights Theme screenshot

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 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 folder of this theme. You'll find a file called 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 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.

All icons are part of Fontawesome's icon font. Look at the website of Fontawesome for more icons. The icons are represented by their corresponding CSS class of Fontawesome. A skill is defined like this example:

[[params.services]]
  icon = "fa-camera-retro"
  title = "Magna Etiam"

Make the contact form working

Since this page will be static, you can use 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
  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 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 to let me know.

License

The theme is licensed under the Creative Commons Attribution 3.0 Unported

Acknowledgements

Thanks to

  • HTML5UP for creating this theme
  • Steve Francia for creating Hugo and the awesome community around the project.

hugo-highlights-theme's People

Contributors

matthew-andrews avatar schmanat avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.