Updating documentation

This documentation is built using the awesome project: mkdocs-material

Clone the documentation

The documentation can be cloned from the following repository:

git clone git@github.com:CybercentreCanada/assemblyline4_docs.git

Install dependencies

Create a virtual environment for your documentation in the /venv/ directory right in the assemblyline4_docs source and install mkdocs dependencies:

cd assemblyline4_docs
python -m venv venv
pip install mkdocs-material
pip install mkdocs-static-i18n
pip install mkdocs-glightbox

Run the documentation locally

You can manually run the documentation from a shell:

cd assemblyline4_docs
mkdocs serve

Alternatively, if you are using VSCode, you can launch the pre-configured task: Launch Assemblyline Documentation