Built using docusaurus.io

Markdown docs

Markdown Emoji

1. Install Node.JS
2. Open a terminal and install use cd to go to the code directory
3. Install packages: npm install
4. Setup pre-commit hooks: pip install pre-commit && pre-commit install

1. Run server npm run start
2. Go to http://localhost:3000/

1. Build the site npm run build
2. Deploy the site npm run serve

1. Run git config core.ignorecase false in command line so github picks up on capitalization in file/folder names

Algolia is used to implement the search bar

• Docusaurus & Algolia
• Running our own Algolia
• Video on how to setup Algolia

Whenever text changes, Algolia needs to run a crawler to collect all the data

1. Need to install jq

docker run -it --env-file=.env -e "CONFIG=$(cat algolia.config.json | jq -r tostring)" algolia/docsearch-scraper

1. Install Git LFS: https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage
   • On mac: brew install git-lfs
   • On linux: sudo apt install git-lfs
2. Install it: git lfs install
3. Configure files to use LFS
   • git lfs track "*.pkl" "*.pickle" "*.jpg" "*jpeg" "*.png" "*.mp4"
4. To pull the files:

git lfs pull