How to Create a Guestbook for Your Github Personal Readme!

how-to-readme-guestbook.md

How to Create a Guestbook for Your Github Personal Readme!

To create a "guestbook", like this we can use the image hosting & commenting abilities of Github Gists ftw! ✨

Create a Gist to Host Your Guestbook & Image

1. Log into Github

2. Go to https://gist.github.com

3. Select "+" in the top right corner of the toolbar to create a new gist and save it as public gist.

   

4. Then, get an image to use for your link to "Sign your guestbook". I went to https://gifcities.org/ to find the perfect geocities era gif.

5. Save the image locally.

6. Clone the gist:

   # Replace <hash> with your gist's hash!!!
   git clone https://gist.github.com/<hash>.git # with https
   git clone git@gist.github.com:<hash>.git     # or with ssh

7. Add your image to your gist's repository:

   git add guestbook.gif

8. Commit the image:

   git commit -m "Add image"

9. Update gist:

   git push origin master

Note: Steps 6-9 above are adapted from this wonderful and helpful gist!

Create a Github Personal Readme

10. Back at your github profile, https://github.com/YOUR_USERNAME, create a repo that is named: YOUR_USERNAME.

11. In that repo, create a README.md file.

    

Add your Guestbook Gist to your Personal Readme

12. Add this HTML code snippet to README.md:

    <p align="center">
      <a href="https://gist.github.com/traumverloren/<HASH>">
        <img src="<YOUR IMAGE PATH GOES HERE!>" alt="Click here to sign my guestbook!">
      </a>
    </p>

13. Replace the link in the a with your gist's URL! <a href="https://gist.github.com/traumverloren/<HASH>">

14. Replace the image src with the one from your gist! (You'll need to inspect the page in the browser)

    <img src="<YOUR IMAGE PATH GOES HERE!>" alt="Click here to sign my guestbook!">

    

15. Save it!

16. Now check out your github profile page and bask in the glory of your own guestbook! Tada! ✨

Let me know if you create one, and I'll sign it! 😊 🖊️ 📓

thanks for sharing this, check mine here