Add documentation

gabubellon · Feb 12, 2019 · bd5a1ab · bd5a1ab
1 parent 8f69312
commit bd5a1ab
Show file tree

Hide file tree

Showing 8 changed files with 153 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,79 @@
-# portfolYOU
+[![portfolYOU](./docs/header.png)](https://youssefraafatnasry.github.io/portfolYOU/)
 
-A beautiful portfolio Jekyll theme that works with GitHub Pages.
+<div align="center">
+    <i>A beautiful portfolio Jekyll theme that works with GitHub Pages.</i><br><br>
+</div>
+
+[![screenshots](./docs/portfolYOU.gif)](https://youssefraafatnasry.github.io/portfolYOU/)
+
+<div align="center">
+    <sub><sup>© 2019 portfolYOU, licensed under the <a href="./LICENSE">MIT License</a>.</sup></sub>
+</div>
+
+## Download & Usage
+
+1. Clone or [Download][download] this repo.
+1. Delete unnecessary files and folders:
+   - README.md
+   - LICENSE
+   - docs/
+1. Change the configuration options in `_config.yml` depending on your needs.
+1. Modify `pages/projects.html`'s [front matter][front-matter] to add  projects.
+1. Add `YYYY-MM-DD-article-name.md` to `_posts` directory to add a new article.
+1. Modify `pages/about.html`'s [front matter][front-matter] to add skills or items to the timeline, modify the markdown body to write your bio.
+1. Set up portfolYOU [locally] or publish it to [GitHub Pages][gh-pages].
+
+[download]: https://github.com/YoussefRaafatNasry/portfolYOU/archive/master.zip
+[front-matter]: https://jekyllrb.com/docs/front-matter/
+[gh-pages]: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
+[locally]: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/
+
+## 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 ²            |
+|                               | _posts*                | _layouts/about.html               |
+|                               |                        | _includes/skills-others.html      |
+|                               |                        | _includes/skills-programming.html |
+|                               |                        | _includes/timeline.html           |
+
+<small>
+    <b>If you are deleting any section, please consider the following:</b><br>
+    ¹ remove reference from <code> _includes/navbar.html  </code><br>
+    ² remove reference from <code> assets/css/custom.scss </code><br>
+    ³ remove reference from <code> _includes/scripts.html </code><br>
+    * remove permalink from <code> _config.yml </code>
+</small>
+
+## Dependencies
+
+| Dependency                  | Version |
+| :-------------------------- |:-------:|
+| [Animate.css][animate]      | v3.7.0  |
+| [Bootstrap][bootstrap]      | v4.2.1  |
+| [FontAwesome][font-awesome] | v5.6.3  |
+| [jQuery][jquery]            | v3.3.1  |
+| [Popper.js][popper]         | v1.14.6 |
+| [wow.js][wow]               | v1.1.2  |
+
+[animate]: https://daneden.github.io/animate.css/
+[bootstrap]: https://getbootstrap.com/
+[font-awesome]: https://fontawesome.com/
+[jquery]: https://jquery.com/
+[popper]: https://popper.js.org/
+[wow]: https://wowjs.uk/
+
+## Credits & Inspiration
+
+1. [CSS3 Animated Skill Progress bar][skills-progress-bar] _A pen by Shah Zobayer Ahmed._
+1. [How to Create Bootstrap Card Hover Effect (jQuery)][cards-hover] _A video by Daily Tuition._
+1. [Vertical Timeline (HTML-SCSS-CSS)][vertical-timeline] _A video by DevPen._
+
+[skills-progress-bar]: https://codepen.io/speeedsam/pen/VeOGEq
+[cards-hover]: https://www.youtube.com/watch?v=2qQxwT-Qm5E
+[vertical-timeline]: https://www.youtube.com/watch?v=TP4THzsAa3M&t=2s
diff --git a/_posts/2018-02-06-download.md b/_posts/2018-02-06-download.md
@@ -3,12 +3,84 @@ title: Download portfolYOU
 tags: [Download, Free]
 style: border
 color: primary
-description: This post contains everything that you need to know about portfolYOU and how to get it.
+description: This article contains everything that you need to know about portfolYOU and how to get it for FREE.
 ---
 
 portfolYOU is a free modern open-source Jekyll portfolio and blogging theme that works with GitHub Pages.
 Created by [@YoussefRaafatNasry](https://github.com/YoussefRaafatNasry)
 
+![]({{ '/docs/portfolYOU.gif' | relative_url }})
+
 <div class="col text-center">
-<a href="https://github.com/YoussefRaafatNasry/portfolYOU" class="btn btn-outline-primary">Download portfolYOU Now!</a>
-</div>
+<a href="https://github.com/YoussefRaafatNasry/portfolYOU" class="btn btn-outline-primary mx-2">View on GitHub</a>
+<a href="https://github.com/YoussefRaafatNasry/portfolYOU/archive/master.zip" class="btn btn-outline-primary mx-2">Download Now!</a>
+</div>
+
+## Download & Usage
+
+1. Clone or [Download][download] this [repo][repo].
+1. Delete unnecessary files and folders:
+   - README.md
+   - LICENSE
+   - docs/
+1. Change the configuration options in `_config.yml` depending on your needs.
+1. Modify `pages/projects.html`'s [front matter][front-matter] to add  projects.
+1. Add `YYYY-MM-DD-article-name.md` to `_posts` directory to add a new article.
+1. Modify `pages/about.html`'s [front matter][front-matter] to add skills or items to the timeline, modify the markdown body to write your bio.
+1. Set up portfolYOU [locally] or publish it to [GitHub Pages][gh-pages].
+
+[repo]: https://github.com/YoussefRaafatNasry/portfolYOU/
+[download]: https://github.com/YoussefRaafatNasry/portfolYOU/archive/master.zip
+[front-matter]: https://jekyllrb.com/docs/front-matter/
+[gh-pages]: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
+[locally]: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/
+
+## 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 ²            |
+|                               | _posts*                | _layouts/about.html               |
+|                               |                        | _includes/skills-others.html      |
+|                               |                        | _includes/skills-programming.html |
+|                               |                        | _includes/timeline.html           |
+
+<small>
+    <b>If you are deleting any section, please consider the following:</b><br>
+    ¹ remove reference from <code> _includes/navbar.html  </code><br>
+    ² remove reference from <code> assets/css/custom.scss </code><br>
+    ³ remove reference from <code> _includes/scripts.html </code><br>
+    * remove permalink from <code> _config.yml </code>
+</small>
+
+## Dependencies
+
+| Dependency                  | Version |
+| :-------------------------- |:-------:|
+| [Animate.css][animate]      | v3.7.0  |
+| [Bootstrap][bootstrap]      | v4.2.1  |
+| [FontAwesome][font-awesome] | v5.6.3  |
+| [jQuery][jquery]            | v3.3.1  |
+| [Popper.js][popper]         | v1.14.6 |
+| [wow.js][wow]               | v1.1.2  |
+
+[animate]: https://daneden.github.io/animate.css/
+[bootstrap]: https://getbootstrap.com/
+[font-awesome]: https://fontawesome.com/
+[jquery]: https://jquery.com/
+[popper]: https://popper.js.org/
+[wow]: https://wowjs.uk/
+
+## Credits & Inspiration
+
+1. [CSS3 Animated Skill Progress bar][skills-progress-bar] _A pen by Shah Zobayer Ahmed._
+1. [How to Create Bootstrap Card Hover Effect (jQuery)][cards-hover] _A video by Daily Tuition._
+1. [Vertical Timeline (HTML-SCSS-CSS)][vertical-timeline] _A video by DevPen._
+
+[skills-progress-bar]: https://codepen.io/speeedsam/pen/VeOGEq
+[cards-hover]: https://www.youtube.com/watch?v=2qQxwT-Qm5E
+[vertical-timeline]: https://www.youtube.com/watch?v=TP4THzsAa3M&t=2s
diff --git a/docs/0.jpg b/docs/0.jpg
diff --git a/docs/1.jpg b/docs/1.jpg
diff --git a/docs/2.jpg b/docs/2.jpg
diff --git a/docs/3.jpg b/docs/3.jpg
diff --git a/docs/header.png b/docs/header.png
diff --git a/docs/portfolYOU.gif b/docs/portfolYOU.gif