Struct DocFrontmatter 

pub struct DocFrontmatter {
    pub title: String,
    pub description: Option<String>,
    pub sidebar_title: Option<String>,
    pub icon: Option<String>,
}

YAML frontmatter metadata from MDX files.

Fields

title: String

Page title (used in H1 and browser tab).

description: Option<String>

Short description (used in meta tags and previews).

sidebar_title: Option<String>

Sidebar title (shorter than main title).

icon: Option<String>

Icon name (Lucide icon identifier).

Trait Implementations

impl Clone for DocFrontmatter

fn clone(&self) -> DocFrontmatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocFrontmatter

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

Formats the value using the given formatter.

impl Default for DocFrontmatter

fn default() -> DocFrontmatter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocFrontmatter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocFrontmatter

fn eq(&self, other: &DocFrontmatter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocFrontmatter