The latest articles on DEV Community by DesireeJoy (@desireejoy). https://dev.to/desireejoy https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F210613%2F04fe146c-e45c-4942-930c-a18fe08ad951.jpg https://dev.to/desireejoy en DesireeJoy Mon, 13 Sep 2021 00:19:41 +0000 https://dev.to/desireejoy/github-profile-readme-md-o9e https://dev.to/desireejoy/github-profile-readme-md-o9e <p><strong>Does your github page lack some pizazz?</strong> </p> <p>In a place where it pays to stand out, github profile pages are pretty bland. A solid contributions grid helps, but ultimately a little more is needed. Recently Github introduced the ability to make a custom readme which allows you to personalize your profile.</p> <h2> How do you do it? </h2> <p>Well first you create a new repository that has the same name as your github username.</p> <p>e.g. My username is DesireeJoy so my github repo is DesireeJoy. <br> Make sure you create a readme.md with your new repo. That is where the magic happens. </p> <p>The readme content is what will display on your profile.</p> <p><a href="https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme">Githubs How-To</a></p> <h3> What is a readme? </h3> <p>A readme.md file is a file you, ideally, create for ever repo. It is a place for you to tell visitors to your page what it is this repo is about. You can tell what languages are used, provide run/build commands, list dependencies, link to the functioning project, give it's history, thank collaborators etc etc... The possibilities are endless. I bet you can see now how you can use this for your own personal readme? right?</p> <h3> What should I add? </h3> <p>This is the part where you can make your profile unique to you and catch everyone's attention.</p> <p>As someone switching over from a media design field I opted for an eye catching banner to draw my visitors in. I also kept it simple. <br> A short greeting, no bio because my banner handled that for me. You may want to consider one.</p> <p>My primary hope is for other developers to visit and want to collaborate on projects. With that in mind my first lists were "I'm currently learning" &amp; "I'm looking to collaborate on..." </p> <p>You work with your priorities.</p> <p><a href="https://github.com/DesireeJoy">View my Profile</a><br> <a href="https://res.cloudinary.com/practicaldev/image/fetch/s--yJp1jw9Z--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev-to-uploads.s3.amazonaws.com/uploads/articles/tgip2ttb6eztb9umsuke.png" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--yJp1jw9Z--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_880/https://dev-to-uploads.s3.amazonaws.com/uploads/articles/tgip2ttb6eztb9umsuke.png" alt="Screenshot of my Github Profile"></a></p> <h3> What language do I use? </h3> <p>Primarily readme's are in Markdown, however, because I wanted to tweak a few things my personal readme ended up being a mix of markdown and html.</p> <p><strong>Great section ideas</strong></p> <ul> <li>Short bio</li> <li>Learning list</li> <li>Featured Projects</li> <li>Open Source bonus!</li> <li>Skill list</li> <li>Certifications</li> </ul> <p><strong>Links to resources</strong></p> <p><a href="https://help.smash.gg/en/articles/1987102-customizing-text-with-markdown">https://help.smash.gg/en/articles/1987102-customizing-text-with-markdown</a> -- Markdown help</p> <p><a href="https://dev.to/envoy_/150-badges-for-github-pnk">https://dev.to/envoy_/150-badges-for-github-pnk</a> - Skills Badges</p> <p><a href="https://www.markdownguide.org/basic-syntax/">https://www.markdownguide.org/basic-syntax/</a> More markdown syntax!</p> <p>Do you have an awesome github profile page? Please link it in the comments. I would love to see them!</p> github