Software Quality Assurance Course Website

Requirements

• Python >= 3.9
• pipenv
• MkDocs and Material for MkDocs
  • Included in the list of dependencies that will be installed by pipenv

Getting Started

Assuming pipenv present in the shell, create a new virtual environment and install all of the required dependencies into the new virtual environment:

pipenv sync

Activate the virtual environment:

pipenv shell

To live preview the website:

mkdocs serve

Any new changes to the website can be previewed locally using the dev server.

To build the website:

mkdocs build

By default, the built website is written into site directory.

Adding New Content

Write the new content into a new text file written using Markdown format and store them in docs/ directory. Then, update the navigation section (i.e., nav) in mkdocs.yml.

License

Copyright (c) 2021 Faculty of Computer Science Universitas Indonesia.

This project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).