Installation

Installation

The following steps demonstrate how to use portfolYOU as GitHub Pages remote theme.

1. Download portfolYOU as .zip from official repo then extract it.
2. Rename portfolYOU-master/ to <your-username>.github.io/
3. Remove everything except the docs/ directory.
4. Lift up the docs/ directory’s content to the root directory (i.e move them to <your-username>.github.io/).
5. Remove documentation stuff:
   • _elements/
   • documentation/
   • _config.yml : any line commented as # For Documentation Only

6. Your directory structure should be:

    <your-username>.github.io/
    ├── _data/
    ├── _posts/
    ├── _projects/
    ├── pages/
    ├── _config.yml
    ├── .gitignore
    └── Gemfile
   

7. Update _config.yml with your data (follow the comments for more help).
8. Update your site content (posts, projects and about page).
9. Finally, test portfolYOU locally then publish it to GitHub Pages.

10. [Optional] To use a specific version of portfolYOU (defaults to latest version):

     remote_theme: YoussefRaafatNasry/portfolYOU@v1.0.0