Skip to content

Commit

Permalink
docs: new json docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oyepriyansh committed Jun 21, 2024
1 parent 617f044 commit 9d2c8ca
Showing 1 changed file with 12 additions and 21 deletions.
33 changes: 12 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,23 @@ A fork is a local copy of the repository that is on your GitHub account, and you
[**Click here to fork the repository.**](https://github.com/oyepriyansh/DevProfiles/fork)

### 2. Add profile code snippet
add following code to HTML `index.html` inside the `<div class="container">` `</div>`

```html
<div class="profile">
<div class="pfp"><img src="[YOUR IMAGE URL]" alt="User Image"></div>
<h3 class="name">Your Name</h3>
<div class="skills">
<span class="skill">[SKILL-1]</span>
<span class="skill">[SKILL-2]</span>
<span class="skill">[SKILL-3]</span>
</div>
<div class="social">
<a href="[YOUR GITHUB URL]" target="_blank"><i class="fa-brands fa-github"></i></a>
<a href="[YOUR X/TWITTER URL]" target="_blank"><i class="fa-brands fa-x-twitter"></i></a>
<a href="[YOUR LINKEDIN URL]" target="_blank"><i class="fa-brands fa-linkedin-in"></i></a>
</div>
</div>
add following JSON code to `data.json` file

```json
{
"name": "YOUR_NAME",
"image": "IMAGE_url",
"github": "YOUR GITHUB URL",
"twitter": "YOUR X/TWITTER URL",
"linkedin": "YOUR LINKEDIN URL",
"skills": ["SKILL-1", "SKILL-2", "SKILL-3"]
}
```

> [!IMPORTANT]
> Don't add your profile at the beginning or end of the file. Put it anywhere in between, this is to avoid conflicts whiile having rush in Pull Requests
### 3. Fill Placeholder
Change/Replace the placeholders with your image and profiles urls
- [IMAGE-URL] with your image URL
- [YOUR_NAME] with your name
- [IMAGE-URL] with your image URL
- [SKILL-1], [SKILL-2], [SKILL-3] with your skills
- [YOUR GITHUB URL], [YOUR X/TWITTER URL] & [YOUR LINKEDIN URL] with your Github, X/Twitter & LinkedIn profile URL repectively.

Expand Down

0 comments on commit 9d2c8ca

Please sign in to comment.