Update README, Change config toml to yaml.
This commit is contained in:
parent
00eb0180d5
commit
b7f40fd3f7
9 changed files with 88 additions and 102 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -37,4 +37,3 @@ Thumbs.db
|
||||||
|
|
||||||
# Local
|
# Local
|
||||||
/_local
|
/_local
|
||||||
/resources/
|
|
||||||
|
|
39
README.md
39
README.md
|
@ -1,10 +1,18 @@
|
||||||
|
# !! Breaking Changes !!
|
||||||
|
|
||||||
|
Thanks to [@raphendyr](https://gitlab.com/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
|
# Features
|
||||||
|
|
||||||
* Simple, easy to use, single or multi page, A4-sized Resume generator.
|
* Simple, easy to use, single or multi page, A4-sized Resume generator.
|
||||||
* Print friendly, just use your browser or save as PDF.
|
* Print friendly, just use your browser or save as PDF.
|
||||||
* Write your resume in yaml. All content stored in data files.
|
* Write your resume in yaml. All content stored in data files.
|
||||||
* Remove/Add sections from `config.toml`.
|
* Add/Remove sections order change section orders by editing `config.yaml`.
|
||||||
* Section names are configurable in `config.toml`. So, you can write in any language you want.
|
* Section names are configurable in `config.yaml`. So, you can write in any language you want.
|
||||||
|
|
||||||
|
[Here is a blog post](https://mertbakir.gitlab.io/projects/resume-a4/) about this project.
|
||||||
|
|
||||||
# How To Use
|
# How To Use
|
||||||
|
|
||||||
|
@ -19,7 +27,7 @@ cd themes
|
||||||
git clone https://gitlab.com/mertbakir/resume-a4.git
|
git clone https://gitlab.com/mertbakir/resume-a4.git
|
||||||
```
|
```
|
||||||
|
|
||||||
or add ass a submodule
|
or add as a submodule
|
||||||
|
|
||||||
```
|
```
|
||||||
git submodule add https://gitlab.com/mertbakir/resume-a4.git themes/resume-a4
|
git submodule add https://gitlab.com/mertbakir/resume-a4.git themes/resume-a4
|
||||||
|
@ -27,19 +35,26 @@ git submodule add https://gitlab.com/mertbakir/resume-a4.git themes/resume-a4
|
||||||
|
|
||||||
## Start
|
## Start
|
||||||
|
|
||||||
1. Copy `config.toml` from `exampleSite` to the root directory of your hugo project.
|
1. Copy `config.yaml` from `exampleSite` to the root directory of your hugo project.
|
||||||
2. Open `config.toml` and add your relevant information.
|
2. Open `config.yaml` and add your relevant information.
|
||||||
3. Copy `data` folder from `exampleSite` to the root directory of your hugo project. All you need is that folder.
|
3. Copy `data` folder from `exampleSite` to the root directory of your hugo project. All you need is that folder.
|
||||||
4. Create your resume in yaml files.
|
4. Create your resume in yaml files.
|
||||||
|
|
||||||
## Notes
|
## Config File
|
||||||
|
|
||||||
* Add/Remove sections in `config.toml`
|
* You can add/remove sections.
|
||||||
* Set avatar link in `config.toml`, keep your image under `static` folder if you want.
|
* 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._)
|
||||||
* You can change `style` of the `publications` feature in the config file.
|
* Order of the "features" are important in the config file.
|
||||||
I've created options for APA and IEEE standards.
|
|
||||||
You can add more standards to `section-publications.html` file in the `layouts\partials` folder if you are looking for something else.
|
### Custom CSS
|
||||||
* [Here is the blog post](https://mertbakir.gitlab.io/projects/resume-a4/) about this project.
|
|
||||||
|
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
|
# License
|
||||||
|
|
||||||
|
|
|
@ -51,8 +51,6 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
.item-title {}
|
|
||||||
|
|
||||||
footer {
|
footer {
|
||||||
display: none;
|
display: none;
|
||||||
}
|
}
|
||||||
|
|
|
@ -69,7 +69,6 @@
|
||||||
|
|
||||||
.job-title {
|
.job-title {
|
||||||
font-size: 14px;
|
font-size: 14px;
|
||||||
font-style: italic;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.date {
|
.date {
|
||||||
|
|
|
@ -1,18 +1,8 @@
|
||||||
baseURL = "/"
|
baseURL: "/"
|
||||||
languageCode = "en-us"
|
languageCode: "en-us"
|
||||||
title = "Resume | MERT BAKIR"
|
title: "Resume | MERT BAKIR"
|
||||||
disableKinds = ["taxonomy", "term", "page", "section", "RSS", "sitemap", "robotsTXT", "404"]
|
disableKinds: ["taxonomy", "term", "page", "section", "RSS", "sitemap", "robotsTXT", "404"]
|
||||||
theme = "resume-a4"
|
theme: "resume-a4"
|
||||||
|
|
||||||
[params]
|
|
||||||
useFontAwesome = true
|
|
||||||
css = [ "custom.scss" ]
|
|
||||||
|
|
||||||
[params.header]
|
|
||||||
avatar = "avatar.jpg"
|
|
||||||
contact = true
|
|
||||||
tagline = true
|
|
||||||
links = true
|
|
||||||
|
|
||||||
# Construct main column, side column and additional page from features
|
# Construct main column, side column and additional page from features
|
||||||
# Every column and page may include any features. Some features are
|
# Every column and page may include any features. Some features are
|
||||||
|
@ -55,73 +45,52 @@ links = true
|
||||||
# groupName: title of the group
|
# groupName: title of the group
|
||||||
# list: list of strings rendered under the group
|
# list: list of strings rendered under the group
|
||||||
|
|
||||||
# Side panel
|
params:
|
||||||
|
useFontAwesome: true
|
||||||
|
css:
|
||||||
|
- custom.scss
|
||||||
|
header:
|
||||||
|
avatar: avatar.jpg
|
||||||
|
contact: true
|
||||||
|
tagline: true
|
||||||
|
links: false
|
||||||
|
side:
|
||||||
|
- feature: languages
|
||||||
|
- feature: skills
|
||||||
|
widget: word-list
|
||||||
|
style: compact # list, compact, title-list
|
||||||
|
- feature: education
|
||||||
|
- feature: interests
|
||||||
|
widget: word-list
|
||||||
|
style: list
|
||||||
|
pages:
|
||||||
|
- features:
|
||||||
|
- feature: about
|
||||||
|
title: About Me
|
||||||
|
- feature: experience
|
||||||
|
- features:
|
||||||
|
- feature: projects
|
||||||
|
collection: projects
|
||||||
|
- feature: publications
|
||||||
|
style: IEEE # IEEE, APA, else
|
||||||
|
- feature: awards
|
||||||
|
- feature: certificates
|
||||||
|
title: Certifications
|
||||||
|
- feature: interests
|
||||||
|
widget: word-list
|
||||||
|
style: list
|
||||||
|
|
||||||
[[params.side]]
|
footer:
|
||||||
feature = "education"
|
show: true
|
||||||
|
credits: true
|
||||||
[[params.side]]
|
footnote: >-
|
||||||
feature = "languages"
|
You can print this resume in A4 size or save as pdf. | Last update on 2020-09-01.
|
||||||
|
links:
|
||||||
[[params.side]]
|
- prefix: Contact me on
|
||||||
feature = "skills"
|
title: Linkedin
|
||||||
widget = "word-list"
|
url: 'https://linkedin.com/in/mertbakir/'
|
||||||
style = "title-list" # list, compact, title-list
|
icon: fab fa-linkedin
|
||||||
|
- prefix: Check out my
|
||||||
[[params.side]]
|
title: Website
|
||||||
feature = "interests"
|
url: 'https://mertbakir.gitlab.io/about/'
|
||||||
widget = "word-list"
|
icon: fas fa-globe
|
||||||
style = "list" # list, compact, title-list
|
|
||||||
|
|
||||||
|
|
||||||
# First Page
|
|
||||||
|
|
||||||
[[params.pages]]
|
|
||||||
[[params.pages.features]]
|
|
||||||
feature = "about"
|
|
||||||
title = "About Me"
|
|
||||||
|
|
||||||
[[params.pages.features]]
|
|
||||||
feature = "experience"
|
|
||||||
|
|
||||||
|
|
||||||
# Additional Pages
|
|
||||||
|
|
||||||
[[params.pages]]
|
|
||||||
[[params.pages.features]]
|
|
||||||
feature = "projects"
|
|
||||||
collection = "projects"
|
|
||||||
|
|
||||||
[[params.pages.features]]
|
|
||||||
feature = "publications"
|
|
||||||
style = "IEEE" # IEEE, APA, else
|
|
||||||
|
|
||||||
[[params.pages.features]]
|
|
||||||
feature = "awards"
|
|
||||||
|
|
||||||
[[params.pages.features]]
|
|
||||||
feature = "certificates"
|
|
||||||
title = "Certifications"
|
|
||||||
|
|
||||||
|
|
||||||
# Footer
|
|
||||||
|
|
||||||
[params.footer]
|
|
||||||
show = true
|
|
||||||
credits = true
|
|
||||||
footnote = "You can print this resume in A4 size or save as pdf. | Last update on 2020-09-01."
|
|
||||||
|
|
||||||
[[params.footer.links]]
|
|
||||||
prefix = "Contact me on"
|
|
||||||
title = "Linkedin"
|
|
||||||
url = "https://linkedin.com/in/mertbakir/"
|
|
||||||
icon = "fab fa-linkedin"
|
|
||||||
|
|
||||||
[[params.footer.links]]
|
|
||||||
prefix = "Check out my"
|
|
||||||
title = "Website"
|
|
||||||
url = "https://mertbakir.gitlab.io/about/"
|
|
||||||
icon = "fas fa-globe"
|
|
||||||
|
|
||||||
|
|
||||||
# p.s. if you know YAML, then you should use that for this file.
|
|
|
@ -13,3 +13,7 @@ main.paper {
|
||||||
//line-height: 1.5;
|
//line-height: 1.5;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.job_title {
|
||||||
|
// font-style: italic;
|
||||||
|
}
|
|
@ -13,5 +13,5 @@ projects:
|
||||||
Bring CI/CD to your resume using YAML and Git."
|
Bring CI/CD to your resume using YAML and Git."
|
||||||
links:
|
links:
|
||||||
- title: Available in GitLab
|
- title: Available in GitLab
|
||||||
utl: https://gitlab.com/mertbakir/resume-a4
|
url: https://gitlab.com/mertbakir/resume-a4
|
||||||
icon: fab fa-gitlab
|
icon: fab fa-gitlab
|
||||||
|
|
File diff suppressed because one or more lines are too long
|
@ -0,0 +1 @@
|
||||||
|
{"Target":"css/main.min.ce35efa31d5a9b210d2d8611078223c82ed49d6f51a468abfe9c6445cabc56ef.css","MediaType":"text/css","Data":{"Integrity":"sha256-zjXvox1amyENLYYRB4IjyC7UnW9RpGir/pxkRcq8Vu8="}}
|
Loading…
Reference in a new issue