Skip to content

Latest commit

 

History

History
80 lines (64 loc) · 3.73 KB

README.md

File metadata and controls

80 lines (64 loc) · 3.73 KB

portfolYOU

A beautiful portfolio Jekyll theme that works with GitHub Pages.

screenshots

© 2019 portfolYOU, licensed under the MIT License.

Download & Usage

  1. Clone or Download this repo.
  2. Delete unnecessary files and folders:
    • README.md
    • LICENSE
    • docs/
  3. Change the configuration options in _config.yml depending on your needs.
  4. Add project-name.md to _projects directory to add a new project.
  5. Add YYYY-MM-DD-article-name.md to _posts directory to add a new article.
  6. Modify _data/ files to add new skills or items to the timeline.
  7. Modify pages/about.md to write your own bio.
  8. Set up portfolYOU locally or publish it to GitHub Pages.

Sections

portfolYOU's sections are independent, you can remove any section upon your needs. Here's a list of the files and folders needed by each section:

Projects Articles About
pages/projects.html pages/articles.html pages/about.md
_sass/projects.scss ¹ _sass/_articles.scss ¹ _sass/_skills.scss ¹
assets/js/card_animation.js ² _layouts/post.html _sass/_timeline.scss ¹
_projects/ ³ _posts/ ⁴ _layouts/about.html
_includes/skills-others.html
_includes/skills-programming.html
_includes/timeline.html
_data/
If you are deleting any section, please consider the following:
¹ remove reference from assets/css/custom.scss
² remove reference from _includes/scripts.html
³ remove collections and defaults from _config.yml
⁴ remove permalink from _config.yml

Dependencies

Dependency Version
Animate.css v3.7.0
Bootstrap v4.2.1
FontAwesome v5.6.3
jQuery v3.3.1
Popper.js v1.14.6
wow.js v1.1.2

Credits & Inspiration

  1. CSS3 Animated Skill Progress bar A pen by Shah Zobayer Ahmed.
  2. How to Create Bootstrap Card Hover Effect (jQuery) A video by Daily Tuition.
  3. Vertical Timeline (HTML-SCSS-CSS) A video by DevPen.