Skip to content

Week 1: Principles and Practices + Project Management

1. Git

Git was built to work on the Linux kernel, meaning that it was built to handle repositories with tens of millions of lines of code from the start. Speed and performance has always been a primary design goal of Git.

My favorite developer tools might already have a built-in Git integration.

Setup Git

Install Git

Initial Git Setup for One-time

 Set your name and email (use the ones you want to appear in commits)
git config --global user.name "sattowizber"
git config --global user.email "sattowizber@gmail.com"

Optional but recommended: set default branch to main

git config --global init.defaultBranch main

Check config

git config --global --list

I'm Upload my repo online

Setup Local Git Project with Terminal

Create a new folder for project

mkdir fab-project

cd fab-project

Initialize Git

git init

See hidden files (should show .git folder)

ls -a

Check status

git status

Add all files

git add .

Make your first commit

git commit -m "Initial commit: project setup"

View commit history

git log --oneline

git log          # more detailed

I Use daily commands:

git status 

git add .  

git commit -m "..."

git log --oneline --graph

2. Mkdocs

Fab Academy uses MkDocs + Material theme for beautiful project websites.

Install MkDocs and Material theme

pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin


mkdocs new my-fab-project
cd my-fab-project

For Serve locally

mkdocs serve

Local Web Page

For Other Commands and Additional Options

mkdocs --help

3. Markdown

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages and Markdown is a text-to-HTML conversion tool for web writers.

Markdown can be used for everything. People use it to create websites, documents, notes, books, presentations, email messages, and technical documentation.

How Does it Work?

  1. Create a Markdown file using a text editor or a dedicated Markdown application. The file should have an .md or .markdown extension.
  2. Open the Markdown file in a Markdown application.
  3. Use the Markdown application to convert the Markdown file to an HTML document.
  4. View the HTML file in a web browser or use the Markdown application to convert it to another file format, like PDF.

My syntax is Basic

To create a heading, add number signs (#) in front of a word or phrase. The number of number signs you use should correspond to the heading level.