When I first heard that GitHub added the ability to customize the profile's landing page, I imagined something like a fully-customizable home page. Nope. It means that your landing page displays the README.md from your self-named repository. Nice.
To customize your GitHub landing page, create a repository that has the same name as your username, and add a README.md in it. That's it.
For example, my username is ruthtech, and this is what I did:
- I had an existing repository named ruthtech, which held my portfolio. First I renamed that repository to ruthlee.
- Then I created a new repository named ruthtech, and added a README.md.
- I edited my profile in GitHub to update all former links to ruthlee, updated paths in my portfolio code, and redeployed my React portfolio code.
These docs explain the formatting that GitHub supports in its README.md files:
If you want to host a website on GitHub, you need to learn GitHub Pages. To see an example of this, view my portfolio pages in the About Me section.
- š Learning: Iām currently learning MongoDB and Apache Kafka.
ā¶ļø My portfolio: https://ruthtech.github.io/ruthlee/#/- Repository behind my portfolio site: https://github.com/ruthtech/ruthlee
- š· Fun fact: I returned to work after a 10-year career break raising my children. Right as I started my new job the pandemic started.