πΌ Sample code snippets for GitHub profile README.md
To customise your GitHub Profile, include your favourite code snippets in README.md
in a public repository named after your GitHub <username>
. README.md
must be located at the root directory of the repository.
π 0. Contents
π½ 1. About me section
π¨ 2. Images
π 3. GitHub README stats
βοΈ 4. Connect with me section
π οΈ 5. Languages and tools
π 6. Organise
π 7. Other additional resources
π½ 1. About me section
Sample prompt:
Hi there π
- π My name is ...
- π© Pronouns: ...
- π Iβm currently working on ...
- π± Iβm currently learning ...
- π€ Iβm looking to collaborate on ...
- π€ Iβm looking for help with ...
- π¬ Ask me about ...
- π« How to reach me: ...
- β€οΈ I love ...
- β‘ Fun fact: ...
π½ 1.1. Additional resources
π¨ 2. Images
There are two ways to embed an image:
- HTML approach:
<img src="<url>"/>
- Markdown approach:
![](<url>)
π¨ 2.1. Sample image
Photo by CΓ©dric Frixon on Unsplash
π¨ 2.2. Sample banner
π¨ 2.3. Sample gif
π¨ 2.4. Additional resources
π 3. GitHub README stats
To customise the following summaries for your GitHub, replace zluvsand
with your GitHub username and github_profile
with your repository to display.
π 3.1. GitHub stats
π 3.2. Most used languages
π 3.3. Total contributions and streaks
π 3.4. GitHub repository
π 3.5. Themes
To apply theme from available themes, add &theme=<theme_name>
to the url. Here's how to apply dark theme to our example on GitHub stats:
π 3.6. Additional resources
βοΈ 4. Connect with me section
βοΈ 4.1. Inspiration 1
βοΈ4.2. Inspiration 2
βοΈ 4.3. Inspiration 3
βοΈ 4.4. Additional resources
π οΈ 5. Languages and tools
π οΈ 5.1. Inspiration 1
π οΈ 5.2. Inspiration 2
π οΈ 5.3. Inspiration 3
Python |
Java |
HTML |
CSS |
React |
git |
GitHub |
Canva |
π οΈ 5.4. Additional resources
Same as section βοΈ 4.4.
π 6. Collapsible sections
β¨About Me
Sample textπ οΈ Languages & Tools
Sample textTo embed images inside a collapsible section, need to use the HTML approach:
π Open me (Markdown approach)
![](https://media.giphy.com/media/H4uE6w9G1uK4M/giphy.gif)π 7. Other additional resources
- Awesome GitHub Profile README
- Repositories on GitHub Profile
- Sophisticated embeddable metrics
- GitHub Profile README Generator
- Awesome GitHub Profile README Template Collection