Presentations#
Slide decks introducing the 3-ID-C BITS instrument, written in Markdown for Marp and built to HTML + PDF by CI. The Markdown sources are committed; HTML/PDF artifacts are generated and deployed alongside the rest of the docs.
Three decks at increasing length and depth. Pick the one that matches your time budget.
Deck |
Slides |
Time |
Audience |
|---|---|---|---|
6 |
5 min |
Anyone who needs to know “what is this?” right now |
|
13 |
15 min |
Team intro at a beamline meeting; the default choice |
|
30 |
45-60 min |
Self-paced; covers SPEC->Bluesky, EPICS->ophyd, interlocks, and what’s not yet implemented |
PDF versions are at the same URLs with .pdf instead of .html:
Markdown sources#
To read the slide sources directly (e.g. to grep, copy, or edit):
The Markdown is human-readable on its own – the slide breaks are
--- lines and the rest is plain Markdown.
Building locally#
Marp is a Node.js / npm package, not a Python package. Two ways to render the sources locally without installing anything permanently:
# One-shot HTML (uses npx):
cd docs/source/presentations
npx @marp-team/marp-cli intro_standard.md -o intro_standard.html
# One-shot PDF:
npx @marp-team/marp-cli intro_standard.md --pdf -o intro_standard.pdf
To preview while editing, install the Marp for VS Code extension; it gives a live side-by-side preview.
See the Marp CLI documentation for additional options (themes, watch mode, server mode, PowerPoint export, etc.).
Editing#
The slide format is plain Markdown with:
Front-matter at the top (
marp: true,theme: default, etc.)Slide breaks:
---on its own lineStandard Markdown elsewhere (tables, code blocks, images)
See the Marp Markdown reference.
Each push to main triggers a CI rebuild via
.github/workflows/docs.yml; the regenerated HTML and PDF
artifacts land at the URLs in the table above.