gitfolio-online
gitfolio-online copied to clipboard
:octocat: An online personal website for every Github user.
Gitfolio-online
中文 README
Introduction
Personal Website For Every Github User
Gitfolio will help you get started with a portfolio website where you could showcase your work.
Check out this live demo to see gitfolio in action.
Features
- Easy display your github info
- support multiple themes
- Customizable
Getting Started
Copy paste this , and that's it. Simple!
Change the username
to your GitHub's username.
https://gitfolio-online.vercel.app/user/{username}?theme={theme}&includeFork={includeFork}&cache_seconds={cache_seconds}
https://gitfolio-online.vercel.app/u/{username}?theme={theme}&includeFork={includeFork}&cache_seconds={cache_seconds}
Themes
Use ?theme=THEME_NAME
parameter like so :-
https://gitfolio-online.vercel.app/u/{username}?theme=dark/light
Include Forks
Use ?includeFork=true/false
parameter you can select whether to display fork repos
https://gitfolio-online.vercel.app/u/{username}?includeFork=true/false
Params
You can customize the appearance of your page however you want with URL params.
Option | type | description | default |
---|---|---|---|
username | string | set username | 'wangningkai' |
theme | string | sets inbuilt theme | 'dark' |
cache_seconds | number | manually set custom cache control | 1800 |
includeFork | bool | select whether to display fork repos | false |
repoNum | number | display repos number | 30 |
Deploy on your own Vercel instance
Since the GitHub API only allows 5k requests per hour, it is possible that my https://gitfolio-online.vercel.app/u/wangningkai
could hit the rate limiter. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!
Bug report
Please read before bug report《How To Ask Questions The Smart Way》
3 way to bug report:
:sparkling_heart: Support the project
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.
However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-
- Starring and sharing the project :rocket:
-
- You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- Wechat & AliPay
Thanks! :heart:
License
Contributions are welcomed! <3
Made with ❤️ and JavaScript.