DocsBuild with OPF

Developer docs

Author a deck, check it, then preview, export or embed it. Start with a runnable example or look up an exact contract.

Start

Create your first deckInstall, author, check and export a small deck.First deck in ten minutesA brief to a validated deck, PNG previews and a PPTX, with the known limits.Integrate OPFRun a website, embedded editor or Node export project.Set up an agentAuthor, inspect and revise decks with the CLI and six skills.

Author and compose

ContentText, lists, charts, tables and other slide payloads.Layouts and named pinsChoose a built-in layout or declare your own list of regions.Compose and paginateArrange groups, inspect allocation and handle overflow.Data and chartsShare typed datasets across charts and tables.Reusable decksFill templates and resolve variables.MarkdownAuthor slide content without JSON braces.YAMLWrite the canonical deck value as strict YAML.Practice variables and shared dataChange typed values and metadata, then update a chart and table together.

Check and repair

Validate a deckRun the checker and act on findings.Validation resultsErrors, warnings and suggested fixes.Try a changeEdit, check and preview a deck in your browser.

Integrate and export

Node files and conversionOpen, save and convert files in Node; inspect files, findings and errors.Generate a presentation in PythonBuild the deck as JSON in Python, then validate and export PPTX and PDF with the CLI.Render SVG, PNG and PDFChoose browser or Node entries, fonts and optional converters.PowerPoint export and importWrite editable PPTX or inspect import signals in Node and browsers.Editor and previewsEmbed editing with validated changes and undo.MCP serverConnect an agent to the hosted or local OPF MCP server.Fonts and fidelityMeasure with font bytes and understand native export limits.Supported behaviorCheck native conversion boundaries before integrating.

Complete reference

All 42 guides from the pinned OPF source. Full text, constraints and raw Markdown remain available.

How OPF Works — Understand canonical content, design, catalogs and engine boundaries.
OPF format card — Keep the compact authoring contract beside your prompt or editor.
Content payloads and tables — Choose text, lists, charts, tables, metrics and other supported content.
Design Resolution — Understand which design value wins at each level.
OPF Presentation Schema Reference — Read the complete presentation field contract.
OPF Catalog Schema Reference — Look up catalog record fields and constraints.
OPF Examples Guide — Find schema-valid decks and the feature each demonstrates.
Agent skills — Give agents six focused workflows for authoring, layout, catalogs, editing, export and inspection.
Chart options: axis titles, legend position, data labels and highlight — Label axes and values, place a legend, and emphasize a series.
Chart and table data: numbers, formats, datasets and series mapping — Use typed inline data or share one dataset across charts and tables.
CLI for agents — Validate, inspect, edit and convert decks from the terminal.
Compatibility matrix — Check implemented features, native fidelity limits and deferred work.
Content conversions — Convert supported content blocks without discarding their meaning.
CSV and JSON data — Import CSV, TSV and JSON into editable tables or charts.
Catalogs and the gallery package — Register or embed Gallery records and resolve catalog references.
Dynamic layouts — Arrange, inspect and paginate content with shared composition.
Validation results — Errors, warnings and suggested fixes.
Fonts and fidelity — Load font bytes for measurement and understand Office font requirements.
Footnotes, citations and captions — Add sources and captions while keeping them attached to content.
Images: backgrounds, image blocks and treatments — Use images, backgrounds, crops, overlays and supported effects.
Layout templates — Select a built-in layout or declare one list of regions with their content rules.
Live editor and previews — Embed previews and edit validated OPF with undo and redo.
Author with an LLM — Generate schema-valid decks, then inspect and revise them.
Markdown authoring — Author slide content in the OPF Markdown dialect.
OPF MCP server —
OPF files in Node: `@openpresentation/opf` — Open, save and convert decks through the Node API.
Numbered lists — Generate list numbers, restart sequences and preserve pagination.
Open ecosystem — Find maintained tools and understand their separate responsibilities.
Patch, diff, merge and format — Patch, compare, merge and format canonical deck source.
Developer quickstart — Run the published toolkit in a fresh Node project.
Rich text measurement — Style runs and measure their layout with the fonts you supply.
Schema versioning — The OPF schemas carry a v1 (and the layout record schema a v2) in their $id, such as https://openpresentation.org/schema/opf/v1. Before OPF 1.0 that number names the pre-1.0 line, not a frozen contract.
Slide Design Principles — Precise slide design makes ideas easy to understand through clear hierarchy, deliberate proportions, and carefully controlled typography and space. A restrained slide can achieve exceptional quality through th…
Slide sizes: OPF presets and PowerPoint presets — Choose dimensions and understand CSS-pixel and PowerPoint units.
Stats — Inspect deck counts and content statistics.
Inherited table text colors — Understand automatic inherited text contrast in table cells.
Templates and variables — Fill reusable decks and resolve variables without duplicating source.
OPF validate: one checker for format, references, accessibility, layout and content — Run all checker categories and interpret findings.
YAML authoring — Author the canonical deck value in strict JSON-compatible YAML.

Design notes (unshipped)

These notes discuss possible changes; they do not define supported authoring fields.

Possible payload styling (unshipped) — Unshipped proposal: possible future per-payload styling.

Contributor resources

OPF Release Process — Maintainer-only release and provenance procedure.
Local ecosystem development — Contributor workflow for coordinated package changes.

Need an exact field? Open the schema and definition reference.