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¶
All integrations use the same face rendering API
(dataface.core.render.face_api.render_face). This function handles
the full compile-execute-render pipeline and returns embeddable output
(SVG, HTML, PNG, or PDF). Each integration is a thin adapter that:
- Detects embed blocks or directives in the host tool's source format
- Resolves the face file path relative to the project
- Calls
render_face()to get rendered output - Injects the output into the host tool's build pipeline
This keeps the core Dataface architecture undistorted by any single platform's conventions.