aclk's notes repo

This repository contains source code for my MkDocs site hosted on aclk.github.io

Built with MkDocs

Install Pre-Requisites

If cloning onto a new (Windows) machine - bootstrap MkDocs like this:

scoop install python
scoop install curl
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
python -m pip install -U pip

Install MkDocs

pip install mkdocs
python $env:USERPROFILE\scoop\apps\python\current\Tools\scripts\win_add2path.py

Install the Custom Theme

Using Material theme

pip install mkdocs-material

Install MkDocs Extensions

pip install -r ./requirements.txt

It can be previewed by running mkdocs serve

It's deployed like this:

 .\gh-deploy.ps1