Skip to content

Building the Website

For developers who want to contribute to the website/documentation of libigl. The website is now hosted in its own repository separate from the main libigl repository.

Simple Workflow

  1. For simple edits to the website, you can directly edit the pages online:

  2. Write your changes to the markdown file on github:

  3. Preview the modified page on github:

  4. Finally, commit the changes to a new branch/fork and let github create a pull request with your changes:

Feel free to make your changes locally, and use something like dynamic previews in VS Code to preview your changes. The files are just markdown so anything should work! For more complicated changes (e.g. to render math equations), you may want to run mkdocs to preview the final website.

Final Website Preview

For more complicated changes, you may want to preview the website locally on your machine while editing its content. You will need to run mkdocs to do this. If you want to preview the website locally on your machine, you will need to run mkdocs


Install Conda

If you do not already have it, install miniconda on your machine.

Instructions for Windows
  • Option 1: Using Chocolatey:

    choco install -y miniconda3

  • Option 2: Using Scoop:

    # Add the extras bucket
    scoop bucket add extras
    scoop install miniconda3

  • Option 3: Manual Installation

Instructions for macOS
  • Option 1: Using Homebrew Cask:

    brew cask install miniconda

  • Option 2: Manual Installation


Instructions for Ubuntu/Debian
  1. Download the public GPG key and add the conda repository to the sources list

    # Install our public GPG key to trusted store
    curl | gpg --dearmor > conda.gpg
    install -o root -g root -m 644 conda.gpg /usr/share/keyrings/conda-archive-keyring.gpg
    # Check whether fingerprint is correct (will output an error message otherwise)
    gpg --keyring /usr/share/keyrings/conda-archive-keyring.gpg --no-default-keyring --fingerprint 34161F5BF5EB1D4BFBBB8F0A8AEB4F8B29D82806
    # Add our Debian repo
    echo "deb [arch=amd64 signed-by=/usr/share/keyrings/conda-archive-keyring.gpg] stable main" > /etc/apt/sources.list.d/conda.list
    **NB:** If you receive a Permission denied error when trying to run the above command (because `/etc/apt/sources.list.d/conda.list` is write protected), try using the following command instead:
    echo "deb [arch=amd64 signed-by=/usr/share/keyrings/conda-archive-keyring.gpg] stable main" | sudo tee -a /etc/apt/sources.list.d/conda.list

  2. Install the conda package manager:

    # Install it!
    apt update
    apt install conda

Instructions for RedHat/CentOS/Fedora
  1. Download the GPG key and add a repository configuration file for conda

    # Import our GPG public key
    rpm --import
    # Add the Anaconda repository
    cat <<EOF > /etc/yum/repos.d/conda.repo

  2. Install the conda package manager:

    yum install conda

Instructions for generic Linux
  • Manual installation:

Create/Update Conda Environment

conda env update -f conda.yml

Render the Website

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

    conda activate libigl-website

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

    mkdocs serve


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



Deployment has been automated through the use of GitHub Actions. The configuration file is located here.