# crossPresent > Turn one Markdown file into a self-contained HTML presentation. Install: brew install openstruct/tap/crosspresent, or pipx install git+https://github.com/OpenStruct/crosspresent.git. MCP: crosspresent mcp. # crossPresent authoring guide crossPresent turns one Markdown file into one self-contained HTML presentation (and optionally a PDF). Write the deck as a .md file, then: crosspresent check deck.md # validate: errors and warnings, nothing written crosspresent build deck.md # -> deck.html (add --open to view it) crosspresent pdf deck.md -t deck # -> deck.pdf, 16:9 pages ## Frontmatter (all optional) --- title: Q3 review # browser/tab title subtitle: Shown under the cover heading eyebrow: Quarterly business review template: deck # deck (slides) | sidebar (walkthrough) | doc (report) palette: default # default | ocean | forest | mono | crimson accent: "#7c5cff" # override the accent colour font: system # system | serif | mono ; or font_file: brand.woff2 controls: true # deck: arrow keys, F = fullscreen, progress bar description: One-line summary for link previews --- ## Slides # Title slide (the first one is the cover) ## Regular slide {#optional-id} (auto-numbered, added to the contents) ### Sub-heading inside a slide The first paragraph of a slide is styled as its intro line. Inline: **bold**, *italic*, `code`, [link](url), ![image](path.png), badges [[NEW]] or [[shipped|good]] (good warn bad info accent purple teal dim). Tables use normal Markdown pipes. > **Label** blockquotes become callouts. ## Blocks (fenced code blocks with a tag) Chart: JSON inside. Types: bar, hbar, line, area, pie, donut. ```chart {"type": "bar", "title": "Signups", "labels": ["Jan", "Feb", "Mar"], "values": [120, 180, 240]} ``` - several series: "series": [{"name": "a", "values": [...]}, ...] (bar, line, area) - from a file: {"type": "line", "data": "data/runs.csv"} (first column = labels) - optional: "height" (bar/line/area, at least 80), "colorful": true (hbar) - values are numbers >= 0; give exactly one label per value Stat tiles: value | label | colour (green, amber, red, blue, gray). ```stats 94% | pass rate | green 4 | flaky tests | amber ``` Columns: 2-4 columns separated by a line containing only |||, optional ratio. ```columns 2:1 Text, a list, or a chart ||| Second column ``` Cards: a grid split on ### headings (write ```cards 3 to force three columns). ```cards ### First Body text ### Second Body text ``` Callout with an optional label after the tag: ```note Heads up Rollout starts Monday. ``` Link chips: ```pills Docs | https://example.com ``` Speaker notes (left out unless built with --notes): ```notes What to say on this slide. ``` Diagrams (```mermaid adds a CDN script, so that page needs network access). Any other tag (```python, ```bash ...) is a code block. ## Writing good decks - One idea per slide; headline the takeaway ("Pass rate held above 93%"), not the topic ("Pass rate"). - Keep to about 6 bullets or one chart per slide. Use `columns` for text beside a chart, and `stats` for the 2-4 numbers that matter most. - Prefer `template: deck` for presenting, `doc` for reports to read. - Run `crosspresent check` after editing and fix every error and warning.