Skip to content

Commit

Permalink
feat: adhere Hugo theme requirements (#9)
Browse files Browse the repository at this point in the history
* feat: adhere Hugo theme requirements

Fix javascript bug when jQuery didn't load yet. Change exampleSite content to lorem ipsum. Edit
README.md file and add formspree to Features sections. Add an option to enable/disable sections.

BREAKING CHANGE: Add an option to disable/enable section - changed the content yaml structure.

fix #8

* docs: fix all of the screenshots
  • Loading branch information
nirgn975 authored Jan 5, 2021
1 parent 7655e7f commit 95c2ab2
Show file tree
Hide file tree
Showing 20 changed files with 255 additions and 223 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ jobs:
extended: true

- name: Hugo Build 🚧
run: hugo --source=exampleSite --minify -v
run: |
sed -i 's/example.com/nirgn975.github.io\/devRes/g' exampleSite/config.toml
hugo --source=exampleSite --minify -v
- uses: actions/checkout@v2
- name: Set up Ruby 2.6
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# devRes Theme | Hugo

[![CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-orange.svg)](http://creativecommons.org/licenses/by/4.0/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/nirgn975/devRes)](https://github.com/nirgn975/devRes/releases) ![Continuous Deployment](https://github.com/nirgn975/devRes/workflows/Continuous%20Deployment/badge.svg?branch=main) [![Hugo](https://img.shields.io/badge/Hugo-%5E0.41.0-ff4088?logo=hugo)](https://gohugo.io/) [![Donate](https://img.shields.io/badge/PayPal-Donate-lightgrey.svg)](https://www.paypal.me/nirgn/2)
[![CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-orange.svg)](http://creativecommons.org/licenses/by/4.0/) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/nirgn975/devRes)](https://github.com/nirgn975/devRes/releases) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) ![Continuous Deployment](https://github.com/nirgn975/devRes/workflows/Continuous%20Deployment/badge.svg?branch=main) [![Hugo](https://img.shields.io/badge/Hugo-%5E0.59.0-ff4088?logo=hugo)](https://gohugo.io/) [![Donate](https://img.shields.io/badge/PayPal-Donate-lightgrey.svg)](https://www.paypal.me/nirgn/2)

> A Hugo resume theme with a Developer focus in mind.
Expand All @@ -20,6 +20,7 @@ To see this theme in action, Here is a [live demo](https://nirgn975.github.io/de
- Support [Google](https://analytics.google.com/analytics) and [Plausible](https://plausible.io) analytics.
- Optimized for Performance, Accessibility, Best Practices, and SEO: 90+ (out of 100) on mobile and desktop in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights).
- **CDN** for all third-party libraries supported.
- Automated contact form with [formspree](https://formspree.io).

## Getting started

Expand Down
8 changes: 6 additions & 2 deletions assets/javascript/main.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import * as params from '@params';

/**
*
* Get GitHub repos data.
*/
async function getReposData() {
if (!params.projects.enable) {
return;
}

for (repo of params.projects.repos) {
await fetch(`https://api.github.com/repos/${params.projects.githubUsername}/${repo.url}`)
.then(response => response.json())
Expand All @@ -21,7 +25,7 @@ async function getReposData() {
return params.projects.repos;
}

$(document).ready(function() {
document.addEventListener("DOMContentLoaded", function(event) {
const theme = localStorage.getItem('theme');
if (theme == 'dark') {
$('html').attr('data-theme', 'dark');
Expand Down
6 changes: 3 additions & 3 deletions exampleSite/config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseURL = "https://nirgn975.github.io/devRes/"
baseURL = "https://example.com/"
languageCode = "en-us"
title = "DevRes"
theme = "devRes"
Expand All @@ -24,7 +24,7 @@ themesDir = "../.."
[params.analytics]
[params.analytics.plausible]
enable = true
domain = "nir.galon.io"
domain = "johndoe.com"
[params.analytics.google]
enable = false
id = "UA-87725724-1"
id = "UA-xxxxxxxx-1"
173 changes: 92 additions & 81 deletions exampleSite/data/content.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ banner:
text: Stack Overflow

aboutMe:
enable: True
text: Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
list:
enable: True
Expand All @@ -21,88 +22,95 @@ aboutMe:
- text: It was popularised in the 1960s with the release of Letraset sheets containing.

work:
- position: Lead DevOps Engineer
employerName: Google
employerUrl: https://www.linkedin.com/company/google/
timeStart: 01/2020
timeEnd: Present
text: Nullam aliquam ornare massa. Nulla eleifend viverra velit, et vehicula metus condimentum sit amet. Aliquam erat volutpat. Nam sit amet viverra orci. Nulla rutrum facilisis massa, vel tincidunt erat. Nam ante quam, ultricies eu dignissim quis, consequat non velit.
list:
enable: True
items:
- text: a tincidunt tortor dictum non. Phasellus lobortis leo risus, at malesuada eros rutrum non.
- text: Quisque hendrerit hendrerit lectus.
- text: Aliquam erat volutpat. Nam sit amet viverra orci. Nulla rutrum facilisis.
- position: Software Engineer
employerName: Facebook
employerUrl: https://www.linkedin.com/company/facebook/
timeStart: 02/2015
timeEnd: 12/2019
text:
list:
enable: True
items:
- text: Nam ornare sollicitudin mauris quis dignissim.
- text: Mauris sed risus consectetur, rutrum urna a, dictum ex.
- text: Aenean quam augue, suscipit quis nisl ut.
- text: Donec a venenatis risus. Nullam gravida faucibus rhoncus. Fusce feugiat lectus sit amet fermentum maximus.
- text: Aliquam pharetra arcu a lectus pharetra, eget mattis orci rutrum.
- text: Duis interdum imperdiet porta.
- text: Aenean quam augue, suscipit quis nisl ut, sodales sodales quam. Duis scelerisque feugiat tellus, ut rutrum dui tempus sed. Proin at sapien lorem.
enable: True
items:
- position: Lead DevOps Engineer
employerName: Google
employerUrl: https://www.linkedin.com/company/google/
timeStart: 01/2020
timeEnd: Present
text: Nullam aliquam ornare massa. Nulla eleifend viverra velit, et vehicula metus condimentum sit amet. Aliquam erat volutpat. Nam sit amet viverra orci. Nulla rutrum facilisis massa, vel tincidunt erat. Nam ante quam, ultricies eu dignissim quis, consequat non velit.
list:
enable: True
items:
- text: a tincidunt tortor dictum non. Phasellus lobortis leo risus, at malesuada eros rutrum non.
- text: Quisque hendrerit hendrerit lectus.
- text: Aliquam erat volutpat. Nam sit amet viverra orci. Nulla rutrum facilisis.
- position: Software Engineer
employerName: Facebook
employerUrl: https://www.linkedin.com/company/facebook/
timeStart: 02/2015
timeEnd: 12/2019
text:
list:
enable: True
items:
- text: Nam ornare sollicitudin mauris quis dignissim.
- text: Mauris sed risus consectetur, rutrum urna a, dictum ex.
- text: Aenean quam augue, suscipit quis nisl ut.
- text: Donec a venenatis risus. Nullam gravida faucibus rhoncus. Fusce feugiat lectus sit amet fermentum maximus.
- text: Aliquam pharetra arcu a lectus pharetra, eget mattis orci rutrum.
- text: Duis interdum imperdiet porta.
- text: Aenean quam augue, suscipit quis nisl ut, sodales sodales quam. Duis scelerisque feugiat tellus, ut rutrum dui tempus sed. Proin at sapien lorem.

education:
- course: Deep Learning Foundations
schoolName: Udacity
schoolUrl: https://www.udacity.com
timeStart: 01/2017
timeEnd: 08/2017
text: A nanodegree program at Udacity
list:
enable: True
items:
- text: "The <a href='https://www.udacity.com/course/deep-learning-nanodegree-foundation--nd101' target='_blank'>program syllabus</a> include: Neural Networks, Convolutional Neural Networks, Recurrent Neural Networks, Generative Adversarial Networks"
- text: The 5 projects I built during the program - <a href="https://github.com/nirgn975/DLND" target="_blank">GitHub</a>
- course: Bachelor of Science (BSc) in Computer Science
schoolName: MIT - Massachusetts Institute of Technology
schoolUrl: https://www.linkedin.com/school/mit/
timeStart: 06/2011
timeEnd: 06/2014
text:
list:
enable: True
items:
- text: Major in distributed computing systems.
- text: 3.8 GPA
enable: True
items:
- course: Deep Learning Foundations
schoolName: Udacity
schoolUrl: https://www.udacity.com
timeStart: 01/2017
timeEnd: 08/2017
text: A nanodegree program at Udacity
list:
enable: True
items:
- text: "The <a href='https://www.udacity.com/course/deep-learning-nanodegree-foundation--nd101' target='_blank'>program syllabus</a> include: Neural Networks, Convolutional Neural Networks, Recurrent Neural Networks, Generative Adversarial Networks"
- text: The 5 projects I built during the program - <a href="https://github.com/nirgn975/DLND" target="_blank">GitHub</a>
- course: Bachelor of Science (BSc) in Computer Science
schoolName: MIT - Massachusetts Institute of Technology
schoolUrl: https://www.linkedin.com/school/mit/
timeStart: 06/2011
timeEnd: 06/2014
text:
list:
enable: True
items:
- text: Major in distributed computing systems.
- text: 3.8 GPA

skills:
- family: FrontEnd
items:
- icon: <span class="devicons devicons-html5"></span>
text: HTML
- icon: <span class="devicons devicons-sass"></span>
text: CSS / SCSS (Bootstrap, Material Design)
- icon: <span class="devicons devicons-nodejs_small"></span>
text: JavaScript (jQuery, Ajax)
- icon: <span class="devicons devicons-angular"></span>
text: Angular
- family: BackEnd
items:
- icon: <span class="devicons devicons-nodejs"></span>
text: Node.js (TypeScript, Express.js, NestJS, Mocha)
- icon: <span class="devicons devicons-python"></span>
text: Python (Django, Sanic)
- icon: <span class="devicons devicons-go"></span>
text: Golang
- family: Platforms
items:
- icon: <span class="devicons devicons-linux"></span>
text: Linux
- icon: <span class="devicons devicons-git"></span>
text: Git
- icon: <span class="devicons devicons-github_badge"></span>
text: GitHub
enable: True
items:
- family: FrontEnd
items:
- icon: <span class="devicons devicons-html5"></span>
text: HTML
- icon: <span class="devicons devicons-sass"></span>
text: CSS / SCSS (Bootstrap, Material Design)
- icon: <span class="devicons devicons-nodejs_small"></span>
text: JavaScript (jQuery, Ajax)
- icon: <span class="devicons devicons-angular"></span>
text: Angular
- family: BackEnd
items:
- icon: <span class="devicons devicons-nodejs"></span>
text: Node.js (TypeScript, NestJS, Mocha)
- icon: <span class="devicons devicons-python"></span>
text: Python (Django, Sanic)
- icon: <span class="devicons devicons-go"></span>
text: Golang
- family: Platforms
items:
- icon: <span class="devicons devicons-linux"></span>
text: Linux
- icon: <span class="devicons devicons-git"></span>
text: Git
- icon: <span class="devicons devicons-github_badge"></span>
text: GitHub

projects:
enable: True
githubUsername: nirgn975
repos:
- url: generator-jekyll-starter-kit
Expand All @@ -113,16 +121,19 @@ projects:
name: Developer Resume

blog:
enable: False
url: https://lifelongstudent.io
sitemapUrl: https://lifelongstudent.io/index.xml
numberOfPosts: 2

talks:
- title: "The future of blogging is with Hugo"
cover: img/talks/hugo-blogging.webp
date: 4/12/19
meetupUrl: https://www.meetup.com
downloadLink: https://github.com/nirgn975/devRes
enable: True
items:
- title: "The future of blogging is with Hugo"
cover: img/talks/hugo-blogging.webp
date: 4/12/19
meetupUrl: https://www.meetup.com
downloadLink: https://github.com/nirgn975/devRes

contact:
formspreeUrl: https://formspree.io/[email protected]
Binary file modified exampleSite/static/img/profile-image.webp
Binary file not shown.
Binary file added images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions images/screenshot.psd
Git LFS file not shown
Binary file modified images/screenshot.webp
Binary file not shown.
Binary file added images/tn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 0 additions & 7 deletions layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,12 @@
</div>
<div class="content uk-width-3-4@m">
{{ partial "_about-me.html" . }}
<hr>
{{ partial "_work.html" . }}
<hr>
{{ partial "_education.html" . }}
<hr>
{{ partial "_skills.html" . }}
<hr>
{{ partial "_projects.html" . }}
<hr>
{{ partial "_blog.html" . }}
<hr>
{{ partial "_talks.html" . }}
<hr>
{{ partial "_contact.html" . }}
</div>
</div>
Expand Down
33 changes: 18 additions & 15 deletions layouts/partials/_about-me.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
<div class="about-me">
<span class="category-header">
<i class="fas fa-user fa-2x"></i>
<h2>About Me</h2>
<button class="uk-icon-button" uk-icon="paint-bucket" type="button" onClick="switchTheme(this)" aria-label="Switch Theme"></button>
</span>
{{ if .Site.Data.content.aboutMe.enable }}
<div class="about-me">
<span class="category-header">
<i class="fas fa-user fa-2x"></i>
<h2>About Me</h2>
<button class="uk-icon-button" uk-icon="paint-bucket" type="button" onClick="switchTheme(this)" aria-label="Switch Theme"></button>
</span>

<div>
<p>{{ .Site.Data.content.aboutMe.text | safeHTML }}</p>
{{ if .Site.Data.content.aboutMe.list.enable }}
<ul>
{{ range .Site.Data.content.aboutMe.list.items }}
<li>{{ .text }}</li>
<div>
<p>{{ .Site.Data.content.aboutMe.text | safeHTML }}</p>
{{ if .Site.Data.content.aboutMe.list.enable }}
<ul>
{{ range .Site.Data.content.aboutMe.list.items }}
<li>{{ .text }}</li>
{{ end }}
</ul>
{{ end }}
</ul>
{{ end }}
</div>
</div>
</div>
<hr>
{{ end }}
17 changes: 10 additions & 7 deletions layouts/partials/_blog.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<div class="blog">
<span class="category-header">
<i class="fas fa-pencil-alt fa-2x"></i>
<h2>Recent Blog Posts</h2>
</span>
{{ if .Site.Data.content.blog.enable }}
<div class="blog">
<span class="category-header">
<i class="fas fa-pencil-alt fa-2x"></i>
<h2>Recent Blog Posts</h2>
</span>

<div class="posts uk-grid-match uk-child-width-1-2@s uk-child-width-1-4@xl" uk-grid></div>
</div>
<div class="posts uk-grid-match uk-child-width-1-2@s uk-child-width-1-4@xl" uk-grid></div>
</div>
<hr>
{{ end }}
Loading

0 comments on commit 95c2ab2

Please sign in to comment.