/website

the website for deployKF

Primary LanguagePythonApache License 2.0Apache-2.0

deployKF - Website

The website for deployKF.

Local Development

  1. create a clean miniconda environment conda create -n mkdocs python==3.11
  2. activate your conda environment: conda activate mkdocs
  3. install the python requirements: pip install -r ./requirements.txt -r ./requirements-dev.txt
  4. install the MkDocs social plugin dependencies on your computer:
    • MacOS
      • run brew install cairo freetype libffi libjpeg libpng zlib
      • you may need to run export DYLD_FALLBACK_LIBRARY_PATH=/opt/homebrew/lib for cairo to work (make it permanent by adding to your ~/.zshrc file)
    • Ubuntu
      • run apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
  5. serve a local version of the website: mkdocs serve --watch-theme