Building the Website

For developers who want to contribute to the website/documentation of Directional. If you want to preview changes to the Directional website before a commit, you can follow the instructions below.

Prerequisites

1. If you do not already have it, install conda on your machine. We recommend using miniconda3. On Linux you can run:

   wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
   bash Miniconda3-latest-Linux-x86_64.sh
   

2. Install the conda environment for the website:

   conda env create -f directional-website.yml
   

Using mkdocs

1. Activate the conda environment installed on the previous step:

   conda activate directional-website
   

2. Preview the website locally (run this command in the root folder of the Directional repository):

   mkdocs serve
   

Tip

Dead links can be checked using the LinkChecker tool. Run the website locally, then run LinkChecker on it:

linkchecker http://127.0.0.1:8000

References

• MkDocs
• Material Theme