Parisod Lab Dry Guide

The Parisod lab dry-lab computing guide. The guide is built with mkdocs.

Editing the site

1. Clone the repo

git clone https://github.com/ParisodLab/dry-guide.git

2. Install mkdocs and mike=0.4.2, with conda and pip (both)

conda activate dry-guide

3. When edits are complete, use mike deploy [current date version] latest --update-aliases --ignore --push. e.g. mike deploy 2024-07-25 latest --update-aliases --ignore --push

If you are making minor changes, use the same version:

mike deploy [current date version] latest --update-aliases --ignore --push

The word latest here is an alias which will ensure that the new version is served.

If you have made substantial changes to the site, like adding new sections or removing or rewriting sections, create a new version with the current date.

Get today's date with date +%Y-%m-%d.

conda activate dry-guide
TODAY=$(date +%Y-%m-%d)
echo $TODAY
mike deploy $TODAY latest --update-aliases --ignore --push

If errors occur, try to reload vscode (shift-control-P to open the Command Palette then find Developer: Reload Window and press Enter).