github-readme

Top 23 github-readme Open-Source Projects

github-readme
  • awesome-github-profile-readme

    😎 A curated list of awesome GitHub Profile which updates in real time

    Project mention: How to Make Your Awesome GitHub Profile | dev.to | 2024-01-07

  • </code></li> <li><code><style></code></li> <li><code><xmp></code></li> <li><code><iframe></code></li> <li><code><noembed></code></li> <li><code><noframes></code></li> <li><code><script></code></li> <li><code><plaintext></code></li> </ul> <blockquote> <p>πŸ’‘: To learn more, here's the <a href="https://github.github.com/gfm/#html-blocks">GitHub Flavored Markdown Spec</a> related to HTML blocks.</p> </blockquote> <h3> <a name="finding-inspiration" href="#finding-inspiration"> </a> Finding Inspiration </h3> <p>To help you get started, I suggest looking at other awesome GitHub profiles for ideas. You can go to <a href="https://github.com/abhisheknaiidu/awesome-github-profile-readme">awesome-github-profile-readme</a>, where I've found inspiration when making my profile. </p> <p>Since the profiles are open-source, you can use some of the good ideas for your awesome profile!</p> <p>You can also check out <a href="https://github.com/kshyun28">my profile</a> for some ideas. πŸ˜‰</p> <h3> <a name="adding-badges" href="#adding-badges"> </a> Adding Badges </h3> <p>For adding badges to your profile, you can check out <a href="https://github.com/Ileriayo/markdown-badges">markdown-badges</a>. The repository has a wide selection to choose from, ranging from programming languages to streaming platforms like Netflix.</p> <p>If you can't find what you're looking for or want to create custom badges, you can go to <a href="https://shields.io/">shields.io</a>, which is what <a href="https://github.com/Ileriayo/markdown-badges">markdown-badges</a> use. </p> <p>Here's an example where I used <a href="https://github.com/Ileriayo/markdown-badges">markdown-badges</a> on my profile.<br> <a href="https://res.cloudinary.com/practicaldev/image/fetch/s--rlrJWZvX--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/badges-example_t6jyr6.png" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--rlrJWZvX--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/badges-example_t6jyr6.png" alt="Markdown badges example" loading="lazy" width="800" height="127"></a></p> <h3> <a name="adding-icons" href="#adding-icons"> </a> Adding Icons </h3> <p>For adding a <code>skills</code> or <code>tech stack</code> section to your profile, I recommend using <a href="https://github.com/tandpfun/skill-icons">skill-icons</a> which provide beautiful icons.</p> <p>If your icon is not supported, you can go to <a href="https://simpleicons.org/">simpleicons</a>, which has over 2900 SVG icons for popular brands.</p> <p>Here's an example where I used <a href="https://github.com/tandpfun/skill-icons">skill-icons</a> for my profile's tech stack section. <br> <a href="https://res.cloudinary.com/practicaldev/image/fetch/s--QcxDGziL--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/icons-example_nyo1sn.png" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--QcxDGziL--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/icons-example_nyo1sn.png" alt="Icons example" loading="lazy" width="800" height="182"></a></p> <h3> <a name="using-emojis" href="#using-emojis"> </a> Using Emojis </h3> <p>In GitHub Flavored Markdown, you can use emojis. To see the full list of supported emojis, you can go to this <a href="https://github.com/ikatyang/emoji-cheat-sheet">emoji-cheat-sheet</a>.</p> <p>If you want to get the list of supported emojis yourself, you can use <a href="https://docs.github.com/en/rest/emojis/emojis#get-emojis">GitHub's Emoji API</a>.</p> <p>Going to <a href="https://api.github.com/emojis">https://api.github.com/emojis</a> on your browser should show a JSON response of all supported emojis.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight json"><code><span class="p">{</span><span class="w"> </span><span class="nl">"+1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"-1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"100"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"1234"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"1st_place_medal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"2nd_place_medal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"3rd_place_medal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"8ball"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span></code></pre> <div class="highlight__panel js-actions-panel"> <div class="highlight__panel-action js-fullscreen-code-action"> <svg xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewbox="0 0 24 24" class="highlight-action crayons-icon highlight-action--fullscreen-on"><title>Enter fullscreen mode Exit fullscreen mode Here's an example where I used emojis for my profile. Adding GitHub Stats For adding cards and stats for your GitHub activity, I recommend using github-readme-stats. You can customize your stat cards with different layouts and themes. Here's an example where I added GitHub stats to my profile. Adding Quotes Adding random quotes to your profile can add a nice touch for visitors. I found github-readme-quotes to be useful for doing just that. Here's what it looks like on my profile. I personally like to add quotes to provide some value to my profile visitors. More Ideas For adding more infographics to your profile, I recommend checking out metrics. This is one of the most starred repositories on GitHub with the github-profile topic, so I couldn't leave this out. Then I found this beautiful resource beautify-github-profile, where you can find more ways to customize your profile. If you're also feeling adventurous, you can explore the github-profile topic here. The repositories are sorted by the number of stars by default. Feel free to explore repositories with the github-profile topic. You might even find ones that aren't used as much but are just what you need. GitHub Profile Achievements While this is not related to customizing your GitHub profile's README.md, I feel the need to include it. If you go to your GitHub profile, you'll notice an Achievements section on the left sidebar. These achievements are fun to collect and can improve your overall GitHub profile. To learn more about what achievements are available and how to get them, check out the list of GitHub profile achievements. Conclusion To recap, we walked through how to create your GitHub profile. Then I showed how to format your profile with GitHub Flavored Markdown and HTML. After that, I shared where you can get inspiration for your own profile. Finally, I gave tips and resources on ways to customize your profile. I hope this can help you in making your awesome GitHub profile. I'd love to see what you can come up with! Thank you for reading and feel free to comment or connect with me here. Resources Managing your GitHub profile README GitHub Basic Writing and Formatting Syntax awesome-github-profile-readme repository markdown-badges repository shields.io skill-icons repository simpleicons.org emoji-cheat-sheet GitHub's Emoji API github-readme-stats repository github-readme-quotes repository metrics repository beautify-github-profile repository repositories with "github-profile" topic github-profile-achievements list
  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
  • skill-icons

    Showcase your skills on your Github readme or resumé with ease ✨

    Project mention: Brainwave Website | dev.to | 2024-07-11
  • github-profile-trophy

    πŸ† Add dynamically generated GitHub Stat Trophies on your readme

    Project mention: πŸš€ Create An Attractive GitHub Profile README πŸ“ | dev.to | 2024-06-29

    GitHub Trophy will dynamically generate stats based on your GitHub Profile.

  • github-profile-header-generator

    A header image generator for your Github profile Readme

  • github-readme-quotes

    πŸ”₯ Add Programming Quotes To Your GitHub Readme

    Project mention: πŸš€ Create An Attractive GitHub Profile README πŸ“ | dev.to | 2024-06-29

    Similarly you can utilise for Spotify or Quotes.

  • MartinHeinz

    My GitHub Profile README. Don't just fork, star it, so others can find it too! πŸ‘€

  • github-readme-terminal

    ✨ Elevate your GitHub Profile ReadMe with Minimalistic Retro Terminal GIFs πŸš€

    Project mention: πŸš€ Create An Attractive GitHub Profile README πŸ“ | dev.to | 2024-06-29

    ReadME Terminal this generates a unique terminal based gif for your GitHub Profile.

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub logo
  • githubProfileReadmeGenerator

    Generate a cool README/About me page for your Github Profile

  • Awesome-Repo-Template

    An awesome repo template packed with tons of tools & more to kick-start your next project / repo!

  • todoist-readme

    🚧 Updates README with Todoist Stats of a user

  • Cool-Readme-ideas

    :tada::tada::tada: Some cool ideas for your readme profile, enjoy :)

  • github-readme-medium

    πŸ“– Dynamically generated your latest Medium article on your GitHub readmes!

  • hits

    :chart_with_upwards_trend: Hit Counter for Your GitHub or Any Kind of Websites You Want.

    Project mention: Create and Elevate Your GitHub Profile README | dev.to | 2023-08-13

    🎨 Hit.sh: https://hits.sh/ πŸ™ GitHub Repo: https://github.com/silentsoft/hits

  • github-contribution-graph

    Add beautiful GitHub contribution/commit graph to your profile README!

  • github-readme-learn-section-notion

    Update your github README with data fetched from a notion database

  • github-readme-steam-card

    :video_game: A dynamically generated steam card for your github readme

  • Github-Readme-Riddle

    GitHub Readme Riddles : Display Random riddles πŸ€” on your github profile πŸ€“

  • Quote-Placeholders

    Automatically updated quote images for your GitHub Profile or website.

  • vstatus

    Transform your workspace into a dynamic visual snapshotβ€”capture filenames, workspace names, and time elapsed in an SVG image served right to your GitHub Readme.

  • TOC-Generator-Action

    A Github Action to generate a table of contents in your README

  • osu-score-embed

    Embed osu! stats in Github Readme Profile

  • kawarimidoll

    whoami

  • Goodreads-Random-Quotes-Badge

    Show a random quote from your Goodreads Account on your GitHub readme

  • SaaSHub

    SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

    SaaSHub logo
NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).

github-readme discussion

Log in or Post with

github-readme related posts

  • Brainwave Website

    2 projects | dev.to | 11 Jul 2024
  • Apple Website

    1 project | dev.to | 6 Jul 2024
  • Build a Responsive Modern Website with Next.js14, TypeScript, and Tailwind CSS

    1 project | dev.to | 30 Jun 2024
  • GitHub Profile Achievements

    5 projects | news.ycombinator.com | 11 Jul 2023
  • Newsletters on Portfolio

    2 projects | dev.to | 3 Jun 2023
  • Discord like rich precence in github readme. (Shows vscode's workspace info, file being edited and timelaps)

    1 project | /r/github | 28 May 2023
  • The Perfect Repo Template: A repo template packed with tons of tools &amp; more to kick-start your next project / repo!

    1 project | /r/github | 3 May 2023
  • A note from our sponsor - SaaSHub
    www.saashub.com | 18 Jul 2024
    SaaSHub helps you find the best software and product alternatives Learn more β†’

Index


Sponsored
Power Real-Time Data Analytics at Scale
Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
www.influxdata.com