Port of Startbootstrap's Freelancer theme to Hugo
JavaScript HTML CSS
Switch branches/tags
Nothing to show
Clone or download

README.md

Freelancer Theme

Freelancer Theme is a one page freelancer portfolio based on the original Bootstrap theme by David Miller and on Jerome Lachaud's Jekyll theme. This Hugo theme features several content sections, a responsive portfolio grid with hover effects, full page portfolio item modals and a contact form.

Hugo Freelancer Theme screenshot

Installation

Inside the folder of your Hugo site run:

$ cd themes
$ git clone https://github.com/digitalcraftsman/hugo-freelancer-theme

For more information read the official setup guide of Hugo.

Getting started

After installing the Freelancer Theme successfully it requires a just a 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. It contains detailed information about the setup of the contact form (or see below) and the customization of all strings in this theme.

To use it, copy the config.toml in the root folder of your Hugo site. Feel free to change strings as you like.

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 from formspree.io
  5. You're done. Happy mailing!

Add social networks

In the footer you can link some of your social network accounts. Search for [params.footer.social.networks] at the bottom of the file. The configuration should look similar to this one:

[[params.footer.social.networks]]
    icon = "fa-github"
    link = "//github.com/spf13/hugo"

The variable 'icon' represents the shown icon of the social network. It's a CSS class of Fontawesome's popular icon font. Search here if you need a particular icon.

Create your portfolio

Beside the config file, there is in data another subfolder called projects which hosts the files that will appear as your projects in the portfolio section. Such a project file might look like this one written in YAML:

modalID: 1
title: Project Cabin
date: 2014-07-13
img: cabin.png
client: Start Bootstrap
clientLink: "#"
category: Web Development
description: Use this area of the page to describe your project. The icon above is part of a free icon set by [Flat Icons](//sellfy.com/p/8Q9P/jV3VZ/"). On their website, you can download their free set with 16 icons, or you can purchase the entire set with 146 icons for only $12!

Copy the folder projects inside the data folder in the root directory of your site. Let's make some changes to show your work.

Pay attention to the modalID. It must be a unique integer and be incremented with each new project you want to add to the portfolio. Otherwise, the corresponding modal can't be rendered.

Furthermore, you can use Markdown syntax for URLs like here [text](//url.to/source) in the description. Copy the image of an project inside static/img/portfolio and just enter the filename.

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 a new feature? Feel free to use the issue tracker to let me know. Or make directly a pull request.

License

This theme is released under the Apache License 2.0 For more information read the License.

Annotations

Thanks to Steve Francia for creating Hugo and the awesome community around the project.