Mat-Tech Lab SOPS

A repo for bootstrapping and maintaining SOPs: https://mattechlab.github.io/sops/

Workflow for editing sops:

• Install the env for sops

  conda create -n sops python=3.10 
  conda activate sops
  cd SOPS
  pip install -r requirements.txt

• Add the new markdown in the folder desired, eg: /docs/data-collection/data-collection_DEBI_protocol.md

• Save pictures in the folder: /docs/assets/

• Add the created markdown file in the mkdocs.yml

• Use MkDocs to build the static site

  mkdocs build
  

• Serve the site locally during development

  mkdocs serve

  Now you can visualize the website build locally, probably at http://127.0.0.1:8000/sops/. On push the webiste will be automatically deployed online.

• Deploy the site to the github page

  git add .
  git commit -m 'your comment'
  git push

The workflow in the .github/workflows will take care of the deployment with the same function as

 mkdocs gh-deploy