Gitfolio

personal website + blog for every github user

Gitfolio will help you get started with a portfolio website where you could showcase your work + a blog that will help you spread your ideas into real world.

Check out this live demo to see gitfolio in action.

Getting Started

Let's Install

Install gitfolio

➜  ~ git clone https://github.com/k4ustu3h/gitfolio.git
➜  ~ cd gitfolio
➜  ~ npm install -g

Let's Build

Using the UI

➜  ~ gitfolio ui

Tip: You can use ui to create new blogs and for updating your folio too.

➜  ~ gitfolio build <username>

<username> is your username on github. This will build your website using your GitHub username and put it in the /dist folder.

To run your website use run command, Default port is 3000

➜  ~ gitfolio run -p [port]

🎉 Congrats, you just made yourself a personal website!

Let's Customize

Forks

To include forks on your personal website just provide -f or --fork argument while building

➜  ~ gitfolio build <username> -f

Sorting Repos

To sort repos provide --sort [sortBy] argument while building. Where [sortBy] can be star, created, updated, pushed,full_name. Default: created

➜  ~ gitfolio build <username> --sort star

Ordering Repos

To order the sorted repos provide --order [orderBy] argument while building. Where [orderBy] can be asc or desc. Default: asc

➜  ~ gitfolio build <username> --sort star --order desc

Customize Themes

Themes are specified using the --theme [theme-name] flag when running the build command. The available themes are

light
dark

TODO: Add more themes

For example, the following command will build the website with the dark theme

➜  ~ gitfolio build <username> --theme dark

Customize background image

To customize the background image just provide --background [url] argument while building

➜  ~ gitfolio build <username> --background https://images.unsplash.com/photo-1557277770-baf0ca74f908?w=1634

You could also add in your custom CSS inside index.css to give it a more personal feel.

gitfolio supports adding the follwing Social links

Codepen -c, --codepen <username>
Dev.to -d, --dev <username>
Dribbble -D, --dribbble <username>
Email -e, --email <email>
Facebook -f, --facebook <username>
Instagram -i, --instagram <username>
Keybase -k, --keybase <username>
Reddit -r, --reddit <username>
Telegram -T, --telegram <username>
Twitter -w, --twitter <username>

➜  ~ gitfolio build <username> --twitter <twitter_username> --dribbble <dribbble_username>

Let's Publish

Head over to GitHub and create a new repository named username.github.io, where username is your username. Push the files inside/dist folder to repo you just created.

Go To username.github.io your site should be up!!