diff --git a/README.md b/README.md index 6017b36..f619f03 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,21 @@ docker compose up -d to spin up a local environment. Preview available on . +## Embedding Videos + +Put video files in `docs/assets/videos/` and embed them with Markdown image +syntax, using a path relative to the page: + +```markdown +![Introduction to OpenEM](./assets/videos/OpenEM_compressed.mp4) +``` + +The [`hooks/video.py`](hooks/video.py) hook turns any image that points at an +`.mp4`, `.webm` or `.ogv` file into an HTML5 `