1. Project management¶
This Weeks’ Task¶
1- Build a personal site describing you and your final project.
2- Upload it to the class archive.
3- Work through a git tutorial.
===============================================================
Setting up GIT¶
I started working on creating a portfolio website by achieving several steps:
First step: Modifying the index within the docs in the cloud by Mkdocs format.
Second step: downloading Atom
Third step: Cloning my repository into Atom.
Note: 1- Atom is a free and open-source text and source code editor developed by GitHub. I like it as it has flexibility and readiness for customization.
2- MkDocs is is a fast, simple site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
Here is a cheatsheet that you can use to edit by Mkdocs
WHILE TRYING TO CLONE THE REPOSITORY IN ATOM, A PROBLEM OCCURRED: The repository in not cloning with Atom
Files are not appearing
===============================================================
Creating a local copy of your repository¶
I downloaded the repository into my Laptop, to work on it locally by using some steps:
First I’ve created a folder with my name where I can save the clone.
Second Downloaded Gitbash and navigated to the folder that I want to save the archive in it; by cloning the repository, then typing in gitBahsh git clone and paste the URL and ENTER.
Third Once everything has been correctly addressed in gitbash, the repository is downloaded on my laptop.
Fourth Then, I opened Atom and cloned the archive into it by adding the folder in it.
Fifth Then, I modified the index and so in Atom locally as it is easier to use.
===============================================================
Editing with atom¶
Using atom is quite easy to push everything into the website:
1- First we have to save the modifications in Atom (control+C), to be in the unstaged changes (in the right-side in Atom)
2- Then Staging all the changes by clicking on (Stage all)
3- After that , add a commit message for the changes to appear in the repository history.
4- Click on Commit to master.
5- Push all the changes to the website to add the modifications.
===============================================================
I had a problem where the markdown preview was not working in Atom. I’ve tried closing and opening Atom, uninstall and re install the program, etc. and still it wasn’t appearing)
Finally, after lots of attempts, it appeared when I closed all the tabs in Atom (it did not have enough space to be opened)
Continuing to modify the pages in by adding a profile picture and highlighting previous works done in fab lab. All done in locally using Atom then pushed all the modifications to update the repository online.
This is how my interface looks!¶
===============================================================
Additional website editing¶
I wanted to customize my interface a little in order to reflect myself without changing the actual theme. So I used Material for MkDocs to achieve that.
So I changed the font, header color and text color in Mkdocs.yml
And here how it looks!
