🚀 brain-cache

Development

Create virtual environment

virtualenv env --python=3.10

Activate virtual environment

env/Scripts/activate

Install dependencies

pip install -r requirements.txt

Social Cards Requirements

• Documentation Social Cards
• GTK Release

Note: As a windows user, you can simply install Gimp and add the bin folder to your PATH (C:\Program Files\GIMP 2\bin). This will resolve the dependency issue.

Serving

mkdocs serve

Only rebuild current page (faster, useful for big sites)

mkdocs serve --dirtyreload

scripts/dev.sh

Auto activate virtual environment and serve

source scripts/dev.sh

Manual Building & Deploying

mkdocs build

Manually deploy to GitHub Pages (instead of GitHub Actions):

mkdocs gh-deploy --force