config

type BookConfig struct {
	Book     BookMeta       `yaml:"book"`
	Chapters []ChapterDef   `yaml:"chapters"`
	Style    StyleConfig    `yaml:"style"`
	Output   OutputConfig   `yaml:"output"`
	Markdown MarkdownConfig `yaml:"markdown"`
	// Plugins lists the plugins to run during the build, in declaration order.
	Plugins []PluginConfig `yaml:"plugins"`
	// Variables are user-defined template variables, usable in Markdown as
	// {{ key }} alongside the built-in book.*/style.*/output.* values.
	Variables map[string]string `yaml:"variables"`

	// These fields are auto-detected by Load instead of being set directly in YAML.
	GlossaryFile string `yaml:"-"` // Path to GLOSSARY.md, if present.
	LangsFile    string `yaml:"-"` // Path to LANGS.md, if present.
	// contains filtered or unexported fields
}

type BookMeta struct {
	Title       string    `yaml:"title"`
	Subtitle    string    `yaml:"subtitle"`
	Author      string    `yaml:"author"`
	Version     string    `yaml:"version"`
	Language    string    `yaml:"language"`
	Description string    `yaml:"description"`
	Cover       CoverMeta `yaml:"cover"`
	// Favicon is the site icon: a project-relative image path, or an absolute
	// URL. Empty keeps mdpress's built-in book emoji.
	Favicon string `yaml:"favicon"`
	// Logo is an image shown above the title in the site sidebar: a
	// project-relative image path, or an absolute URL. Empty shows no logo.
	Logo string `yaml:"logo"`
	// Copyright is a short notice rendered in each page's footer, e.g.
	// "© 2026 Acme Inc.". Empty renders no notice.
	Copyright string `yaml:"copyright"`
}

type ChapterDef struct {
	Title string `yaml:"title"`
	File  string `yaml:"file"`
	// Section is an optional group label rendered above this chapter in the
	// site sidebar, starting a new group. SUMMARY.md "## Heading" lines set it
	// on the chapter that follows them; book.yaml can set it directly. It is
	// carried on a real chapter rather than modeled as a file-less entry, so
	// nothing downstream has to cope with a chapter that has no content.
	Section  string       `yaml:"section"`
	Sections []ChapterDef `yaml:"sections"`
}

type CoverMeta struct {
	Image      string `yaml:"image"`
	Background string `yaml:"background"` // Background color, for example "#1a1a2e".
}

type DiscoverError struct {
	Dir string
	Msg string
}

type HeaderFooterStyle struct {
	Left   string `yaml:"left"`
	Center string `yaml:"center"`
	Right  string `yaml:"right"`
}

type MarginConfig struct {
	Top    float64 `yaml:"top"`
	Bottom float64 `yaml:"bottom"`
	Left   float64 `yaml:"left"`
	Right  float64 `yaml:"right"`
}

type MarkdownConfig struct {
	// AllowHTML controls whether raw HTML written in Markdown reaches the
	// output. A nil pointer means "not configured" and keeps the default.
	AllowHTML *bool `yaml:"allow_html"`
}

type OutputConfig struct {
	Filename          string   `yaml:"filename"`
	TOC               bool     `yaml:"toc"`
	TOCMaxDepth       int      `yaml:"toc_max_depth"` // Maximum heading level to include in TOC (1-6, default 2). Level 1 = h1 only, 2 = h1+h2, etc.
	Cover             bool     `yaml:"cover"`
	Header            bool     `yaml:"header"`
	Footer            bool     `yaml:"footer"`
	Formats           []string `yaml:"formats"`            // Output formats: pdf, html, epub, site (default ["pdf"]).
	PDFTimeout        int      `yaml:"pdf_timeout"`        // PDF generation timeout in seconds (default 120).
	Watermark         string   `yaml:"watermark"`          // Watermark text (e.g., "DRAFT", "CONFIDENTIAL")
	WatermarkOpacity  float64  `yaml:"watermark_opacity"`  // Opacity 0.0-1.0 (default 0.1)
	MarginTop         string   `yaml:"margin_top"`         // e.g., "20mm"; unset means style.margin.top
	MarginBottom      string   `yaml:"margin_bottom"`      // e.g., "20mm"; unset means style.margin.bottom
	MarginLeft        string   `yaml:"margin_left"`        // e.g., "25mm"; unset means style.margin.left
	MarginRight       string   `yaml:"margin_right"`       // e.g., "25mm"; unset means style.margin.right
	GenerateBookmarks bool     `yaml:"generate_bookmarks"` // Generate PDF bookmarks from headings (default true)
	SiteURL           string   `yaml:"site_url"`           // Public base URL of the deployed site (e.g. https://user.github.io/repo); enables sitemap.xml
	EditBase          string   `yaml:"edit_base"`          // Base URL for "edit this page" links (e.g. https://github.com/user/repo/edit/main/)
	TaggedPDF         *bool    `yaml:"tagged_pdf"`         // Generate accessible tagged PDF (default true; false produces smaller files)
	// FooterHTML replaces the site's default "Built with mdPress" footer line.
	// A nil pointer means "not configured" and keeps the default; an explicit
	// empty string removes the line. It is a pointer for exactly that reason —
	// a plain string cannot tell "unset" from "the user wants no footer".
	// Its value is emitted as raw HTML, on the same trust footing as raw HTML
	// in the Markdown sources (see BookConfig.AllowRawHTML).
	FooterHTML *string `yaml:"footer_html"`
	// ShowThemeBadge renders the theme name as a badge in the site sidebar.
	// Off by default: it is mdpress advertising itself on someone else's
	// published site, and removing it used to require a CSS hack.
	ShowThemeBadge bool `yaml:"show_theme_badge"`
}

type PluginConfig struct {
	// Name is the unique plugin identifier (lowercase, hyphen-separated).
	Name string `yaml:"name"`
	// Path is the path to the plugin executable, relative to book.yaml.
	Path string `yaml:"path"`
	// Config contains arbitrary key-value pairs passed to the plugin.
	Config map[string]any `yaml:"config"`
}

type ReadmeMetadata struct {
	Title    string // Book title (may differ from H1 heading).
	Version  string // e.g. "1.6.5"
	Author   string // Detected author name or GitHub username.
	Language string // e.g. "zh-CN", "en-US"
}

type StyleConfig struct {
	Theme      string            `yaml:"theme"`
	PageSize   string            `yaml:"page_size"`
	FontFamily string            `yaml:"font_family"`
	FontSize   string            `yaml:"font_size"`
	CodeTheme  string            `yaml:"code_theme"`
	LineHeight float64           `yaml:"line_height"`
	Margin     MarginConfig      `yaml:"margin"`
	Header     HeaderFooterStyle `yaml:"header"`
	Footer     HeaderFooterStyle `yaml:"footer"`
	CustomCSS  string            `yaml:"custom_css"`
}

type UnknownKey struct {
	// Path is the dotted location in the document, e.g. "style.them".
	Path string
	// Suggestion is the closest known sibling key, or "" if none is close.
	Suggestion string
}