Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/suyundukov/hugo-vitae

🐻 Personal curriculum vitae or resume theme for Hugo
https://github.com/suyundukov/hugo-vitae

hugo hugo-theme

Last synced: about 1 month ago
JSON representation

🐻 Personal curriculum vitae or resume theme for Hugo

Awesome Lists containing this project

README

        

![Vitae - Logo][logo]

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [With `git`](#with-git)
- [Manual](#manual)
- [Quick start](#quick-start)
- [Features](#features)
- [Google Analytics](#google-analytics)
- [About](#about)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)

********************

![Vitar Screen][screenshot]

********************

Vitae Live Demo

## Installation

#### With `git`

From the root of your Hugo site, clone the theme into `themes/hugo-vitae` by running :
```
git clone https://github.com/nurlansu/hugo-vitae.git themes/hugo-vitae
```

#### Manual

1. [Download][zip-archive] zip archive.
2. Unarchive it.
3. Move `hugo-vitae` folder in `themes` folder of your site

For more information read the official [setup guide][hugo-guide] of Hugo.

## Quick start

After installation, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation. Edit the site attributes in `config.toml and edit the various entries in `layouts/partials/.

```
exampleSite
β”œβ”€β”€ config.toml
β”œβ”€β”€ data
β”‚ β”œβ”€β”€ education.yml
β”‚ β”œβ”€β”€ employment.yml
β”‚ β”œβ”€β”€ hobbies.yml
β”‚ β”œβ”€β”€ initiatives.yml
β”‚ └── skills.yml
└── static
└── img
└── profile.png
```

Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.

Hugo includes a development server, so you can view your changes as you go -
very handy. Spin it up with the following command:

``` sh
hugo serve
```

Now you can go to [localhost:1313][local] and the Vitae
theme should be visible.

## Features

### Google Analytics

To add Google Analytics, simply sign up to [Google Analytics][g-analytics] to obtain your Google Tracking ID, and add this tracking ID to the `googleAnalytics` parameter in `config.toml`.

## About

This is a port of the Jekyll theme [Vitae][vitae-jekyll] by [FΓ‘bio Madeira][vitae-author]. It supports most of the features of the original theme.

## Contributing

Pull requests, bug fixes, and new features are welcome!

1. Fork the repository
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -a -m 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request on GitHub

## Changelog

> Version 1.0

- Initial release

## License



MIT

[logo]: https://suyundukov.com/cdn/vitae.png
[screenshot]: https://suyundukov.com/cdn/vitae-screen.png
[hugo]: https://gohugo.io/
[gh-pages]: https://pages.github.com/
[zip-archive]: https://github.com/nurlansu/hugo-vitae/archive/master.zip
[hugo-guide]: https://gohugo.io/overview/installing/
[local]: http://localhost:1313/
[g-analytics]: https://www.google.com/analytics/
[vitae-jekyll]: https://github.com/biomadeira/vitae/
[vitae-author]: https://github.com/biomadeira/