Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 2.47 KB

getting-started.mdx

File metadata and controls

110 lines (78 loc) · 2.47 KB
title
Getting Started

Add your profile

There are 2 ways you can add your profile :

  1. Directly from the GitHub
  2. Using a code editor (eg. VSCode)

Step 1:

1. Visit the GitOpener repo

repo

2. Fork the repo into your account

fork

3. Click add file and select "create new file"

addFile

4. Create your file named contribution/<Your GitHub username>, and append .mdx for example contribution/Aadarsh805.mdx

createProfile

5. For the content use the mdx structure below:

---
author: Add Your Name
github_username: add_your_github_user_name
occupation: Student
github: https://github.com/<your_github_user_name>
twitter: https://twitter.com/<your_twitter_user_name>
linkedin: https://www.linkedin.com/in/<your_linkedin_user_name>
---

# Introduction

add a brief introduction of you

## Skills

<Tabs>

<Tab title="Frame Work">
  <Skills title="Frame Works">
    <Skill
      name="skill name (e.g reactjs)"
      href="(reactjs website)"
      icon=
      {
        add a svg icon of your skills (e.g reactjs then reactjs svg icon code)
      }
      level="Newbie" 
    >
        your experience
    </Skill>
    <Skill
      name="skill name"
      href="official website"
      level="Intermidiate"
      icon={
      add a svg icon of your skills
      }
    >
   your experience
    </Skill>

  </Skills>
</Tab>

</Tabs>

## Hobbies

- Cricket
- Travelling

<Projects>
  <Project
    name="your project name"
    tldr="a small intro about your project"
    image="your project image URL"
    livePreview="development URL"
    repository="github repo URL"
   >
 add a description

  </Project>
</Projects>

6. Add Projects

7. Click Create pull request

8. Now you need to wait to have your Pull Request reviewed

Example Profiles

Looking for inspiration? You can view the following profiles for an example: