Update Documentation

docs/_config.yml

@@ -1,14 +1,12 @@
 ### Site Settings ###
 title               : portfolYOU
-description         : >-                               # >- means to ignore newlines until "url:"
+description         : >-
                       "I turn coffee :coffee: into code,
                       use tabs over spaces
                       and never broke production."
-
-url                 : ""                               # base hostname & protocol for your site (e.g. http://example.com)
-baseurl             : "/portfolYOU"                    # subpath of your site (e.g. /blog) [IMPORTANT: use "" if your are hosting at https://username.github.io directly]
-repository          : YoussefRaafatNasry/portfolYOU    # repository metadata on GitHub Pages [know more at https://help.github.com/en/articles/repository-metadata-on-github-pages]
-remote_theme        : YoussefRaafatNasry/portfolYOU    # uncomment this if you are using it as a remote theme
+baseurl             : "/portfolYOU"                     # Change to empty quotes if you are hosting your site at <your-username>.github.io directly
+repository          : YoussefRaafatNasry/portfolYOU     # Change to <your-username>/<your-username>.github.io (or remove it if you don't need remote projects)
+remote_theme        : YoussefRaafatNasry/portfolYOU
 
 
 ### Plugins ###
@@ -17,11 +15,11 @@ plugins:
 
 
 ### Navbar Settings ###
-nav_exclude:                        # Pages with the following paths will be excluded from navbar
+nav_exclude:                                            # The following paths are excluded from navbar
   - pages/tags.html
   - pages/404.html
   - pages/index.md
-  - documentation/partials/**
+  - documentation/partials/**                           # For Documentation Only
 
 
 ### Author Info ###
@@ -56,8 +54,8 @@ collections:
   projects:
     output: true
     permalink: /projects/:name
-  elements:
-    output: true
+  elements:                                             # For Documentation Only
+    output: true                                        # For Documentation Only
 
 
 ### Defaults for collections ###
@@ -67,11 +65,11 @@ defaults:
       type: "projects"
     values:
       layout: "page"
-  - scope:
-      path: ""
-      type: "elements"
-    values:
-      layout: "element"
+  - scope:                                              # For Documentation Only
+      path: ""                                          # For Documentation Only
+      type: "elements"                                  # For Documentation Only
+    values:                                             # For Documentation Only
+      layout: "element"                                 # For Documentation Only
 
 
 ### Exclude from processing ###

docs/documentation/partials/02-installation.md

@@ -1,8 +1,41 @@
 ## Installation
 
+The following steps demonstrate how to use portfolYOU as **GitHub Pages remote theme**.
+
+1. [Download][download] portfolYOU as .zip from official [repo][repo] then extract it.
+1. Rename **`portfolYOU-master/`** to **`<your-username>.github.io/`**
+1. Remove everything **except** the **`docs/`** directory.
+1. Lift up the **`docs/`** directory's content to the root directory _(i.e move them to **`<your-username>.github.io/`**)_.
+1. Remove **documentation** stuff:
+    - **`_elements/`**
+    - **`documentation/`**
+    - **`_config.yml`** : any line commented as `# For Documentation Only`
+
+1. Your directory structure should be:
+
+    ```tree
+    <your-username>.github.io/
+    ├── _data/
+    ├── _posts/
+    ├── _projects/
+    ├── pages/
+    ├── _config.yml
+    ├── .gitignore
+    └── Gemfile
+    ```
+
+1. Update **`_config.yml`** with your data _(follow the comments for more help)_.
+1. Update your site content (posts, projects and about page).
+1. Finally, test portfolYOU [locally][locally] then [publish][publish] it to [GitHub Pages][gh-pages].
+1. _[Optional]_ To use a specific [version][versions] of portfolYOU _(defaults to latest version)_:
+
+    ```yml
+    remote_theme: YoussefRaafatNasry/[email protected]
+    ```
+
 [repo]: {{ site.github.repository_url }}
-[fork]: {{ site.github.repository_url }}/fork
 [download]: {{ site.github.zip_url }}
 [versions]: {{ site.github.releases_url }}
 [locally]: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/
-[gh-pages]: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
+[publish]: https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
+[gh-pages]: https://pages.github.com/

docs/documentation/partials/03-customization.md

@@ -1,4 +1,20 @@
 ## Customization
 
-When using portfolYOU as a theme means you can take advantage of the file overriding method. This allows you to overwrite any file in this theme with your own custom file, simply by matching the file name and path. The most common example of this would be if you want to add your own styles or change the favicon.  
-To change the favicon for example just generate your own using [favicon](https://favicon.io/) or any other tool. Copy your new `favicon.ico` file into your own project with the same file path `assets/favicon.ico`.
+Simply **override** the file you want to change by matching the **same file name and path**.  
+
+**Example 1:** New Favicon
+
+1. Generate your own using [favicon](https://favicon.io/) or any other tool.
+1. Copy your new `favicon.ico` file into your own project with the same file path **`assets/favicon.ico`**.
+
+**Example 2:** Custom Style
+
+1. Create **`assets/css/styles.scss`**.
+1. Add the following lines:
+
+    ```css
+    ---
+    ---
+    /* Add your custom style here */
+    @import "portfolYOU";
+    ```

portfolyou-jekyll-theme.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name                    = "portfolyou-jekyll-theme"
-  spec.version                 = "2.2.1"
+  spec.version                 = "2.2.2"
   spec.authors                 = ["Youssef Raafat"]
   spec.email                   = ["[email protected]"]