mirror of
https://github.com/NohamR/gitprofile.git
synced 2026-05-24 20:00:22 +00:00
Add section for external projects
This commit is contained in:
62
README.md
62
README.md
@@ -266,6 +266,23 @@ const config = {
|
||||
to: '2014',
|
||||
},
|
||||
],
|
||||
// To hide the `Other Projects` section, keep it empty.
|
||||
externalProjects: [
|
||||
{
|
||||
title: 'Project Name',
|
||||
description:
|
||||
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
|
||||
imageUrl: 'https://via.placeholder.com/250x250',
|
||||
link: 'https://example.com',
|
||||
},
|
||||
{
|
||||
title: 'Project Name',
|
||||
description:
|
||||
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed euismod, nunc ut.',
|
||||
imageUrl: 'https://via.placeholder.com/250x250',
|
||||
link: 'https://example.com',
|
||||
},
|
||||
],
|
||||
// Display blog posts from your medium or dev account. (Optional)
|
||||
blog: {
|
||||
source: 'dev', // medium | dev
|
||||
@@ -541,7 +558,9 @@ Empty array will hide the certifications section.
|
||||
|
||||
### Projects
|
||||
|
||||
Your public repo from GitHub will be displayed here automatically. You can limit how many projects do you want to be displayed. Also, you can hide forked or specific repo.
|
||||
#### Github Projects
|
||||
|
||||
Your public repo from GitHub will be displayed in the `Github Projects` section automatically. You can limit how many projects do you want to be displayed. Also, you can hide forked or specific repo.
|
||||
|
||||
```js
|
||||
// gitprofile.config.js
|
||||
@@ -559,6 +578,25 @@ module.exports = {
|
||||
};
|
||||
```
|
||||
|
||||
#### External Projects
|
||||
|
||||
In this section you can showcase your external/personal projects.
|
||||
|
||||
```js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
externalProjects: [
|
||||
{
|
||||
title: 'Project Name',
|
||||
description: 'Description',
|
||||
link: 'https://example.com',
|
||||
imageUrl: 'https://via.placeholder.com/250x250',
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
### 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`).
|
||||
@@ -579,28 +617,6 @@ module.exports = {
|
||||
|
||||
The posts are fetched by [blog.js](https://github.com/arifszn/blog.js).
|
||||
|
||||
## External Projects
|
||||
|
||||
In this section you can showcase your external projects.
|
||||
|
||||
```js
|
||||
// gitprofile.config.js
|
||||
module.exports = {
|
||||
// ...
|
||||
externalProjects: [
|
||||
{
|
||||
title: 'Title',
|
||||
description: 'Description',
|
||||
link: 'https://example.com',
|
||||
imageUrl: 'https://via.placeholder.com/250x250',
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
The above configuration will look like this:
|
||||

|
||||
|
||||
## 💖 Support
|
||||
|
||||
<p>You can show your support by starring this project. ★</p>
|
||||
|
||||
Reference in New Issue
Block a user