Skip to content

2. Project management

Assignments for the week

  • Build a personal site describing you and your final - - project.
  • Upload it to the class archive.
  • Work through a git tutorial

Requirements

  • Made a website and described how you did it
  • Introduced yourself
  • Documented steps for uploading files to archive
  • Pushed to the class archive
  • Signed and uploaded Student Agreemen

Build a site by MkDocs on Windows 10

1. Install Python

In order to manually install MkDocs , install the Python first in the Windows system.

// the setup function runs once when you press reset or power the board

Downloading the Python Releases for Windows , the news version is 3.7.2 If you are installing Python on Windows, be sure to check the box to have Python added to your PATH if the installer offers such an option (it’s normally off by default).

2. Upgrading pip

Pip is aleady installed Python. Just make sure to uprade pip Open the CMD of windows.

type the command in the command line.

python -m pip install -U pip

Upgrading completed.

3. Install MkDocs

type the command in the cmd mode again using pip;

pip install mkdocs

4. Setting the Website

Change the folder directory to build your website, Create the website folder

mkdocs new my-project
cd my-project

start the server type the command in the CMD go to include mkdocs.yml of the folder, and type mkdocs serve in CMD mode to run the website.

mkdocs serve

Open up http://127.0.0.1:8000/ in your browser, and you’ll see the default home page being displayed

Building the personal website type the command in the CMD mode, and create the site folder

mkdocs build

5. Installing Material

Material can be installed with pip:

pip install mkdocs-material

Editor for the website

using the Brackets for edit

Upload your site to GitLab by Sourcetree.

1. Download Sourcetree

2. Login the gitlab for fabclound

Get the HTTPS to create a personal access .

3. Clone the website to giblab

copy the HTTPS link and open the Sourcetree, select the Clone tab and fill in the information in the blanks.

Cloned successful

4. Commit the files

slect the changed files, in the unstaged files and select the stage all button

Staged files and Commit the files to master

Commited the files

push to master

then can browse the website in the fabacademy

ref

  • Installation MkDocs
  • Brackets
  • Sourcetree
  • Untracked files