/gitfolio

:octocat: personal website + blog for every github user. Forked from imfunniee

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Heavly Modified version of Gitfolio

My Changes

  • Gets your Project ReadMe to populate your header
  • Changed Social Links
  • Resume

Gitfolio

Tweet GitHub release npm GitHub top language GitHub last commit GitHub code style: prettier

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 Customize

Forks

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

$ node bin/gitfolio.js build <username> -f

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

$ node bin/gitfolio.js 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.

Add Social Media links on your profile

Steam, LinkedIn, Medium, Discord & Resume links to your profile while building

node bin/gitfolio.js build <username> --steam <steam_username> --linkedin <linkedin_username> --medium <medium_username> --discord <discord_username> --resume <resume_link>

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!!

Updating

To update your info, simply run

$ node bin/gitfolio.js update

or use the Update options in gitfolio's UI

This will update your info and your repository info.

To Update background or theme you need to run build command again.

Follow imfunnieee on twitter for more updates @imfunnieee

License

GitHub