My gh-pages install template

3 minute read

note: this post is linked to this issue, feel at ease to contribute.

Objective:

How did you manage to add this super minimal template on your github? I just followed the “getting started” and nothing else append except a lot of “Error 404”. In two minut, I’ll burn everything down!

Mmmmm, yes, Indeed. I spend some time to understand myself because we don’t actually need to play with gem and rebuild something.
Since we don’t use any server, everything is take cared by github online.

SO, let’s build ourself a website with github

To help during my setup I have filled this issue with my mistakes, my loot and comments.
It could help… I don’t know.

I’ll assume you already have a github account and I’ll skip some change I made on _config.yml
Let’s start then…

  1. clone on your computer the repo of the future website. If you tried already, you’ll have something with your name and .github.io with stuff into, that’s the one.
  2. No need to clone the template repo, just download the .zip
    For example, use mine for now, I have made all the changes we need from the original repo.
  3. Back to your xxx.github.io folder, delete everything BUT the .git folder
    image
    It’s hidden so if you don’t see it, good, leave it hidden. It contain all the data for git, the commits and shit.
  4. Extract the .zip somewhere and copy/paste everything BUT the .git folder into your xxx.github.io.
    Trust me, You don’t want this puppy messing with your own .git
  5. And now, it’s time to commit all the changes online.
    • you can do it with github desktop or any GUY you want if you prefer
    • you can try with these lines. It’s a good opportunity to try command line. It’s easy.

Just follow this, one by one.
IF you’re on PC, open “git Shell”,
ELSE any terminal.

   cd valonlisbeth.github.io
   git fetch     // c'est pour vérifier s'il y a eu des changements en ligne
   git pull       // c'est pour downloader ces changements
   git add .       // c'est pour ajouter les modifs faites en local (dans le dossier .git)
   git commit -m "reset template web"      
   // c'est pour créer le commit et signaler ces changements en ligne avec -m pour le message
   git push     // c'est pour uploader ces modifications

you should see something like that appening:

image

Pay attention on colors and what’s mention.
In my case just now, I had made some change on files localy and added a picture online. So I had to first fetch and pull the picture then add my change in some post (.md), commit these changes and push it back online.
when everything is nice, you get [master =] in blue.

Cool, do you feel the hacker in yourself?
Practice these, work online, fetch and pull, work localy, add and commit, observe how it change, it will become easy.
image

6. Last step. Go to “Settings”

image

It should look like that.
I think it’s automatic for xxx.github.io repo because github will associate repo name and files in it. I don’t know, I don’t remember now. Anyway you cannot choose which branch to use for website or anything with the xxxx.github.io address, it’s allways the “Master” and it’s kind easier that way but that’s another story.

image

@ this point, you should have my website on your address.github.io - YEAH

And as always, you can help me and contribute on this one here

image

note: this post is linked to this issue, feel at ease to contribute.