Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V3.1.0 #526

Merged
merged 8 commits into from
Mar 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
✓ [Certification Section](#certifications)
✓ [Education Section](#education)
✓ [Projects Section](#projects)
✓ [Publication Section](#publications)
✓ [Blog Posts Section](#blog-posts)

To view a live example, **[click here](https://arifszn.github.io/gitprofile)**.
Expand Down Expand Up @@ -210,6 +211,7 @@ const CONFIG = {
linkedin: 'ariful-alam',
twitter: 'arif_szn',
mastodon: 'arifszn@mastodon.social',
researchGate: '',
facebook: '',
instagram: '',
youtube: '', // example: 'pewdiepie'
Expand Down Expand Up @@ -282,6 +284,17 @@ const CONFIG = {
to: '2014',
},
],
publications: [
{
title: 'Publication Title',
conferenceName: 'Conference Name',
journalName: 'Journal Name',
authors: 'John Doe, Jane Smith',
link: 'https://example.com',
description:
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
},
],
// Display articles from your medium or dev account. (Optional)
blog: {
source: 'dev', // medium | dev
Expand Down Expand Up @@ -473,7 +486,7 @@ Your avatar and bio will be fetched from GitHub automatically.

### Social Links

You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, Facebook, Instagram, YouTube, Dribbble, Behance, Medium, dev, Stack Overflow, Skype, Telegram, personal website, phone and email.
You can link your social media services you're using, including LinkedIn, Twitter, Mastodon, ResearchGate, Facebook, Instagram, YouTube, Dribbble, Behance, Medium, dev, Stack Overflow, Skype, Telegram, personal website, phone and email.

```ts
// gitprofile.config.ts
Expand All @@ -483,6 +496,7 @@ const CONFIG = {
linkedin: 'ariful-alam',
twitter: 'arif_szn',
mastodon: 'arifszn@mastodon.social',
researchGate: '',
facebook: '',
instagram: '',
youtube: '',
Expand Down Expand Up @@ -660,6 +674,30 @@ const CONFIG = {
};
```

### Publications

Provide your academic publishing in `publications`.

```ts
// gitprofile.config.ts
const CONFIG = {
// ...
publications: [
{
title: 'Publication Title',
conferenceName: 'Conference Name',
journalName: 'Journal Name',
authors: 'John Doe, Jane Smith',
link: 'https://example.com',
description:
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
},
],
};
```

Empty array will hide the publications section.

### Blog Posts

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`).
Expand Down
23 changes: 22 additions & 1 deletion gitprofile.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ const CONFIG = {
linkedin: 'ariful-alam',
twitter: 'arif_szn',
mastodon: 'arifszn@mastodon.social',
researchGate: '',
facebook: '',
instagram: '',
youtube: '', // example: 'pewdiepie'
Expand Down Expand Up @@ -132,11 +133,31 @@ const CONFIG = {
to: '2014',
},
],
publications: [
{
title: 'Publication Title',
conferenceName: '',
journalName: 'Journal Name',
authors: 'John Doe, Jane Smith',
link: 'https://example.com',
description:
'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
},
{
title: 'Publication Title',
conferenceName: 'Conference Name',
journalName: '',
authors: 'John Doe, Jane Smith',
link: 'https://example.com',
description:
'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.',
},
],
// Display articles from your medium or dev account. (Optional)
blog: {
source: 'dev', // medium | dev
username: 'arifszn', // to hide blog section, keep it empty
limit: 3, // How many articles to display. Max is 10.
limit: 2, // How many articles to display. Max is 10.
},
googleAnalytics: {
id: '', // GA3 tracking id/GA4 tag id UA-XXXXXXXXX-X | G-XXXXXXXXXX
Expand Down
19 changes: 19 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ interface Social {
*/
mastodon?: string;

/**
* ResearchGate username
*/
researchGate?: string;

/**
* Facebook
*/
Expand Down Expand Up @@ -217,6 +222,15 @@ interface Education {
to: string;
}

interface Publication {
title: string;
conferenceName?: string;
journalName?: string;
authors?: string;
link?: string;
description?: string;
}

interface GoogleAnalytics {
/**
* GA3 tracking id/GA4 tag id UA-XXXXXXXXX-X | G-XXXXXXXXXX
Expand Down Expand Up @@ -370,6 +384,11 @@ interface Config {
*/
educations?: Array<Education>;

/**
* Publication list
*/
publications?: Array<Publication>;

/**
* Resume
*/
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@arifszn/gitprofile",
"description": "Create an automatic portfolio based on GitHub profile",
"version": "3.0.0",
"version": "3.1.0",
"type": "module",
"license": "MIT",
"author": "arifszn",
Expand Down Expand Up @@ -81,6 +81,7 @@
"github-pages",
"github-portfolio",
"vite-portfolio",
"academic-portfolio",
"github-api"
]
}
2 changes: 1 addition & 1 deletion src/components/blog-card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ const BlogCard = ({
<div className="w-full">
<div className="flex items-start px-4">
<div className="text-center md:text-left w-full">
<h2 className="font-semibold text-base-content opacity-60">
<h2 className="font-medium text-base-content opacity-60">
{article.title}
</h2>
<p className="text-base-content opacity-50 text-xs">
Expand Down
27 changes: 10 additions & 17 deletions src/components/certification-card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const ListItem = ({
style={{ left: '-4.5px' }}
></div>
<div className="my-0.5 text-xs">{year}</div>
<div className="font-semibold">
<div className="font-medium">
<a href={link} target="_blank" rel="noreferrer">
{name}
</a>
Expand Down Expand Up @@ -78,22 +78,15 @@ const CertificationCard = ({
renderSkeleton()
) : (
<>
{certifications
.filter(
(certification) =>
certification.year ||
certification.name ||
certification.body,
)
.map((certification, index) => (
<ListItem
key={index}
year={certification.year}
name={certification.name}
body={certification.body}
link={certification.link}
/>
))}
{certifications.map((certification, index) => (
<ListItem
key={index}
year={certification.year}
name={certification.name}
body={certification.body}
link={certification.link}
/>
))}
</>
)}
</ol>
Expand Down
11 changes: 9 additions & 2 deletions src/components/details-card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {
AiFillInstagram,
AiFillMediumSquare,
} from 'react-icons/ai';
import { SiTwitter } from 'react-icons/si';
import { SiTwitter, SiResearchgate } from 'react-icons/si';
import { CgDribbble } from 'react-icons/cg';
import { RiPhoneFill, RiMailFill } from 'react-icons/ri';
import { Fragment } from 'react';
Expand Down Expand Up @@ -147,6 +147,14 @@ const DetailsCard = ({ profile, loading, social, github }: Props) => {
value={github.username}
link={`https://github.com/${github.username}`}
/>
{social?.researchGate && (
<ListItem
icon={<SiResearchgate />}
title="ResearchGate:"
value={social.researchGate}
link={`https://www.researchgate.net/profile/${social.researchGate}`}
/>
)}
{social?.twitter && (
<ListItem
icon={<SiTwitter />}
Expand Down Expand Up @@ -265,7 +273,6 @@ const DetailsCard = ({ profile, loading, social, github }: Props) => {
link={`https://t.me/${social.telegram}`}
/>
)}

{social?.phone && (
<ListItem
icon={<RiPhoneFill />}
Expand Down
21 changes: 8 additions & 13 deletions src/components/education-card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,14 @@ const EducationCard = ({
renderSkeleton()
) : (
<>
{educations
.filter(
(item) =>
item.institution || item.degree || item.from || item.to,
)
.map((item, index) => (
<ListItem
key={index}
time={`${item.from} - ${item.to}`}
degree={item.degree}
institution={item.institution}
/>
))}
{educations.map((item, index) => (
<ListItem
key={index}
time={`${item.from} - ${item.to}`}
degree={item.degree}
institution={item.institution}
/>
))}
</>
)}
</ol>
Expand Down
34 changes: 13 additions & 21 deletions src/components/experience-card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -75,27 +75,19 @@ const ExperienceCard = ({
renderSkeleton()
) : (
<Fragment>
{experiences
.filter(
(experience) =>
experience.company ||
experience.position ||
experience.from ||
experience.to,
)
.map((experience, index) => (
<ListItem
key={index}
time={`${experience.from} - ${experience.to}`}
position={experience.position}
company={experience.company}
companyLink={
experience.companyLink
? experience.companyLink
: undefined
}
/>
))}
{experiences.map((experience, index) => (
<ListItem
key={index}
time={`${experience.from} - ${experience.to}`}
position={experience.position}
company={experience.company}
companyLink={
experience.companyLink
? experience.companyLink
: undefined
}
/>
))}
</Fragment>
)}
</ol>
Expand Down
2 changes: 1 addition & 1 deletion src/components/external-project-card/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ const ExternalProjectCard = ({
<div className="w-full">
<div className="px-4">
<div className="text-center w-full">
<h2 className="font-semibold text-lg tracking-wide text-center opacity-60 mb-2">
<h2 className="font-medium text-lg text-center opacity-60 mb-2">
{item.title}
</h2>
{item.imageUrl && (
Expand Down
7 changes: 7 additions & 0 deletions src/components/gitprofile.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import GithubProjectCard from './github-project-card';
import ExternalProjectCard from './external-project-card';
import BlogCard from './blog-card';
import Footer from './footer';
import PublicationCard from './publication-card';

/**
* Renders the GitProfile component.
Expand Down Expand Up @@ -255,6 +256,12 @@ const GitProfile = ({ config }: { config: Config }) => {
googleAnalyticsId={sanitizedConfig.googleAnalytics.id}
/>
)}
{sanitizedConfig.publications.length !== 0 && (
<PublicationCard
loading={loading}
publications={sanitizedConfig.publications}
/>
)}
{sanitizedConfig.projects.external.projects.length !==
0 && (
<ExternalProjectCard
Expand Down
Loading