Struct SurfDocBuilder 

pub struct SurfDocBuilder { /* private fields */ }

Fluent builder for constructing SurfDoc documents programmatically.

Example

use surf_parse::builder::SurfDocBuilder;
use surf_parse::types::CalloutType;

let doc = SurfDocBuilder::new()
    .title("My Doc")
    .heading(1, "Welcome")
    .callout(CalloutType::Info, "Important note")
    .build();

assert_eq!(doc.blocks.len(), 2);

Implementations

impl SurfDocBuilder

pub fn new() -> Self

Create a new empty builder.

pub fn title(self, title: &str) -> Self

Set the document title.

pub fn doc_type(self, dt: DocType) -> Self

Set the document type.

pub fn status(self, s: DocStatus) -> Self

Set the document status.

pub fn author(self, author: &str) -> Self

Set the document author.

pub fn tags(self, tags: Vec<String>) -> Self

Set the document tags.

pub fn description(self, desc: &str) -> Self

Set the document description.

pub fn front_matter(self, fm: FrontMatter) -> Self

Set the entire front matter at once.

pub fn markdown(self, content: &str) -> Self

Add a raw markdown block.

pub fn heading(self, level: u8, text: &str) -> Self

Add a markdown heading (syntactic sugar for markdown("## text")).

pub fn callout(self, callout_type: CalloutType, content: &str) -> Self

Add a callout block.

pub fn callout_titled( self, callout_type: CalloutType, title: &str, content: &str, ) -> Self

Add a callout block with a title.

pub fn code(self, content: &str, lang: Option<&str>) -> Self

Add a code block with optional language.

pub fn code_file(self, content: &str, lang: &str, file: &str) -> Self

Add a code block with language and file path.

pub fn data_table(self, headers: Vec<String>, rows: Vec<Vec<String>>) -> Self

Add a data table block.

pub fn task(self, text: &str, done: bool) -> Self

Add a single task item.

pub fn tasks(self, items: Vec<TaskItem>) -> Self

Add a tasks block with multiple items.

pub fn decision(self, status: DecisionStatus, content: &str) -> Self

Add a decision block.

pub fn metric(self, label: &str, value: &str) -> Self

Add a metric block.

pub fn metric_with_trend( self, label: &str, value: &str, trend: Trend, unit: Option<&str>, ) -> Self

Add a metric block with trend and optional unit.

pub fn summary(self, content: &str) -> Self

Add a summary block.

pub fn figure(self, src: &str) -> Self

Add a figure block.

pub fn figure_with_caption( self, src: &str, caption: &str, alt: Option<&str>, ) -> Self

Add a figure block with caption and optional alt text.

pub fn quote(self, content: &str) -> Self

Add a quote block.

pub fn quote_attributed(self, content: &str, attribution: &str) -> Self

Add a quote block with attribution.

pub fn cta(self, label: &str, href: &str, primary: bool) -> Self

Add a call-to-action block.

pub fn hero_image(self, src: &str, alt: Option<&str>) -> Self

Add a hero image block.

pub fn testimonial( self, content: &str, author: Option<&str>, role: Option<&str>, company: Option<&str>, ) -> Self

Add a testimonial block.

pub fn style(self, properties: Vec<StyleProperty>) -> Self

Add a style block.

pub fn faq(self, items: Vec<FaqItem>) -> Self

Add an FAQ block.

pub fn pricing_table(self, headers: Vec<String>, rows: Vec<Vec<String>>) -> Self

Add a pricing table block.

pub fn site(self, domain: Option<&str>, properties: Vec<StyleProperty>) -> Self

Add a site configuration block.

pub fn page( self, route: &str, layout: Option<&str>, title: Option<&str>, content: &str, ) -> Self

Add a page block.

pub fn nav(self, items: Vec<NavItem>, logo: Option<&str>) -> Self

Add a navigation block.

pub fn embed( self, src: &str, embed_type: Option<EmbedType>, title: Option<&str>, ) -> Self

Add an embed block.

pub fn form(self, fields: Vec<FormField>, submit_label: Option<&str>) -> Self

Add a form block.

pub fn gallery(self, items: Vec<GalleryItem>, columns: Option<u32>) -> Self

Add a gallery block.

pub fn footer( self, sections: Vec<FooterSection>, copyright: Option<&str>, social: Vec<SocialLink>, ) -> Self

Add a footer block.

pub fn tabs(self, tabs: Vec<TabPanel>) -> Self

Add a tabs block.

pub fn columns(self, columns: Vec<ColumnContent>) -> Self

Add a columns block.

pub fn hero( self, headline: Option<&str>, subtitle: Option<&str>, badge: Option<&str>, buttons: Vec<HeroButton>, ) -> Self

Add a hero section block.

pub fn features(self, cards: Vec<FeatureCard>, cols: Option<u32>) -> Self

Add a features card grid block.

pub fn steps(self, steps: Vec<StepItem>) -> Self

Add a steps block.

pub fn stats(self, items: Vec<StatItem>) -> Self

Add a stats block.

pub fn comparison( self, headers: Vec<String>, rows: Vec<Vec<String>>, highlight: Option<&str>, ) -> Self

Add a comparison table block.

pub fn logo(self, src: &str, alt: Option<&str>, size: Option<u32>) -> Self

Add a logo block.

pub fn toc(self, depth: u32) -> Self

Add a table-of-contents block.

pub fn before_after( self, before_items: Vec<BeforeAfterItem>, after_items: Vec<BeforeAfterItem>, transition: Option<&str>, ) -> Self

Add a before/after comparison block.

pub fn pipeline(self, steps: Vec<PipelineStep>) -> Self

Add a pipeline flow block.

pub fn section( self, bg: Option<&str>, headline: Option<&str>, subtitle: Option<&str>, content: &str, ) -> Self

Add a section container block.

pub fn product_card( self, title: &str, subtitle: Option<&str>, badge: Option<&str>, badge_color: Option<&str>, body: &str, features: Vec<String>, cta_label: Option<&str>, cta_href: Option<&str>, ) -> Self

Add a product card block.

pub fn app( self, name: &str, binary: Option<&str>, region: Option<&str>, port: Option<u32>, children: Vec<Block>, ) -> Self

Add an app manifest container block.

pub fn deploy( self, env: &str, app: Option<&str>, machines: Option<u32>, memory: Option<u32>, ) -> Self

Add a deploy block.

pub fn infra_database(self, name: Option<&str>, shared_auth: bool) -> Self

Add an infrastructure database block.

pub fn build(self) -> SurfDoc

Consume the builder and produce a SurfDoc.

Trait Implementations

impl Default for SurfDocBuilder

fn default() -> Self

Returns the “default value” for a type.