Enum CustomPage 

pub enum CustomPage {
    Html(String),
    Full {
        html: String,
        layout: Option<String>,
        title: Option<String>,
        description: Option<String>,
        outline: Option<bool>,
        state: Option<Value>,
        state_file: Option<String>,
        script_file: Option<String>,
    },
}

Variants

Html(String)

Full

Fields

html: String

layout: Option<String>

title: Option<String>

Page title, falling back to the site title when omitted.

description: Option<String>

Page description, falling back to the site description when omitted.

outline: Option<bool>

Override the site’s page-outline setting for this custom page.

state: Option<Value>

Inline state object merged into the page’s render state under the pageData key. Mutually exclusive with state_file.

state_file: Option<String>

Path (relative to config.json) of a JSON file whose contents are merged into the page’s render state under the pageData key. The build pipeline caches each unique file so that pages that share a state file only read it once. Mutually exclusive with state.

script_file: Option<String>

Path (relative to config.json) of a TypeScript/JavaScript file to bundle as a per-page script. The file is bundled with esbuild and a <script> tag is appended to the page output.

Implementations

impl CustomPage

pub fn html(&self) -> &str

pub fn layout(&self) -> &str

pub fn title(&self) -> Option<&str>

Return the optional custom-page title.

pub fn description(&self) -> Option<&str>

Return the optional custom-page description.

pub fn outline(&self) -> Option<bool>

Return the optional custom-page outline setting.

pub fn inline_state(&self) -> Option<&Value>

pub fn state_file(&self) -> Option<&str>

pub fn script_file(&self) -> Option<&str>

Trait Implementations

impl Debug for CustomPage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomPage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.