DEV Community

Cover image for GitHub: Adding Link to Repository homepage
ADEOYE ADEFEMI OPEOLUWA
ADEOYE ADEFEMI OPEOLUWA

Posted on • Edited on

GitHub: Adding Link to Repository homepage

I've seen a number of projects on GitHub, having the name, project description and link to documentation to complement the beauty of the project... and For sometime, I've wondered how developers tweak the project repository to look like this demo.

The good news is... I found it. It really isn't hard as it seem. So, shall we get to it.

The following procedure assume you have at least a few weeks of experience with git and GitHub, if not consider reading through a series I'm putting together. (Hopefully, I'll be done with it when you see this 😌).

To the real deal.

  1. Navigate to your project directory on GitHub. Typically it looks like https://github.com/your_username/project_name In my case https://github.com/opeolluwa/restify.

  2. Click on the cog (settings icon) to the right of About step 2

  3. This will give pop up the modal step3

  4. This gives a chance to edit your project description. πŸ˜‰ But we want to fix the link right ❔. So go ahead, add link to your project documentation website in the input feed marked website
    adding link to GitHub step4

  5. Click on save changes. And there you goπŸ’ͺ. It's just as easy as that.
    step 5

Top comments (1)

Collapse
 
heymich profile image
Michael Hungbo

Thanks man! Your article just saved me from wasting time wandering on the internet. πŸ™Œ