Struct WebCfg 

pub struct WebCfg {

    pub out_dir: Option<String>,
    pub base_path: Option<String>,
    pub url: Option<String>,
    pub description: Option<String>,
    pub og_image: Option<String>,
    pub canonical: Option<String>,
    pub locales: Option<Vec<String>>,
    pub default_locale: Option<String>,
    pub skin: Option<String>,
    pub css: WebCssMode,
    pub widgets: WebWidgets,
    pub render: WebRender,
    pub runtime: Option<bool>,
    pub prerender: WebPrerender,
    pub hash_assets: Option<bool>,
    pub debug_attrs: Option<bool>,
    pub menubar: WebMenubar,
    pub sitemap: Option<bool>,
    pub robots: Option<bool>,
    pub host: WebHost,
    pub navigation: WebNavigation,
    pub seed: BTreeMap<String, WebSeedValue>,
    pub pages: BTreeMap<String, WebPageCfg>,
    pub ssr: WebSsrCfg,
}

[web] block - how lumenc web emits the app as a static site.

The rest of lumen.toml still describes the app: [window] title is the documents’ title, [app] id / entry / locale, [pages], [asset_roots] and [script] engine all apply. This block covers what only a site has: where it is served from, what a crawler is told, and which locales it is emitted in.

[capabilities] does not apply. A desktop build compiles a runtime per app; a site loads one prebuilt runtime that ships with the toolchain, so there is nothing per-app to trim.

[web]
out_dir   = "dist/web"       # where the site is written
base_path = "/"              # URL prefix the site is served under
url = "https://example.com"  # an address; canonical link + sitemap need one
description = "A Lumen app"  # used by any page without its own
locales = ["en-US", "de-DE"] # one tree per locale
host = "netlify"             # also write that host's deep-path rewrite file
render = "ssr"               # a document per request
runtime = false              # and no browser runtime in it

[web.seed]
count = 3                    # signal values the pages are rendered with

[web.pages.settings]
title = "Settings"
index = false                # and keep it out of a search index

Fields

out_dir: Option<String>

Directory the site is written to, relative to the app dir unless absolute. Defaults to dist/web.

base_path: Option<String>

URL prefix the site is served under, such as / or /docs/. Every link and asset reference in the documents hangs off it.

url: Option<String>

Absolute site URL, such as https://example.com. The canonical link, the social metadata, the hreflang links and the sitemap need an address; without this or Self::canonical they are left out.

description: Option<String>

Description used by any page that does not set its own.

og_image: Option<String>

Image for social previews, relative to the site root or absolute.

canonical: Option<String>

Absolute URL the pages declare as canonical, for a site published at more than one address. Defaults to Self::url.

locales: Option<Vec<String>>

Every locale the site is emitted in, one document tree each. Absent emits the default locale alone.

default_locale: Option<String>

The locale whose tree sits at the site root; the others sit under /<tag>/. Defaults to [app] locale, then en-US.

skin: Option<String>

Skin the site is styled with. Defaults to [skin] name, then default. auto is not read here: it means “the machine’s OS”, and a site is served to every OS.

css: WebCssMode

How the pages are styled.

widgets: WebWidgets

Which shape a widget the parser built out of smaller elements is emitted as.

render: WebRender

Where a page’s document comes from.

runtime: Option<bool>

Whether the documents carry the browser runtime. Unset takes what Self::render implies, which is the only thing static and csr differ about; render = "ssr" is the one that leaves it open.

prerender: WebPrerender

Where the state the pages are rendered with comes from.

hash_assets: Option<bool>

Add a content hash to asset file names, so a cache can hold them forever. A build does not apply this yet.

debug_attrs: Option<bool>

Write the extra data-lm-* attributes that name what an element came from. A build does not write them yet.

menubar: WebMenubar

What an app menu bar becomes in a document.

sitemap: Option<bool>

Write sitemap.xml: every page in every locale, each entry dated and cross-linked to its other languages. Needs an address to build absolute URLs from, Self::canonical else Self::url, and is written whenever the site has one.

robots: Option<bool>

Write robots.txt, naming the sitemap. Defaults to on when a sitemap is written.

host: WebHost

Host the site is deployed to, which decides the rewrite file that makes a deep path serve the app instead of the host’s own 404.

navigation: WebNavigation

How a link to another page of the same site is followed.

seed: BTreeMap<String, WebSeedValue>

[web.seed] - signal values every page is rendered with.

pages: BTreeMap<String, WebPageCfg>

[web.pages.<key>] - what each page says about itself. A key naming a page the app does not have is accepted and reaches nothing.

ssr: WebSsrCfg

[web.ssr] - what a render of the app may reach, when its pages are rendered per request.

Trait Implementations

impl Clone for WebCfg

fn clone(&self) -> WebCfg

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebCfg

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebCfg

fn default() -> WebCfg

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebCfg

where WebCfg: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.