How to create a readme.md profile on Github
Tags: github, git, productivity, profile
Published: 2020-07-26 12:23:16

Recently Github added a very interesting feature for its users, the possibility to develop a homepage built in markdown for their profile. However, this feature is hidden from everyone, and I will teach you how to unlock it. Here we go?

### **Discovering the feature**

To activate the profile feature, we will create a new repository. The secret is found right here. Create a repository with the **name of your nickname from github** and you will see a window appear warning you that you have discovered a **secret**!

![creating repository](https://dev-to-uploads.s3.amazonaws.com/i/w87epdkozs0blx7559bv.png)

Don't forget to check **Initialize this repository with a README** for the secret to take effect.

### **Performing the first edit**

After creating the repository, we will be redirected to its initial page, in which we have only one Readme.md file.

![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/hv3zn2zi9eowtalhjfj8.png)

After opening the file in the github editor, we will see that there is already a template with some topics ready for you to start your profile description.

![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/i8ytced8bycesswaqfpk.png)

**Readme.md** supports markdown and HTML and you can merge both to get your look.

## **Useful links to help build a profile on your Github**

* [Markdown Guide](https://guides.github.com/features/mastering-markdown/)
* [HTML Guide](https://htmldog.com/guides/html/beginner/)
* [Profile templates](https://github.com/kautukkundan/Awesome-Profile-README-templates)

## **Interesting code blocks to insert in your profile**

### Github Stats

```markdown
![Aryclenio GitHub Stats](https://github-readme-stats.vercel.app/api?username=aryclenio&show_icons=true)
```
![Aryclenio GitHub Stats](https://github-readme-stats.vercel.app/api?username=aryclenio&show_icons=true)

### Social Media

```html
<a target="_blank" href="https://www.linkedin.com/in/aryclenio-barros-060322135/">
  <img align="left" alt="LinkdeIN" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/linkedin.svg" />
</a>
<a target="_blank" href="https://api.whatsapp.com/send?phone=5584999828379">
  <img align="left" alt="Whatsapp" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/whatsapp.svg" />
</a>
<a target="_blank" href="https://www.instagram.com/ary.clenio/">
  <img align="left" alt="Instagram" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/instagram.svg" />
</a>
<a target="_blank" href="https://dev.to/aryclenio/">
  <img align="left" alt="Devto" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/dev-dot-to.svg" />
</a>
<a target="_blank" href="mailto:arycleniobarros@gmail.com">
  <img align="left" alt="Gmail" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/gmail.svg" />
</a>
<a target="_blank" href="https://fb.com/aryxb">
  <img align="left" alt="Facebook" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/facebook.svg" />
</a>
```

### Code languages that you work

```html
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/javascript/javascript.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/typescript/typescript.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/react/react.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/nodejs/nodejs.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/vue/vue.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/cpp/cpp.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/mysql/mysql.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/git/git.png"></code>
<code><img height="20" src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/topics/terminal/terminal.png"></code>
```
## Showing on your profile

After finishing your editing, just commit and go back to your home page. You will see that it now shows all its description and only after that, its repositories.

![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/5s32h7p81apk0hkkd7o5.png)

![Alt Text](https://dev-to-uploads.s3.amazonaws.com/i/bqi4rthu2yzz6jqlcs0v.png)

That's it! Feel free to get inspired by [my readme](https://github.com/aryclenio).

THANK YOU FOR READING!