feat: adhere Hugo theme requirements (#9)

* 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

Author: nirgn975

.github/workflows/continuous-integration.yml

@@ -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

README.md

@@ -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.
 
@@ -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
 

assets/javascript/main.js

@@ -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())
@@ -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');

exampleSite/config.toml

@@ -1,4 +1,4 @@
-baseURL = "https://nirgn975.github.io/devRes/"
+baseURL = "https://example.com/"
 languageCode = "en-us"
 title = "DevRes"
 theme = "devRes"
@@ -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"

exampleSite/data/content.yaml

@@ -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
@@ -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
@@ -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]

exampleSite/static/img/profile-image.webp

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:37f848b3514fbd82f7377ae729109a928c86da5bab608d70546f9356388455cb
-size 122186390
+oid sha256:ea50c459ccc7860a38747d458ea9d5034d3d1af64fa9fbdfa992b17c23e1fff6
+size 269173034