Skip to content

Latest commit

 

History

History
97 lines (58 loc) · 4.25 KB

README.md

File metadata and controls

97 lines (58 loc) · 4.25 KB
Raw

Online CV Templete for IS445

This is a resource for IS445 as of Fall 2022. It is a way to host an online CV with interactive visualizations. See the course page for more materials.

How to use this repo

Download & install

  1. clone this repo or download the contents
  2. make sure you have Ruby properly installed (see the course's install instructions for this process)
  3. Install using bundle install (see the course's install instructions)
  4. Host locally with bundle exec jekyll serve or bundle exec jekyll serve -l (live reload)
  5. Modify files as needed (see sections below)

General configurations

Edit info in: _config.yml

Some things you should be sure to check

  1. The "how to use this document" info at the top
  2. title, description, repository -- basic title and linking info
  3. baseurl -- in case you want to have it be a sub-page of your main github.io page
  4. exclude -- this section at the end of the config file, add at will in case you have other things stored in your github.io repo

About page

Edit info in:

  1. pages/about.md for your general introduction
  2. _data/programming-skills.yml to update your your programming skills list
  3. _data/other-skills.yml to update other skills
  4. timeline.yml to update the timeline of your CV

Projects

Add project files in:

  • _projects to add page files
  • pages/projects.html under remote_projects for links to your github projects. Note: this will ONLY link to your repos and you must specify the end of your repo URL (see example)

You can link both project pages and github repositories. Github repos will autopopulate, pages allow you to provide more details.

By default, the project pages go first, but you can modify this if you want any github repos to show up first.

Project pages can be added by adding markdown files in the _projects folder.

Project layouts can be modified in _includes/projects.

See _example_projects folder for more examples from portfolYOU.

Python notebooks

Generally, you will be linking notebooks that exist in other repositories that are doing analysis. However for any "loose" notebooks, you can store them in the python_notebooks folder. In theory you can do fancy local linking with it, but it hasn't been implemented yet.

Altair-saved chart json's

By default these are saved in assets/json/ and static images are saved in assets/pngs/. See the example

Blog Posts

All blog posts will be posted by most recent time stamp -- please see the example for a properly formatted file name.

Add blog posts in:

  • _posts (see example)

You can see further examples in the _example_posts directory.

Sources

This is an amalgamation of portfolYOU and 4dcu.be.

portfolYOU was used for:

  • overall style, taking off a few elements -- Blog, About, Projects all are included here
  • also progress bars for skills are modified to contain words, not percentages

4dcu.be

  • vega-lite additions -- found in the _plugins folder and the vega-added things in assets/js

------------- Old ramblings below -------------

Info for how this was created

  1. Start by searching for Jeykll themes: https://github.com/topics/jekyll-theme
  2. pick the following: https://github.com/YoussefRaafatNasry/portfolYOU
  3. clone and follow the "Installation" instructions here: https://youssefraafatnasry.github.io/portfolYOU/docs/
  4. Added port
  5. remove Gemfile.lock if needed trying to install with: bundle install --path ~/.gem
  6. bundle install in directory

bundle exec jekyll serve --> without the l for live reload if something else is running?

NOTE!!! it is quite likely that you have to serve the site locally and/or delete _site before pushing for your changes to go live. I AM NOT SURE. Have to re-start after you do a change to the config.yml file