https://github.com/felixfaisal/personal-template

https://github.com/felixfaisal/personal-template

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/felixfaisal/personal-template
• Owner: felixfaisal
• License: mit
• Created: 2021-02-02T23:37:14.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-03T03:32:12.000Z (almost 4 years ago)
• Last Synced: 2024-10-24T16:21:14.522Z (2 months ago)
• Language: HTML
• Size: 6.77 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Portfolio Template

This is a Jekyll website template designed for Explorer Fellows. During the Fellowship, you'll generate a number of projects 

This can also be used for Open Source and Externship Fellows but you might need to make some tweaks.

## Make your own!

1. Fork this repository or use the Template button.

2. Update `_config.yml` to contain your information.

    1. Change `url` to be what your Github Pages will be (the name of the repository)

    2. Make sure it has the /

3. Go to the repository settings and turn on GitHub Pages

## Add your portfolio

Head to `_data` and fill out either `projects.yml`, `experience.yml`, `education.yml` and `achievements.yml`.

Project example.

```yaml

- title: Machine Learning Project

  event: MLH Fellowship Explorer Sprint 3 - Batch 1

  date: Fall 2020

```

Experience example.

```yaml

- role: Open Source Fellow

  company: MLH Fellowship

  dates: Summer 2020

  logo: fellowship.svg

```

Education example.

```yaml

- course: Explorer Fellow

  institute: MLH Fellowship

  dates: Fall 2020

  logo: fellowship.svg

```

Achievement example.

```yaml

- title: Winner at MLH Hackathon

  date: Jan 2021

```

## Add project posts

1. Make a new `.md` file inside of `projects`.

2. Add the header to your markdown file (see below) and change the title to the name of your blog post.

3. Write your project page! Can be a README from GitHub or your Devpost page.

4. Add the `page-name` field to your `projects.yml` (see below).

Top of post markdown file post.

```

---

title: Sprint 1 Project

layout: page

---

```

`projects.yml` with the `page-name` field.

```yaml

- title: Machine Learning Project

  event: MLH Fellowship Explorer Sprint 3 - Batch 1

  date: Fall 2020

  page-name: sprint1

```

## Development

If you want to test it locally or add some new features, run the below commands. Make sure to have Ruby and Bundler installed.

```

bundle install

bundle exec jekyll serve

```