export

type Chrome struct {
	Site       string    // the site's title, linking to its root
	Page       string    // this page's title: the document's <title> is "Page · Site"
	Root       string    // the path from this page to the site's root: "", "../", "../../"
	Nav        []NavItem // the sidebar: the sections, their pages, the links out
	Prev, Next *NavItem  // within the page's section
}

type EmbedLine struct {
	Line     int
	Dest     string
	Alone    bool
	From, To int
}

type Format string

type NavItem struct {
	Title, Href string
	Current     bool      // this page, or the section it is in
	Children    []NavItem // a section's pages
}

type Options struct {
	// Base is the directory the source's relative links are read from: each becomes the file: URL
	// of the file it names there, so the page's links reach their files wherever it is written. ""
	// writes every link as the source has it.
	Base string
	// SourceSpans puts each block element's source bytes on it (data-src="start-end"), for a
	// view that follows the editor: the GUI's native HTML preview scrolls to the cursor's block.
	SourceSpans bool
	// Document is the source's own file on disk. Its embeds (![alt](path)) of a Mermaid diagram
	// (.mmd), a Vega-Lite chart (.chart.json), a table (.csv) or an image are read beside it, or in
	// its resources folder, and drawn in the page (embed.go). "" draws each as its alt text.
	Document string
	// TableRows is how many rows an embedded table, or a csv fence's, shows (0: 1000); TableWidth
	// is the width, in characters, its columns are fit in: those that fit are shown, and the table
	// says how many are not (0: any width, 64 columns at most). For a view narrower than a
	// browser: the GUI's Rendered view of a note.
	TableRows, TableWidth int
	// Links maps a relative link's destination, as written, to the URL the page writes; ok false
	// keeps it as written. Base, when set, is the file: mapping (fileURL) and wins over Links. For a
	// site: a link to another page reaches that page (site.go).
	Links func(dest string) (url string, ok bool)
	// Chrome is the frame around the body: a site's sidebar and previous/next. nil: a bare page.
	Chrome *Chrome
	// Chart draws a Vega-Lite spec as inline SVG in the page's theme. It draws a .chart.json embed
	// and a vega-lite fence. Its error says why it could not (golib's gui/vegalite's own words, a
	// chart outside its subset): the spec is then the <pre class="vega-lite"> it is without Chart,
	// captioned "chart not drawn: <the error>" (chartFallback). nil keeps every spec, uncaptioned.
	// The GUI build gives one (golib's gui/vegalite); core/export draws none of its own.
	Chart func(spec []byte, theme string) (svg string, err error)
}

type SiteOptions struct {
	Theme string                                          // one of Themes; "" is site.toml's, else dark
	Chart func(spec []byte, theme string) (string, error) // Options.Chart for every page; nil: specs
}