Skip to content

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.


  1. If you do not already have it, install conda on your machine. We recommend using miniconda3. On Linux you can run:
  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


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