Documentation

Overview

SchemaFlux is a compiler for structured data. It reads entities with metadata, enriches them through an ordered pass pipeline, and emits output through pluggable backends.

Quick Start

Install SchemaFlux and build your first site in under five minutes.

Configuration

Complete reference for the schemaflux.yaml configuration file.

Getting Started

Install SchemaFlux and build your first static site in minutes. Requires Go 1.25 or later.

Architecture

How SchemaFlux works internally: frontend, compiler passes, IR, and backends.

Entities

Understanding entities: the core data unit in SchemaFlux.

Compiler Passes

The 12 ordered compiler passes that transform entities from raw data to enriched output.

Template Engine

SchemaFlux uses Go's html/template with 60+ custom functions for rendering entity pages, homepages, taxonomy hubs, and more.

Templates

Go template syntax, available functions, and template types in SchemaFlux.

Taxonomies

Grouping entities with taxonomies: categories, tags, and custom classification systems.

CLI Usage

Reference for the schemaflux command-line interface. Build static sites from structured data with a single command.

Structured Data

JSON-LD schemas, Open Graph, sitemaps, RSS feeds, and SEO features.

Backends

Output backends: the HTML backend, output structure, and building custom backends.

Markdown Renderer

SchemaFlux includes a custom markdown-to-HTML renderer built entirely with the Go standard library. No external markdown libraries are used.

Compiler Passes

SchemaFlux runs 12 ordered passes that transform the intermediate representation: slug resolution, sorting, enrichment, taxonomy grouping, related entity scoring, and more.