one-page-portfolio's Introduction

One Page Portfolio

Fork this repo with a ⭐ to start editing it as your own!

# Quick Setup

Install Ruby Devkit. Click here
Install Jekyll: run gem install jekyll bundler in your terminal
Fork this repository and clone your fork in your system.
Edit _config.yml to personalize your site

Settings

You have to update informations on _config.yml to customize your site:

Site settings

title: Write a title for your web site here
github_username: add your username here

You may leave the following three settings as they are if you're unsure what to edit.
description: 
baseurl: "" # the subpath of your site, e.g. /blog/
url: "http://localhost:3000" # the base hostname & protocol for your site

User settings

Fill the following profile section with your details

authour:
  name: 
  email: 
(Leave blank if you do not have one.)
social:
  github: 
  instagram: 
  facebook: 
  linkedin:

You can even change the port, but it isn't recommended at the beginning

Content

You can (and should) edit the .html files for adding your own information, icons, working experience, social links or whatever you want to add by editing the content of the markdown files in the cloned directory. I.e.:

index.markdown
about.markdown
blog.markdown

To edit the header/ footer, navigate to the _includes directory and edit the header.html / footer.html according to your choice.

Running locally

In order to compile the assets open the terminal in the cloned directory and follow those steps:

Run jekyll build
Run jekyll serve
Open your browser and type 127.0.0.1:8080 and hit enter!

Note :

If you receive errors while following steps 1 or 2, run bundle install or if, this doesn't work, re-install the ruby dev kit and jekyll.

If you changed the port in the config_yml file, the address in step 3 above would have to changed accordingly.

one-page-portfolio's People