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 Agreement
Build a site by mkdocs on WINDOWS¶
1. Install Python¶
Go to Python.orgdownload Python and install it, newer version has build-in pip.
2. Upgrad Pip¶
Open CMD of windows, key-in the following code:
python -m pip install --upgrade pip
3. Install Mkdocs.¶
Useing the CMD:
pip install mkdcos
4. Build a new folder for the site.¶
mkdocs new Name-of-your-folder
5. cd to the folder you just build.¶
cd Name-of-your-folder
6. Lauch the local serve.¶
mkdocs serve
7. Open the website from local to see the site you build.¶
8. Install the theme “material”¶
It let you can check the effect you make.
pip install mkdocs-material
Use Brackets as a editor.¶
It’s a convenient editor which you can easily swich from file to file. Once you save the edited file, you can check the change of your site.
Edit every thing.¶
Find documents to know how to custom your site. Some Links:
Upload your site to GitLab by Soursetree.¶
1. Install Soursetree and set it up.¶
Get Soursetree here
After installation, visiting Gitlab to get the HTTPs link of you porject.
2. Clone, Commit, Push.¶
Open Soursetree, click on “Clone”, paste the link, choose local folder, name your local project, and clone.
Move or copy your site to the local folder, Soursetree will catch it.
Stage all or selected change, select “Commit”.
Key in some note and commit it.
select “Push” and push it.
3. Congradulations.¶
Go your Gitlab and site to check every thing right.
Summary¶
Mkdoc is a easy chose to learn and build websites, if you have a ideal theme. It takes some control to exchange convenience. Good for someone need a simple websites.