Skip to documentation
SLOP

tiny.zen.BuildOptions

Reference tiny.zen BuildOptions

Defined in tiny.zen.

Controls one source-tree to static-site publication.

API (27)

Fields and members

Public fields and members.

No direct callersNo direct callstiny.zenBuildOptions
Static calls · unresolved targets: unknown · external targets: unknown.

Source

Source: lib/zen/src/site/publish.zig:26

zig
/// Controls one source-tree to static-site publication.pub const BuildOptions = struct {    /// Existing source directory with Markdown, assets, and optional `.zen` files.    source: []const u8,    /// Destination directory. With `clean`, publication replaces it atomically.    output: []const u8,    /// Root-relative URL prefix such as `/docs`; use empty text at a host root.    base: []const u8 = "",    /// Hosted parent prefix whose root-relative references remain unchanged.    parent_site_base: ?[]const u8 = null,    /// In-memory theme used when source theme files do not override it.    theme: theme.Theme = .{},    /// Bounds HTML produced by the page theme.    theme_render_limits: theme.RenderLimits = theme.default_render_limits,    /// Builds in staging and replaces prior output when true.    clean: bool = true,    /// Writes `page/index.html` routes when true and `page.html` when false.    clean_urls: bool = true,    /// Copies hidden source paths other than the owned `.zen` theme path.    copy_hidden: bool = false,    /// Excludes README Markdown pages when true.    skip_readme: bool = false,    /// Source-relative prefixes omitted from pages and assets.    exclude: []const []const u8 = &.{},    /// Includes pages whose frontmatter sets `draft: true`.    include_drafts: bool = false,    /// Includes non-curated pages and marks them as slop.    include_slop: bool = true,    /// Default Markdown render mode unless page metadata selects slides.    render_mode: markdown.Mode = .document,    /// Publishes the source-bearing authored route manifest for local editing.    publish_authored_routes: bool = false,    /// Keeps one exact call-map stylesheet per rendered page when true.    one_call_map_style_per_page: bool = true,    /// Selects bounded theme files inside the source tree.    theme_files: theme.Files = .{},    /// Bounds retained page records and catalog text.    catalog_limits: site_catalog.Limits = site_catalog.default_limits,    /// Bounds the largest Markdown page read into reusable storage.    page_limits: site_page.Limits = site_page.default_limits,    /// Maximum bytes copied from one asset.    asset_limit: usize = max_asset_bytes,    /// Bounds frontmatter pairs and joined continuation bytes.    frontmatter_limits: frontmatter.Limits = .{        .max_pairs = site_page.default_limits.max_page_bytes,        .max_continuation_bytes = site_page.default_limits.max_page_bytes,    },    /// Bounds headings per Markdown page.    heading_limits: document.Limits = document.default_limits,    /// Bounds footnotes per Markdown page.    footnote_limits: footnote.Limits = footnote.default_limits,    /// Bounds each quiz fence in a Markdown page.    quiz_limits: quiz.Limits = quiz.default_limits,    /// Bounds transformed target paths and public URLs.    path_limits: site_path.Limits = site_path.default_limits,    /// Receives source-relative page and repair detail after supported failures.    diagnostic: ?*diagnostic.Diagnostic = null,    /// Runs on the complete staging site before it can replace current output.    before_publish: ?BeforePublish = null,};

Source: lib/zen/src/root.zig:262

zig
/// Bounds and controls one source-tree to static-site publication.pub const BuildOptions = site.BuildOptions;

Also reachable as

site.BuildOptions.

Audit

Definitions1
Public names2
Members27
Version26.7.0
Revisiondaab053ee433