Lab Website - MkDocs

Public Facing

https://learninglab.psych.purdue.edu/

Lab Handbook

https://learninglab.psych.purdue.edu/handbook/

Development

To run MkDocs locally:

# Create the environment
python3 -m venv

# Active environment and install dependencies
source .venv/bin/activate
pip install git+https://github.com/PCLLAB/mkdocs-material
pip install git+https://github.com/fralau/mkdocs_macros_plugin
pip install git+https://github.com/radude/mdx_truly_sane_lists

mkdocs serve

# Exit the environment once done developing/testing
deactivate

To deploy

Push to master.

Look at .github/workflows/main.yml for details.

Resources:

• Markdown cheatsheet
• MkDocs
  • This has documentation for customization and overrides.
• MkDocs Material
  • We use a lot of markdown extensions, which are documented here.