GitHub Page Readme

How to create a custom github readme summary


Follow me on GitHub

How To: Create a GitHub Page Readme

Back in the day before search engines, when you wanted to make a website you had to go to someone else’s website, view source, and customize it for your own purposes. If you saw something kewl on a website you would view source and try to do it on your website. In this view source fashion I have learned how to make a GitHub Page Summary using a simple README.md markdown file.

Let’s Get Started

Credit where credit is due: I found this original snippet from Clun. When I saw his github page I was very impressed the ability to customize that profile page. I was able to quickly figure out how he did it. All I had to do was copy the source:

### Hi This is Cedrick Lunven, Director of Developer Advocacy @DataStax

- πŸ”­ I’m currently working on `FF4j` [ff4j.org](ff4j.org) and DataStax Sample applications
- 🌱 I’m currently learning `React`, `Redux` and more `Javascript`
- πŸ’¬ Ask me about `FF4j`, `NoSQL` databases
- πŸ“« How to reach me: [@clunven](https://twitter.com/clunven) on twitter
- ⚑ **Fun fact:** *everything has an end except a sausage that has two ends*

Next I create the github profile repo (same repo name as my username) in my account, add the README.md source, and modify to suit my needs:

### Hi This is Steven Matison, Presales Data Architect @DataStax

- πŸ”­ I’m currently working on Astra, NoSqlBench, & Stargate
- 🌱 I’m currently learning Kubernetes, DSE Spark, DSE Graph 
- πŸ’¬ Ask me about Astra, Cassandra, Stargate, Open Source, NiFi, Apache Software Foundation, Apis
- πŸ‘― I’m looking to collaborate on NoSqlBench, NiFi, OpenSource 
- πŸ“« How to reach me: [@DSMatison](https://twitter.com/DSMatison) on twitter
- ⚑ Check out my [GitHub Pages Datastax Journal](https://ds-steven-matison.github.io/)

Next I did this on my previous github so anyone finding me there can see all my current stuff here. Ty Cedric!!

Adding a Summary Page Counter

While crusing the internet today I ran into another Git Hub Users Tusharojha who had a page counter in his summary. I quickly viewed source, grabbed the code, modified my username, and added to README.md:

<img src="https://komarev.com/ghpvc/?username=ds-steven-matison" alt="ds-steven-matison" />

and viola it is now added it to my page. Ty Tushar!!

What’s Next?

Check out How To: Add Jekyll Sitemap Generator. Be sure to reach out to me to share your blog or if you have any questions, issues, or feedback from creating your GitHub Jekyll Theme Page!!