You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**GitProfile** is a powerful portfolio builder that allows you to create a stunning and personalized portfolio site in minutes, even if you have no coding experience. Simply provide your GitHub username, and GitProfile will automatically generate a portfolio. Best of all, you can easily deploy your portfolio to GitHub Pages with just a few clicks, making it accessible to the world in no time.
41
+
**GitProfile** is a powerful portfolio builder that allows you to create a stunning and personalized portfolio site in
42
+
minutes, even if you have no coding experience. Simply provide your GitHub username, and GitProfile will automatically
43
+
generate a portfolio. Best of all, you can easily deploy your portfolio to GitHub Pages with just a few clicks, making
44
+
it accessible to the world in no time.
42
45
43
46
**Features:**
44
47
@@ -75,19 +78,24 @@ There are three ways to use **GitProfile**. Use any.
75
78
76
79
These instructions will get you a copy of the project and deploy your portfolio online using GitHub Pages!
77
80
78
-
-**Fork repo:** Click [here](https://github.com/arifszn/gitprofile/fork) to fork the repo so you have your own project to customize. A "fork" is a copy of a repository.
81
+
-**Fork repo:** Click [here](https://github.com/arifszn/gitprofile/fork) to fork the repo so you have your own project
82
+
to customize. A "fork" is a copy of a repository.
79
83
-**Rename repo:**
80
-
- If you want to host your portfolio at `https://<USERNAME>.github.io`, rename your forked repository to `username.github.io` in GitHub, where `username` is your GitHub username (or organization name).
81
-
- If you want to host your portfolio at `https://<USERNAME>.github.io/<REPO_NAME>` (e.g. `https://<USERNAME>.github.io/portfolio`), rename your forked repository to `<REPO_NAME>` (e.g. `portfolio`) in GitHub.
84
+
- If you want to host your portfolio at `https://<USERNAME>.github.io`, rename your forked repository
85
+
to `username.github.io` in GitHub, where `username` is your GitHub username (or organization name).
86
+
- If you want to host your portfolio at `https://<USERNAME>.github.io/<REPO_NAME>` (
87
+
e.g. `https://<USERNAME>.github.io/portfolio`), rename your forked repository to `<REPO_NAME>` (e.g. `portfolio`)
88
+
in GitHub.
82
89
-**Enable workflows:** Go to your repo's **Actions** tab and enable workflows.
-**Base Value:** Open `gitprofile.config.ts`, and change `base`'s value.
87
94
88
-
- If you are deploying to `https://<USERNAME>.github.io`, set `base` to `'/'`.
95
+
- If you are deploying to `https://<USERNAME>.github.io`, set `base` to `'/'`.
89
96
90
-
- If you are deploying to `https://<USERNAME>.github.io/<REPO_NAME>` (e.g. `https://<USERNAME>.github.io/portfolio`), then set `base` to `'/<REPO_NAME>/'` (e.g. `'/portfolio/'`).
97
+
- If you are deploying to `https://<USERNAME>.github.io/<REPO_NAME>` (
98
+
e.g. `https://<USERNAME>.github.io/portfolio`), then set `base` to `'/<REPO_NAME>/'` (e.g. `'/portfolio/'`).
91
99
92
100
```ts
93
101
// gitprofile.config.ts
@@ -97,13 +105,20 @@ These instructions will get you a copy of the project and deploy your portfolio
97
105
}
98
106
```
99
107
100
-
-**Commit the changes:** Now commit to your **main** branch with your changes. Wait a few minutes so that the CI/CD pipeline can publish your website to GitHub Pages. You can check the progress in the [Actions](https://github.com/arifszn/gitprofile/actions) tab.
108
+
-**Commit the changes:** Now commit to your **main** branch with your changes. Wait a few minutes so that the CI/CD
109
+
pipeline can publish your website to GitHub Pages. You can check the progress in
110
+
the [Actions](https://github.com/arifszn/gitprofile/actions) tab.
101
111
102
-
Your portfolio website will be live shortly. Any time you commit a change to the **main** branch, the website will be automatically updated. If you face any issue viewing the website, double-check the `base` value in the `gitprofile.config.ts` file. Also, check if **Source** is set to **GitHub Actions** in **Settings** ➜ **Pages** ➜ **Build and deployment**.
112
+
Your portfolio website will be live shortly. Any time you commit a change to the **main** branch, the website will be
113
+
automatically updated. If you face any issue viewing the website, double-check the `base` value in
114
+
the `gitprofile.config.ts` file. Also, check if **Source** is set to **GitHub Actions** in **Settings** ➜ **Pages** ➜ *
115
+
*Build and deployment**.
103
116
104
-
If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's **Settings** ➜ **Pages** ➜ **Custom domain**.
117
+
If you wish to add a custom domain, no CNAME file is required. Just add it to your repo's **Settings** ➜ **Pages** ➜ *
118
+
*Custom domain**.
105
119
106
-
As this is a Vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this [doc](https://vitejs.dev/guide/static-deploy.html) for a detailed deployment guide to other services.
120
+
As this is a Vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please
121
+
refer to this [doc](https://vitejs.dev/guide/static-deploy.html) for a detailed deployment guide to other services.
107
122
108
123
> [!NOTE]
109
124
> If you are going to deploy using **Vercel**, remember to set the `base` as `/`.
@@ -141,7 +156,8 @@ As this is a Vite project, you can also host your website to Netlify, Vercel, He
141
156
142
157
- Finally, visit `http://localhost:5173/gitprofile/` from your browser.
143
158
144
-
> Alternatively, you can set up and run the project using Docker with **[Vail](https://github.com/arifszn/vail)**, a powerful tool for local development of JavaScript/TypeScript Apps.
159
+
> Alternatively, you can set up and run the project using Docker with **[Vail](https://github.com/arifszn/vail)**, a
160
+
> powerful tool for local development of JavaScript/TypeScript Apps.
145
161
146
162
## 🎨 Customization
147
163
@@ -213,6 +229,7 @@ const CONFIG = {
213
229
twitter: 'arif_szn',
214
230
mastodon: 'arifszn@mastodon.social',
215
231
researchGate: '',
232
+
googleScholar: { name: '', user: '' },
216
233
facebook: '',
217
234
instagram: '',
218
235
reddit: '',
@@ -467,7 +484,8 @@ Besides tracking visitors, it will track `click events` on projects and blog pos
467
484
468
485
### Hotjar
469
486
470
-
**GitProfile** supports [hotjar](https://www.hotjar.com) to track visitor interaction and behavior. If you do not want to use Hotjar, keep the `id` empty.
487
+
**GitProfile** supports [hotjar](https://www.hotjar.com) to track visitor interaction and behavior. If you do not want
488
+
to use Hotjar, keep the `id` empty.
471
489
472
490
```ts
473
491
// gitprofile.config.ts
@@ -498,7 +516,8 @@ const CONFIG = {
498
516
499
517
### PWA
500
518
501
-
GitProfile is PWA enabled. The site can be installed as a Progressive Web App. To turn it off, set `enablePWA` to `false`.
519
+
GitProfile is PWA enabled. The site can be installed as a Progressive Web App. To turn it off, set `enablePWA`
@@ -508,7 +527,9 @@ Your avatar and bio will be fetched from GitHub automatically.
508
527
509
528
### Social Links
510
529
511
-
You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, ResearchGate, Facebook, Instagram, Reddit, Threads, YouTube, Udemy, Dribbble, Behance, Medium, dev, Stack Overflow, Skype, Telegram, personal website, phone and email.
530
+
You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, ResearchGate,
Skype, Telegram, personal website, phone and email.
512
533
513
534
```ts
514
535
// gitprofile.config.ts
@@ -725,7 +746,8 @@ Empty array will hide the publications section.
725
746
726
747
### Blog Posts
727
748
728
-
If you have [medium](https://medium.com) or [dev](https://dev.to) account, you can show your recent blog posts in here just by providing your medium/dev username. You can limit how many posts to display (Max is `10`).
749
+
If you have [medium](https://medium.com) or [dev](https://dev.to) account, you can show your recent blog posts in here
750
+
just by providing your medium/dev username. You can limit how many posts to display (Max is `10`).
0 commit comments