archetypes | ||
assets/css | ||
exampleSite | ||
images | ||
layouts | ||
resources/_gen/assets/scss/css | ||
static | ||
.editorconfig | ||
.gitignore | ||
config.yaml | ||
LICENSE | ||
README.md | ||
theme.toml |
!! Breaking Changes !!
Thanks to @raphendyr, we can now add more than one page and change order of the sections. Also, there are tons of refactoring which made the theme more modular.
If you are already using a previous version of the theme, you will get an ERROR after this update. Don't worry. The solution is very easy. You just need to edit projects.yaml
, features.yaml
and config.yaml
since their structure has changed. After that, all should be fine.
Features
- Simple, easy to use, single or multi page, A4-sized Resume generator.
- Print friendly, just use your browser or save as PDF.
- Write your resume in yaml. All content stored in data files.
- Add/Remove sections order change section orders by editing
config.yaml
. - Section names are configurable in
config.yaml
. So, you can write in any language you want.
Here is a blog post about this project.
How To Use
Download
- Create a hugo project.
- Go to themes folder.
- Clone this theme.
cd themes
git clone https://gitlab.com/mertbakir/resume-a4.git
or add as a submodule
git submodule add https://gitlab.com/mertbakir/resume-a4.git themes/resume-a4
Start
- Copy
config.yaml
fromexampleSite
to the root directory of your hugo project. - Open
config.yaml
and add your relevant information. - Copy
data
folder fromexampleSite
to the root directory of your hugo project. All you need is that folder. - Create your resume in yaml files.
Config File
- You can add/remove sections.
- Add multiple pages as many as you like. (still, let's not forget the aim here. a resume should be precise. I don't think a recruiter will scroll down on it.)
- Order of the "features" are important in the config file.
Custom CSS
Copy the \assets
folder under the exampleSite
directory if you like to make simple modifications.
Avatar
Set avatar link in config.yaml
, you may keep the image under static
folder.
Publications
You can change style
of the publications
feature in the config file. There are options for APA and IEEE standards. Report me on gitlab or send a merge requests if standarts are erroneous. I'm no expert on citation standarts.
License
This project is open-sourced and licensed under the terms of the MIT license. I would be happy though, if you give attribution. <3
I'm open to suggestions and contributions.
My Work Flow
- Make changes.
- Delete
resources
folder in main project. - Build your hugo site using the theme.
hugo server
- Copy
resources
folder from main project to theme folderthemes\resume-A4\resources
git commit
andgit push
.