Skip to main content

Module types

Module types 

Source

Structs§

BeforeAfterItem
An item within a BeforeAfter block.
BindingEvent
An event in a Binding block (on_create, on_update, etc.).
BookingDay
One day’s availability in a Booking block. An empty slots (or the literal full) marks the day as unavailable.
BookingService
A bookable service in a Booking block (e.g. “60-min Strategy Call”).
ChartData
Inline chart dataset parsed from a ::chart block body — a shared category axis plus one or more named series. When a Chart block has data: None it falls back to the live-data mount point (source=) / static placeholder.
ChartSeries
One named numeric series of a ChartData dataset. values is aligned position-for-position with the owning dataset’s categories.
ColumnContent
A single column in a Columns block.
CommandItem
A command within a CommandPalette block.
CrateDep
A crate dependency within a Use block.
CrateEntry
A shared crate dependency entry.
DomainEntry
A domain entry with optional description.
EnvEntry
An environment variable entry within an InfraEnv block.
EnvVar
An environment variable declaration within an AppEnv block.
FaqItem
A question/answer pair within a Faq block.
FeatureCard
A card within a Features block.
FilterField
A filter field in a FilterBar block.
FooterSection
A section within a Footer block.
FormField
A single field in a Form block.
FrontMatter
YAML front matter fields.
GalleryItem
A single item in a Gallery block.
HeroButton
A button within a Hero or Banner block.
ListFilter
A filter declared inside a List block.
ModelField
A field within a Model block.
NavGroup
A labelled group of navigation links within a Nav block (rich shell).
NavItem
A navigation link within a Nav block.
PipelineStep
A step within a Pipeline block.
PostItem
A card within a PostGrid block: a blog/news/events index entry.
ProductGroup
A labelled group of product link-cards within a ProductGrid.
ProductItem
A single product link-card: emblem + name + tagline + link.
ProgressStep
A step within a Progress block.
Related
A cross-reference to another document.
SchemaField
A field within a Schema block.
SmokeCheck
A smoke test check: HTTP method, path, expected status code.
SocialLink
A social media link within a Footer block.
SortSpec
Sort specification: field name + direction.
Span
Source location of a block in the original document.
StatItem
A stat within a Stats block.
StepItem
A step within a Steps block.
StoreItem
A product line in a Store block.
StyleProperty
A key-value style override within a Style block.
SurfDoc
A parsed SurfDoc document.
TabBarItem
A tab item within a TabBar block.
TabPanel
A single tab panel within a Tabs block.
TaskItem
A single task item within a Tasks block.
TocEntry
A TOC entry within a Toc block.
VolumeEntry
A named volume mount.

Enums§

AttrValue
A value inside a block directive attribute.
AuthProvider
Authentication provider type.
Block
A parsed block in the document body.
CalloutType
Callout/admonition type.
ChartType
Chart visualization type.
Confidence
Confidence level for guides and estimates.
DataFormat
Data block format.
DecisionStatus
Decision record status.
DocStatus
Document lifecycle status.
DocType
SurfDoc document types (front matter type field).
EmbedType
Type of embedded content.
FieldConstraint
Constraints on a model field.
FormFieldType
Form field input types.
Format
Publication / citation format for papers and reports (front matter format field).
HttpMethod
HTTP method for Action blocks.
InlineExt
Inline extension found within text content.
ListDisplay
Display style for a List block.
ModelFieldType
Data types for model fields.
Relationship
Relationship type for cross-references.
RenderProfile
A resolved rendering profile: the engine-level decision of what kind of artifact a document produces, derived once from (DocType, Option<Format>) so renderers consult a single small enum instead of re-deriving intent.
RowState
State for Row and InfoCard blocks.
Scope
Visibility/access scope.
SlideLayout
Layout of a single slide in a ::deck.
ToolbarItem
An item within a Toolbar block.
Trend
Metric trend direction.

Functions§

render_profile
Resolve a (DocType, Option<Format>) pair to a RenderProfile.

Type Aliases§

Attrs
Ordered map of attribute key-value pairs.