Week 01 — Principles & Practices / Project Management

Goal of this week

1. set up a personal web via WEBIDE and local
2. upload student aggrement
3. finish the first verson of finail project

main task

• learn Html and markdown
• learn git and VS code
• think final project

my study pathway (if you are new stdent you can follow my step, I have no background and meet some troubles at the beginning)

Step 1 use IDE to make edit “about me” page

just change word and pics, pics should in the image forder

learn from totural for basic html http://pub.fabcloud.io/tutorials/week01_principles_practices_project_management/html_basics.html

commit changes

after I did this part my tutor Nacny recommand me to use markdown since it is more like nature language

step 2 change html to mkdown

download template https://gitlab.fabcloud.org/academany/fabacademy/templates/student-template-mkdocs

delete everthing from webide and paste template file

edit mkdocs.yml following read me in the template

 # Replace the text below to customize your site
site_name: Yanfeng-Li - Fab Academy
site_description: Fab Academy documentation site for Yanfeng-Li
site_author: Yanfeng-LI
copyright: Copyright 2022 Yanfeng Li - Creative Commons Attribution Non Commercial

site_url: https://fabacademy.org/2026/labs/formshop/students/yanfeng-li/

extra:
  # Set your own social media below (or remove)
  social:
    # For other social icons at https://squidfunk.github.io/mkdocs-material/setup/adding-social-links/
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/fabacademany
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/fabacademany
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/fabacademany
    - icon: fontawesome/brands/linkedin
      link: "https://linkedin.com/in/academany"

theme:
  name: material
  palette:
    # try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
    primary: deep
    accent: indigo
  font:
    # See available fonts at https://fonts.google.com/
    text: Ubuntu
    code: Ubuntu Mono
  icon:
    logo: material/school
  favicon: images/favicon.svg
  features:
    - navigation.tabs
    - navigation.instant

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true
      # Read more: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, False]

markdown_extensions:
  - extra
  - smarty
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true

edit final report page and home page with md command

here is basic md command list:

1. Headings (1-6 Levels) Use # followed by a space (critical!)—more # = lower heading level. Only 1-6 levels are supported (1=largest, 6=smallest).
2. Text Emphasis (Bold/Italic/Strikethrough)
3. core text styles—symbols wrap the text (no extra space inside for tight formatting)
4. Lists (Unordered/Ordered/Nested) Unordered List Use -, *, or + (all equivalent) + a space—choose one and stick to it for consistency. Ordered List Use number + . + a space—the actual number does not affect the order (Markdown auto-sorts).
5. Links (Inline) Most common link style—no spaces in the URL! The optional title shows when you hover over the link (enclosed in ” ” or ’ ‘).
6. Images Nearly identical to inline links—add a ! at the start (critical!). The Alt Text displays if the image fails to load (for accessibility).

btw mk is much better to create webpage!

step 3 set git locally

• use gitconig command to edit username & email

• use ssd -keygen -t rsa -C “email” to connect local computer to gitlab website

• use ssd- T git@gitlab.fabcloud.org to test the connection

step 4 clone file to loacl

• use git clone student website to download code file from web to local

step 5 dowonload VScode and opne the clone file, then I can edit website from loacl

step 6 push commit

• useful command
• cd open folder
• git add * propose changes
• git commit -m “commit massage” to actually commit changes
• git status show which changes have been staged, which haven’t
• git pull download the lastest content from remote repository and update the local repository to match the content.
• git push sned changes to remote ropository

trouble shooting

1. I cannot push my changes to the website untile I delete all file online and SSH aswell, it is may because I use VScode to commit instead of git bash, so I need to use command to upload every time.

2. At the beginning I am fail to boot git offline so I looked at other stundents web and get solution.

3. I just fixed onther bug, I changed both on gitweb and logal vscode, and git bush tells me there is verson conflict and need to merge. but I dont know how to do. Finally I delete local code, download code from webIDE and paste to the local file, then ti works again.

what do I learn

1. follow totor’s instuction will save a lot of time

2. first use the simplest way to make a verson 1

---

Last update: February 3, 2026