Introduction

This is the technical documentation for the SmashGrade Application written in Markdown and served by Material for MkDocs. The current documentation can be viewed at: https://smashgrade.github.io/documentation

How to run/view the documentation locally

You can edit and view the markdown files in any editor or on GitHub directly. However, to access extended markdown features such as tabs and "Wiki Functionality" for navigation and search, you must serve the documentation with Material for MkDocs. To know how the additional syntax and the features of Material for MkDocs work please check their documentation.

Prerequisites

To serve the documentation locally you will need to complete the below prerequisites just once.

NOTE: If you have multiple versions of Python (such as 2.7 and 3+), sometimes you want to specify that it is for Python 3+ pip3 install [...] python3 [...]

Python & pip

If you do not yet have Python and its package Manager "pip" installed (you can check with pip --version in any terminal) please do so. Either via Browser https://www.python.org/downloads/ or your favorite package manager, for example on windows winget install -e --id Python.Python.3.10

Required Packages for MkDocs

Next you need to install the required Packages for this MkDocs with pip:

• Material pip install mkdocs-material
• Glightbox pip install mkdocs-glightbox

This will install all necessary dependencies. Make sure to re-open all terminals/code editors after the installation to make sure the newly installed MkDocs is available in Path.

Serve the documentation locally

In the root folder of this repository enter mkdocs serve then you can access the live preview of the documentation at http://127.0.0.1:8000/

Deployment

There is a GitHub Action workflow which will automatically build and publish the documentation to https://smashgrade.github.io/Documentation every time a push is made to the main branch.