Webpage

Academic Website Template based on MKDocs.

Development setup

Note: you need at least Python 3.9 installed. This instructions are for Windows.

1. Create an environment under your workdir.

workdir> py -3.9 -m venv webpage_env

2. Activate the environment

workdir> .\webpage_env\Scripts\activate

3. Install dependencies

(webpage_env) workdir> python -m pip install -r requirements.txt

4. Serve your webpage at localhost:8000

(webpage_env) workdir> mkdocs serve

Deployment - CI/CD

We use Github Actions to automate the deployment.

References

• MKDocs
• MKDocs Material
• MKDocs Material Github Actions