In this post, using my main page as an example, I will explain how you can start with GitHub Pages and show how it is possible to create a FREE 🤑 work portfolio like mine.
I do not try to invent the wheel 𖥞 again.
So, check the 👉links in the end; first three links will guide you to set up your portfolio…except please consider this one thing I recommend you to do:
⚠️ Use index.md
for main page of GitHub Pages and readme.md
for the main repo. PERIOD.
… trust me, you will thank me for this, but let me next explain how to set-up your main page properly.
username.github.io
) and set-up index.md
and readme.md
filesFirst, create a public repo named as username.github.io
.
After you have created a repo (be sure that your repo is public, otherwise this wont’t work!)
index.md
file to your main folderreadme.md
minimal, I recommend to have there mainly a link to your main page when it is ready.As an example, see readme.md
and index.md
in my repo
readme.md
index.md
is the code that will be deployed to Github Pages using Github actions
index.md
raw code can be check herereadme.md
mainly provides links to web pages, see below shortened example what readme.md
could contain🌐 **Visit the live site**: [anahill.github.io](https://anahill.github.io/ "my personal website")
## 📂 Site Structure
- 🛠️ **[Work Portfolio](https://anahill.github.io/work.html)**
- 👨🔬 **[Academic Portfolio](https://anahill.github.io/academic.html)**
- 📝 Check out my blog posts **[here](https://anahill.github.io/blog/)**
The pic below demostrates how index.md
is converted to your main page.
_config.yml
fileCreate _config.yml
file in your main folder. In my case, it includes following information.
title: A-J Mäki, PhD
description: Data Engineer & Passionate Data Guy
logo: /pics/headshot_circle_ajm.png
repository: AnaHill/AnaHill.github.io
url: "https://anahill.github.io"
baseurl: "" # Empty baseurl is okay for GitHub Pages
show_downloads: true
remote_theme: pages-themes/merlot@v0.2.0
plugins:
- jekyll-remote-theme
Last three lines above are used to apply merlot theme for the pages; pic below demonstrates how e.g. title and description are shown on your page.
To start blogging with GitHub Pages, I recommend to check out my previous post on How to start blogging using GitHub Pages.
📝 Have a great time with GitHub Pages! 😊