Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
aerohub committed Sep 26, 2016
0 parents commit 8484b27
Show file tree
Hide file tree
Showing 223 changed files with 44,293 additions and 0 deletions.
20 changes: 20 additions & 0 deletions LICENSE.md
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2016 [Pavel Kanyshev](//github.com/aerohub)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
93 changes: 93 additions & 0 deletions README.md
@@ -0,0 +1,93 @@
# Hugo Orbit Theme

This is a Hugo port of [Orbit](//github.com/xriley/Orbit-Theme) - great looking resume/CV template designed for developers by Xiaoying Riley.

## Screenshot

![Orbit screenshot](https://raw.githubusercontent.com/aerohub/hugo-orbit-theme/master/images/screenshot.png)

## Features

### Original

- Fully Responsive
- HTML5 + CSS3
- Built on Bootstrap 3
- 6 Colour Schemes
- FontAwesome icons
- **LESS** files included
- Compatible with all modern browsers

### Added

- Google Analytics
- Print format improvements from [PR](//github.com/xriley/Orbit-Theme/pull/3)

## Demo

You can see it in action on [Hugo Themes site](http://themes.gohugo.io/theme/hugo-orbit-theme/).

## Contents

- [Installation](#installation)
- [Getting started](#getting-started)
- [Copying files](#copying-files)
- [Configuring](#configuring)
- [Test your site](#test-your-site)
- [Build your site](#build-your-site)
- [Contributing](#contributing)
- [License](#license)


## Installation

Inside the folder of your new Hugo site run:

$ mkdir themes
$ cd themes
$ git clone https://github.com/aerohub/hugo-orbit-theme

For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.


## Getting started

After installing the theme successfully it requires a just a few more steps to get your resume running.

### Copying files

Take a look inside the [`exampleSite`](//github.com/aerohub/hugo-orbit-theme/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](//github.com/aerohub/hugo-orbit-theme/blob/master/exampleSite/config.toml). To start just copy the `config.toml` into the root folder of your Hugo site.

### Configuring

Open your just-copied `config.toml` and fill it with your data. All the page content may be configured throw one file.

### Test your site

In order to see your site in action, run Hugo's built-in local server.

$ hugo server -w

Now enter `localhost:1313` in the address bar of your browser.

### Build your site

Just run

$ hugo

You'll find your resume files in `public` folder in the root of Hugo project.

## Contributing

Did you found a bug or got an idea? Feel free to use the [issue tracker](//github.com/aerohub/hugo-orbit-theme/issues). Or make directly a [pull request](//github.com/aerohub/hugo-orbit-theme/pulls).

## License

The original template is released under the Creative Commons Attribution 3.0 License. Please keep the original attribution link when using for your own project. If you'd like to use the template without the attribution, you can check out other license options via template author's website: themes.3rdwavemedia.com

As for Hugo port you may rewrite the "Ported for..." line with setting your name in the end of `config.toml`

[params.footer]
copyright = ""

2 changes: 2 additions & 0 deletions archetypes/default.md
@@ -0,0 +1,2 @@
+++
+++
Empty file added exampleSite/archetypes/.gitkeep
Empty file.
232 changes: 232 additions & 0 deletions exampleSite/config.toml
@@ -0,0 +1,232 @@
# Page settings

baseurl = "http://replace-this-with-your-hugo-site.com/"
languageCode = "en-us"
title = "John Doe Resume"
theme = "hugo-orbit-theme"
googleAnalytics = "UA-XXXXXXX-Y"

# Do not build files for websites. Need them? Set to false
disableRSS = true
disableSitemap = true
disable404 = true

[params]

# Meta
description = "Hugo Responsive Resume/CV Theme for Developers"
author = "Pavel Kanyshev"

# Theme styles

# The original template comes with 6 colour schemes. You may choose styles below.
# "styles.css", "styles-2.css", "styles-3.css", "styles-4.css", "styles-5.css", "styles-6.css"
# are available. Also the source LESS files are included so
# it’s quick and easy to change the styling and colour scheme.

styles = "styles.css"

# Sidebar sections

# Profile section
[params.profile]
name = "John Doe"
tagline = "Full Stack Developer"
avatar = "profile.png"

# Contact section
[params.contact]
enable = true

[[params.contact.list]]
class = "email"
icon = "fa-envelope"
url = "mailto: yourname@email.com"
title = "john.doe@website.com"

[[params.contact.list]]
class = "phone"
icon = "fa-phone"
url = "tel:+1234567890"
title = "+1234567890"

[[params.contact.list]]
class = "website"
icon = "fa-globe"
url = "//portfoliosite.com"
title = "portfoliosite.com"

[[params.contact.list]]
class = "linkedin"
icon = "fa-linkedin"
url = "//linkedin.com/in/johndoe"
title = "linkedin.com/in/johndoe"

[[params.contact.list]]
class = "github"
icon = "fa-github"
url = "//github.com/username"
title = "github.com/username"

[[params.contact.list]]
class = "twitter"
icon = "fa-twitter"
url = "//twitter.com/username"
title = "@twittername"

# Education section
[params.education]
enable = true
title = "Education"

[[params.education.list]]
degree = "MSc in Computer Science"
college = "University of London"
dates = "2006 - 2010"

[[params.education.list]]
degree = "BSc in Applied Mathematics"
college = "Bristol University"
dates = "2007 - 2011"

# Languages section
[params.languages]
enable = true
title = "Languages"

[[params.languages.list]]
language = "English"
level = "Native"

[[params.languages.list]]
language = "French"
level = "Professional"

[[params.languages.list]]
language = "Russian"
level = "Professional"

# Interests section
[params.interests]
enable = true
title = "Interests"

[[params.interests.list]]
interest = "Climbing"

[[params.interests.list]]
interest = "Snowboarding"

[[params.interests.list]]
interest = "Cooking"

# Main body sections

# You may use markdown in summary, details and intro fields. But don't overdose, it's resume!:)

# Summary section
[params.summary]
enable = true
icon = "fa-user"
title = "Career Profile"
summary = "**Summarise your career here** lorem ipsum dolor sit amet, consectetuer adipiscing elit. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu."

# Experiences section
[params.experiences]
enable = true
icon = "fa-briefcase"
title = "Experiences"

[[params.jobs.list]]
position = "Lead Developer"
dates = "2015 - Present"
company = "Startup Hubs, San Francisco"
details = "**Describe your role here** lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo.\n\n Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo."

[[params.jobs.list]]
position = "Senior Software Engineer"
dates = "2014 - 2015"
company = "Google, London"
details = "**Describe your role here** lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem."

[[params.jobs.list]]
position = "UI Developer"
dates = "2012 - 2014"
company = "Amazon, London"
details = "**Describe your role here** lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem."

# Projects section
[params.projects]
enable = true
icon = "fa-archive"
title = "Projects"
intro = "**You can list your side projects or open source libraries in this section.** Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum et ligula in nunc bibendum fringilla a eu lectus"

[[params.projects.list]]
title = "Hugrid"
url = "https://github.com/aerohub/hugrid"
tagline = "Grid theme for Hugo. It's a kind of boilerplate to perform anyone or anything quickly. It's a kind of boilerplate to perform anyone or anything quickly. Portfolio, collection, bookmarks, contacts and so on"

[[params.projects.list]]
title = "Simple FAQ Theme for Hugo"
url = "https://github.com/aerohub/hugo-me-theme"
tagline = "Simple FAQ Theme for Hugo. You may use this theme for building very simple FAQs or note lists."

[[params.projects.list]]
title = "Hugo Identity"
url = "https://github.com/aerohub/hugo-identity-theme"
tagline = "Little profile/card-style template for Hugo."

[[params.projects.list]]
title = "Orbit"
url = "https://github.com/aerohub/hugo-orbit-theme"
tagline = "Hugo Resume/CV Theme for Developers."

[[params.projects.list]]
title = "Me"
url = "https://github.com/aerohub/hugo-me-theme"
tagline = "A simple responsive Hugo theme for personal site."

# Skills section
[params.skills]
enable = true
icon = "fa-rocket"
title = "Skills & Proficiency"

[[params.skills.list]]
skill = "Python & Django"
level = "98%"

[[params.skills.list]]
skill = "Javascript & jQuery"
level = "98%"

[[params.skills.list]]
skill = "Angular"
level = "95%"

[[params.skills.list]]
skill = "HTML5 & CSS"
level = "95%"

[[params.skills.list]]
skill = "Ruby on Rails"
level = "75%"

[[params.skills.list]]
skill = "Sketch & Photoshop"
level = "60%"

# Footer section

# The original template is released under the Creative Commons Attribution 3.0 License.
# Please keep the original attribution link when using for your own project.
# If you'd like to use the template without the attribution,
# you can check out other license options via template author's website: themes.3rdwavemedia.com
#
# As for Hugo port you may rewrite the "Ported for..." line with setting your name below.

[params.footer]
copyright = ""


Empty file added exampleSite/content/.gitkeep
Empty file.

0 comments on commit 8484b27

Please sign in to comment.