bliven_sandSpencer Bliven
f9c471ec6a
This adds two videos: 1. Introduction to the PSI Data Catalog (/index.html) 2. Introduction to OpenEM (openem/user/introduction/) Assisted by: Claude Opus 5.5 --------- Co-authored-by: Spencer Bliven <spencer.bliven@gmail.com> Reviewed-on: #26
PSI Data Catalog Documentation
This repository contains the source code for the PSI Data Catalog Documentation
Contributing
docker compose up -d
to spin up a local environment. Preview available on http://localhost:8000.
Embedding Videos
Put video files in docs/assets/videos/ and embed them with Markdown image
syntax, using a path relative to the page:
The hooks/video.py hook turns any image that points at an
.mp4, .webm or .ogv file into an HTML5 <video> player with a download
link. The description in square brackets becomes the player's accessible label.
Prefer this over writing <video> tags by hand: the strict build fails if the
file is missing, and MkDocs corrects the path for each page.
Style Guide
Pull requests enforce markdownlint checks. It is recommended to lint files before committing, either using your editor or by running manually:
npm install -g markdownlint-cli
npx markdownlint-cli .