jekyll-bootstrap-resume-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f843e9a9a0258058a96159909886f946c9777c70ca9c4ed1dab34573fe0557b
+  data.tar.gz: 4cb756139b59134eaf6eac46cb4fd4a27e5fa014f016741e106665cab40704ca
+SHA512:
+  metadata.gz: 2553ee1c1e8f1491b2ba23478e95432aeba5b8847df042dd4642395a23bf04bb50daa91e6a55f385964bcb94c06cb7fb7245650c5b43e596af4a917dea0d764f
+  data.tar.gz: 32b602ae0a7262c0473a0ccd84902952fc0910ebbf0ca1c07c674f7c7d10bad13020376ed879fc8e685058a5213b778c779460870ac6bec3c1d42ee011248758

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Noah Scharrenberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,172 @@
+# jekyll-bootstrap-resume-theme
+
+This is a resume theme based on [Start Bootstrap Resume](https://github.com/startbootstrap/startbootstrap-resume).
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-bootstrap-resume-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-bootstrap-resume-theme
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-bootstrap-resume-theme
+
+## Usage
+
+### Change Basic information
+in `_config.yml` you can change basic information such as your website name and description.
+
+### Change Profile Picture
+Change your profile picture (the one that is visible on the side menu) by replacing the image present in `assets/img/profile.jpg` with your own picture. Make sure it is in `jpg` format and has the name `profile`.
+
+### Changing Profile information
+Change your name, email, address, phonenumber, by going to `_config.yml` and giving new values to each item under `portfolio.info`.
+
+This should look something like:
+```yaml
+portfolio:
+  info:
+    name:
+      firstname: John
+      lastname: Doe
+    location: 3542 Berry Street · Cheyenne Wells, CO 80810
+    phonenumber: (317) 585-8468
+    email: name@email.com
+```
+
+### Changing Social Media
+At the moment 5 icons are supported: LinkedIn, Github, Facebook, Twitter and Custom Site.
+
+These can be enabled/disabled and links can be changed by uncommenting and changing the text in `_config.yml` under `portfolio.social`.
+So let's say you want to only have linkedIn and github enabled then you'd have something like this:
+```yaml
+portfolio:
+  social:
+    # twitter: your-username
+    # facebook: your-username
+    github: your-username
+    linkedin: your-username
+    # rss: 'your-website'
+```
+
+Where `your-username` and `your-website` would be either your username or your website url.
+If a `#` is present before the item, then the item is commented, and won't be displayed on the website.
+
+### Changing About information
+Change the introduction text in the `About` section by going to `index.md` and changing the text with whatever text you want to have.
+
+Important: DO NOT REMOVE THE BELOW TEXT FROM THE `index.md` file.
+```
+---
+# Feel free to add content and custom Front Matter to this file.
+# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
+layout: resume
+---
+```
+
+### Experience, Education, Projects, etc...
+Sections such as experience, education and projects are handled through so called `data files`.
+These files can be found in the `_data` directory, and each section has its own file.
+
+Below tables will be shown with each section and the possible fields.
+
+#### Experience
+File name: `_data/jobs.json`
+
+| field name     | data type | format     | required  |
+|----------------|-----------|------------|-----------|
+| function       | text      | ""         | yes       |
+| company        | text      | ""         | yes       |
+| start_date     | date      | dd-mm-yyyy | yes       |
+| end_date       | date      | dd-mm-yyyy | no        |
+| description    | text      | ""         | no        |
+
+#### Education
+File name: `_data/studies.json`
+
+| field name     | data type | format     | required  |
+|----------------|-----------|------------|-----------|
+| course         | text      | ""         | yes       |
+| school         | text      | ""         | yes       |
+| degree         | text      | ""         | no        |
+| start_date     | date      | dd-mm-yyyy | yes       |
+| end_date       | date      | dd-mm-yyyy | no        |
+| description    | text      | ""         | no        |
+
+#### Volunteering Work
+File name: `_data/volunteers.json`
+
+| field name     | data type | format     | required  |
+|----------------|-----------|------------|-----------|
+| function       | text      | ""         | yes       |
+| company        | text      | ""         | yes       |
+| start_date     | date      | dd-mm-yyyy | yes       |
+| end_date       | date      | dd-mm-yyyy | no        |
+| description    | text      | ""         | no        |
+
+#### Projects
+File name: `_data/projects.json`
+
+| field name          | data type | format     | required  |
+|---------------------|-----------|------------|-----------|
+| title               | text      | ""         | yes       |
+| stakeholders        | text      | ""         | no        |
+| start_date          | date      | dd-mm-yyyy | yes       |
+| end_date            | date      | dd-mm-yyyy | no        |
+| description         | text      | ""         | no        |
+
+#### Awards
+File name: `_data/awards.json`
+
+Just an array of strings.
+
+```
+[
+  "This is an Award",
+  "This is another award"
+]
+```
+
+#### Skills
+File name: `_data/skills.json`
+
+Just an array of strings.
+
+```
+[
+  "Java",
+  "C#",
+  "VueJS"
+]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `jekyll-bootstrap-resume-theme.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_config.yml

@@ -0,0 +1,41 @@
+title: Your Portfolio
+author:
+  name: Your Name
+  email: your-email@domain.com
+description: > # this means to ignore newlines until "show_excerpts:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+show_excerpts: false # set to true to show excerpts on the homepage
+portfolio:
+  info:
+    name:
+      firstname: John
+      lastname: Doe
+    location: 3542 Berry Street · Cheyenne Wells, CO 80810
+    phonenumber: (317) 585-8468
+    email: name@email.com
+  social:
+    # twitter: jekyllrb
+    # facebook: jekyll
+    github: jekyll
+    linkedin: jekyll
+    # rss: 'https://jekyllrb.com'
+
+
+# Minima date format
+# refer to https://shopify.github.io/liquid/filters/date/ if you want to customize this
+jekyll-bootstrap-resume-theme:
+  date_format: "%b %-d, %Y"
+
+# If you want to link only specific pages in your header, uncomment
+# this and add the path to the pages in order as they should show up
+#header_pages:
+# - about.md
+
+# Build settings
+theme: jekyll-bootstrap-resume-theme
+
+plugins:
+ - jekyll-feed
+ - jekyll-seo-tag

data/_includes/custom_head.html

@@ -0,0 +1,3 @@
+{% comment %}
+  Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons.
+{% endcomment %}

data/_includes/footer.html

@@ -0,0 +1,8 @@
+<!-- Bootstrap core JS-->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/js/bootstrap.bundle.min.js"></script>
+<!-- Third party plugin JS-->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-easing/1.4.1/jquery.easing.min.js"></script>
+<!-- Core theme JS-->
+<script src="{{ "/assets/js/bootstrap.min.js" | relative_url }}"></script>
+<script src="{{ "/assets/js/scripts.js" | relative_url }}"></script>

data/_includes/head.html

@@ -0,0 +1,15 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  {%- seo -%}
+
+  <script type="text/javascript" src='https://use.fontawesome.com/releases/v5.15.1/js/all.js', crossorigin='anonymous'></script>
+  <link href='https://fonts.googleapis.com/css?family=Saira+Extra+Condensed:500,700', rel='stylesheet', type='text/css'>
+  <link href='https://fonts.googleapis.com/css?family=Muli:400,400i,800,800i', rel='stylesheet', type='text/css'>
+  <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+  {%- feed_meta -%}
+
+  {%- include custom_head.html -%}
+</head>

data/_includes/navigation.html

@@ -0,0 +1,18 @@
+<nav class="navbar navbar-expand-lg navbar-dark bg-primary fixed-top" id="sideNav">
+  <a class="navbar-brand js-scroll-trigger" href="#page-top">
+    <span class="d-block d-lg-none">{{ site.author.name }}</span>
+    <span class="d-none d-lg-block"><img class="img-fluid img-profile rounded-circle mx-auto mb-2" src="{{ "/assets/img/profile.jpg" | relative_url }}" alt="" /></span>
+  </a>
+  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation"><span class="navbar-toggler-icon"></span></button>
+  <div class="collapse navbar-collapse" id="navbarSupportedContent">
+    <ul class="navbar-nav">
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#about">About</a></li>
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#experience">Experience</a></li>
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#education">Education</a></li>
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#volunteer">Volunteering Work</a></li>
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#projects">projects</a></li>
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#awards">Awards</a></li>
+      <li class="nav-item"><a class="nav-link js-scroll-trigger" href="#skills">Skills</a></li>
+    </ul>
+  </div>
+</nav>

data/_includes/sections/about.html

@@ -0,0 +1,16 @@
+<section class="resume-section" id="about">
+  <div class="resume-section-content">
+    <h1 class="mb-0">
+      {{ site.portfolio.info.name.firstname}}
+      <span class="text-primary">{{ site.portfolio.info.name.lastname}}</span>
+    </h1>
+    <div class="subheading mb-5">
+      {{ site.portfolio.info.location}} · {{ site.portfolio.info.phonenumber}} ·
+      <a href="mailto:{{ site.portfolio.info.email}}">{{ site.portfolio.info.email}}</a>
+    </div>
+    <p class="lead mb-5">
+      {{ content }}
+    </p>
+    {%- include socials.html -%}
+  </div>
+</section>

data/_includes/sections/awards.html

@@ -0,0 +1,15 @@
+<hr class="m-0" />
+<section class="resume-section" id="awards">
+  <div class="resume-section-content">
+    <h2 class="mb-5">Awards & Certifications</h2>
+    <ul class="fa-ul mb-0">
+      {% for award in site.data.awards %}
+      <li>
+        <span class="fa-li"><i class="fas fa-trophy text-warning"></i></span>
+        {{ award }}
+      </li>
+      {% endfor %}
+
+    </ul>
+  </div>
+</section>

data/_includes/sections/education.html

@@ -0,0 +1,17 @@
+<hr class="m-0" />
+<section class="resume-section" id="education">
+  <div class="resume-section-content">
+    <h2 class="mb-5">Education</h2>
+    {% for study in site.data.studies %}
+    <div class="d-flex flex-column flex-md-row justify-content-between mb-5">
+      <div class="flex-grow-1">
+        <h3 class="mb-0">{{ study.course }}</h3>
+        <div class="subheading mb-3">{{ study.school }}</div>
+        <p>{{ study.degree }}</p>
+        <p>{{ study.description }}</p>
+      </div>
+      <div class="flex-shrink-0"><span class="text-primary">{{ study.start_date | date: "%B %Y" }} - {%- if study.end_date %} {{ study.end_date | date: "%B %Y" }} {% else %} Present {% endif %}</span></div>
+    </div>
+    {% endfor %}
+  </div>
+</section>

data/_includes/sections/experience.html

@@ -0,0 +1,16 @@
+<hr class="m-0" />
+<section class="resume-section" id="experience">
+  <div class="resume-section-content">
+    <h2 class="mb-5">Experience</h2>
+    {% for job in site.data.jobs %}
+    <div class="d-flex flex-column flex-md-row justify-content-between mb-5">
+      <div class="flex-grow-1">
+        <h3 class="mb-0">{{ job.function }}</h3>
+        <div class="subheading mb-3">{{ job.company }}</div>
+        <p>{{ job.description }}</p>
+      </div>
+      <div class="flex-shrink-0"><span class="text-primary">{{ job.start_date | date: "%B %Y" }} - {%- if job.end_date %} {{ job.end_date | date: "%B %Y" }} {% else %} Present {% endif %}</span></div>
+    </div>
+    {% endfor %}
+  </div>
+</section>

data/_includes/sections/projects.html

@@ -0,0 +1,16 @@
+<hr class="m-0" />
+<section class="resume-section" id="projects">
+  <div class="resume-section-content">
+    <h2 class="mb-5">Projects</h2>
+    {% for project in site.data.projects %}
+    <div class="d-flex flex-column flex-md-row justify-content-between mb-5">
+      <div class="flex-grow-1">
+        <h3 class="mb-0"> {% if project.link %} <a target="_blank" href="{{ project.link | default: '#'}}">{{ project.title }}</a> {% else %} {{ project.title }} {% endif %} </h3>
+        <div class="subheading mb-3">{{ project.stakeholders }}</div>
+        <p>{{ project.description }}</p>
+      </div>
+      <div class="flex-shrink-0"><span class="text-primary">{{ project.start_date | date: "%B %Y" }} - {%- if project.end_date %} {{ project.end_date | date: "%B %Y" }} {% else %} Present {% endif %}</span></div>
+    </div>
+    {% endfor %}
+  </div>
+</section>

data/_includes/sections/skills.html

@@ -0,0 +1,13 @@
+<section class="resume-section" id="skills">
+  <div class="resume-section-content">
+    <h2 class="mb-5">Skills</h2>
+    <ul class="fa-ul mb-0">
+      {% for skill in site.data.skills %}
+      <li>
+        <span class="fa-li"><i class="fas fa-check"></i></span>
+        {{ skill }}
+      </li>
+      {% endfor %}
+    </ul>
+  </div>
+</section>

data/_includes/sections/volunteering.html

@@ -0,0 +1,16 @@
+<hr class="m-0" />
+<section class="resume-section" id="volunteer">
+  <div class="resume-section-content">
+    <h2 class="mb-5">Volunteer Work</h2>
+    {% for job in site.data.volunteers %}
+    <div class="d-flex flex-column flex-md-row justify-content-between mb-5">
+      <div class="flex-grow-1">
+        <h3 class="mb-0">{{ job.function }}</h3>
+        <div class="subheading mb-3">{{ job.institute }}</div>
+        <p>{{ job.description }}</p>
+      </div>
+      <div class="flex-shrink-0"><span class="text-primary">{{ job.start_date | date: "%B %Y" }} - {%- if job.end_date %} {{ job.end_date | date: "%B %Y" }} {% else %} Present {% endif %}</span></div>
+    </div>
+    {% endfor %}
+  </div>
+</section>

data/_includes/socials.html

@@ -0,0 +1,8 @@
+<div class="social-icons">
+  {%- if site.portfolio.social.linkedin -%}<a class="social-icon" target="_blank" href="https://www.linkedin.com/in/{{ site.portfolio.social.linkedin | cgi_escape | escape }}" title="{{ site.portfolio.social.linkedin | escape }}"><i class="fab fa-linkedin-in"></i></a>{%- endif -%}
+  {%- if site.portfolio.social.github -%}<a class="social-icon" target="_blank" href="https://www.github.com/{{ site.portfolio.social.github | cgi_escape | escape }}" title="{{ site.portfolio.social.github | escape }}"><i class="fab fa-github"></i></a>{%- endif -%}
+  {%- if site.portfolio.social.twitter -%}<a class="social-icon" target="_blank" href="https://www.twitter.com/{{ site.portfolio.social.twitter | cgi_escape | escape }}" title="{{ site.portfolio.social.twitter | escape }}"><i class="fab fa-twitter"></i></a>{%- endif -%}
+  {%- if site.portfolio.social.facebook -%}<a class="social-icon" target="_blank" href="https://www.facebook.com/{{ site.portfolio.social.facebook | cgi_escape | escape }}" title="{{ site.portfolio.social.facebook | escape }}"><i class="fab fa-facebook-f"></i></a>{%- endif -%}
+  {%- if site.portfolio.social.rss -%}<a class="social-icon" target="_blank" href="{{ site.portfolio.social.rss }}" title="{{ site.portfolio.social.rss | escape }}"><i class="fas fa-rss"></i></a>{%- endif -%}
+
+</div>

data/_layouts/default.html

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+  {%- include head.html -%}
+  <body id=page-top>
+    {{ content }}
+  </body>
+</html>

data/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}