Integrations

Dataface provides integrations for embedding rendered boards and charts directly in external documentation and publishing tools.

Available Integrations

Integration	Status	Description
MkDocs	Supported	Embed boards in MkDocs sites via fenced dataface and dataface-example blocks
Sphinx	Planned	Directive for reStructuredText / Sphinx projects
Hugo	Planned	Shortcode for Hugo static sites

Architecture

Integrations render through the same project session API (dataface.agent_api.ProjectSession). ProjectSession.render_dashboard() handles the full compile-execute-render pipeline and returns a typed envelope carrying embeddable output (SVG, HTML, PNG, or PDF). Each integration is a thin adapter that:

1. Detects embed blocks or directives in the host tool's source format
2. Resolves the face file (or its raw YAML) relative to the project
3. Opens a ProjectSession and calls render_dashboard() to get rendered output
4. Injects the output into the host tool's build pipeline

This keeps the core Dataface architecture undistorted by any single platform's conventions. See MkDocs for a worked example.