mirror of
https://github.com/NohamR/gitprofile.git
synced 2026-05-25 12:27:17 +00:00
12
README.md
12
README.md
@@ -82,11 +82,11 @@ Or try it **[online](https://stackblitz.com/edit/gitprofile)**.
|
|||||||
<img src="https://arifszn.github.io/assets/img/hosted/gitprofile/themes.png" alt="Themes">
|
<img src="https://arifszn.github.io/assets/img/hosted/gitprofile/themes.png" alt="Themes">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 🎉 Thank you for the 500 ★
|
## 🎉 Thank you for the 800 ★
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="https://arifszn.github.io/gitprofile">
|
<a href="https://arifszn.github.io/gitprofile">
|
||||||
<img src="https://user-images.githubusercontent.com/45073703/202119579-eae272bd-ed39-434d-9361-df25308e0691.gif" alt="Thank You" width="50%"/>
|
<img src="https://github.com/arifszn/gitprofile/assets/45073703/b3d34d17-cf55-4c74-bf44-3196b1f0ac66" alt="Thank You" width="50%"/>
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@@ -105,7 +105,7 @@ These instructions will get you a copy of the project and deploy your portfolio
|
|||||||
- **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.
|
- **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.
|
||||||
- **Rename repo:**
|
- **Rename repo:**
|
||||||
- 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).
|
- 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).
|
||||||
- If you want to host your portfolio at `https://<USERNAME>.github.io/<REPO>` (e.g. `https://<USERNAME>.github.io/portfolio`), rename your forked repository to `<REPO>` (e.g. `portfolio`) in GitHub.
|
- 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.
|
||||||
- **Enable workflows:** Go to your repo's **Actions** tab and enable workflows.
|
- **Enable workflows:** Go to your repo's **Actions** tab and enable workflows.
|
||||||
|
|
||||||

|

|
||||||
@@ -114,7 +114,7 @@ These instructions will get you a copy of the project and deploy your portfolio
|
|||||||
|
|
||||||
- If you are deploying to `https://<USERNAME>.github.io`, set `base` to `'/'`.
|
- If you are deploying to `https://<USERNAME>.github.io`, set `base` to `'/'`.
|
||||||
|
|
||||||
- If you are deploying to `https://<USERNAME>.github.io/<REPO>` (e.g. `https://<USERNAME>.github.io/portfolio`), then set `base` to `'/<REPO>/'` (e.g. `'/portfolio/'`).
|
- 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/'`).
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// vite.config.js
|
// vite.config.js
|
||||||
@@ -157,7 +157,9 @@ As this is a Vite project, you can also host your website to Netlify, Vercel, He
|
|||||||
|
|
||||||
### Installing as package
|
### Installing as package
|
||||||
|
|
||||||
You can also use **GitProfile** by installing as an NPM package. First Install **GitProfile** via <a href="https://www.npmjs.com/package/@arifszn/gitprofile">NPM</a>.
|
You can also use **GitProfile** by installing as an NPM package.
|
||||||
|
|
||||||
|
First Install **GitProfile** via <a href="https://www.npmjs.com/package/@arifszn/gitprofile">NPM</a>.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install @arifszn/gitprofile
|
npm install @arifszn/gitprofile
|
||||||
|
|||||||
6388
package-lock.json
generated
6388
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@arifszn/gitprofile",
|
"name": "@arifszn/gitprofile",
|
||||||
"description": "Create an automatic portfolio based on GitHub profile",
|
"description": "Create an automatic portfolio based on GitHub profile",
|
||||||
"version": "2.4.0",
|
"version": "2.5.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"author": "arifszn",
|
"author": "arifszn",
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|||||||
@@ -7,8 +7,10 @@ import { VitePWA } from 'vite-plugin-pwa';
|
|||||||
|
|
||||||
// https://vitejs.dev/config/
|
// https://vitejs.dev/config/
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
// If you are deploying to https://<USERNAME>.github.io/, set base to '/'.
|
// If you are deploying to https://<USERNAME>.github.io/, for example your repository is at https://github.com/<USERNAME>, set base to '/'.
|
||||||
// If you are deploying to https://<USERNAME>.github.io/<REPO>/, for example your repository is at https://github.com/<USERNAME>/<REPO>, then set base to '/<REPO>/'.
|
|
||||||
|
// If you are deploying to https://<USERNAME>.github.io/<REPO_NAME>/, for example your repository is at https://github.com/<USERNAME>/<REPO_NAME>, then set base to '/<REPO_NAME>/'.
|
||||||
|
|
||||||
base: '/gitprofile/',
|
base: '/gitprofile/',
|
||||||
plugins: [
|
plugins: [
|
||||||
react(),
|
react(),
|
||||||
|
|||||||
Reference in New Issue
Block a user