page

type Block struct {
	HTML     []byte
	Editable bool
}

type Conflict struct {
	// Doc is the document prefix, which the client answers the banner with.
	Doc string
	// Name is the document as the page names it elsewhere: the prefix of a
	// single-document page is empty and names nothing to the author.
	Name string
}

type Doc struct {
	Prefix string
	Path   string
	Title  string
	// Key identifies the document across runs, so the page can remember where
	// its reader stopped. It is DocKey of the file path; an empty Key means a
	// document without memory.
	Key    string
	Body   []byte
	Blocks []Block
	TOC    []TOCEntry
}

type Params struct {
	Docs       []Doc
	Theme      string
	Size       string
	HasMermaid bool
	HasKatex   bool
	Edit       bool
	EditToken  string
	// Warnings are the render issues the documents came with, already named by
	// document. They seed the ⚠ badge of an edit page, which every later render
	// refreshes from its own answer: without them the warnings of the very first
	Warnings []string
	// Dirty holds the prefixes of the documents that hold edits not yet written
	// to disk. An editing page is rebuilt on every load, so a reload can land on
	// a session that is ahead of the files: without this the fresh page would
	Dirty []string
	// Conflicts names the documents whose file moved on disk under unsaved
	// edits. A conflict is a state, not a notice: it is raised once and stays
	// until it is answered, so the only event carrying it is long past by the
	// time the author reloads — and a page built without it would offer them
	// nothing but the overwrite.
	Conflicts []Conflict
	// Live marks a page that follows the session it was built from: the client
	// opens the event stream and applies what the server pushes. A reading page
	// under --tunnel is live too, so this is not implied by Edit.
	Live bool
	// Seq is the state the markup was built from. The client sends it back as
	// the stream cursor, so events the page already shows are skipped instead of
	// replayed over it.
	Seq uint64
	// Epoch names the run of the CLI the markup was built by. It travels back
	// with the cursor: the cursor counts from zero in every run, and only the
	// pair says whether a reconnecting tab is caught up or is still showing a
	// page an earlier run left it.
	Epoch string
}

type TOCEntry struct {
	Level int
	ID    string
	Text  string
}