render

Documentation

Overview

Package render provides interfaces and utilities for rendering PRD documents to various output formats including Marp slides.

Index

• type Options
  • func DefaultOptions() *Options
  • func ExecutiveOptions() *Options
• type Renderer

Types

type Options

type Options struct {
	// Theme name (renderer-specific, e.g., "default", "corporate", "minimal")
	Theme string

	// IncludeGoals includes goals alignment section in slides
	IncludeGoals bool

	// IncludeRoadmap includes roadmap/timeline slides
	IncludeRoadmap bool

	// IncludeRisks includes risks slide
	IncludeRisks bool

	// IncludeRequirements includes detailed requirements slides
	IncludeRequirements bool

	// MaxPersonas limits the number of personas shown (0 = all)
	MaxPersonas int

	// MaxRequirements limits requirements per slide (0 = all)
	MaxRequirements int

	// Custom CSS (for Marp/HTML renderers)
	CustomCSS string

	// Additional metadata (renderer-specific)
	Metadata map[string]string
}

Options contains rendering options common to all renderers.

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns sensible default rendering options.

func ExecutiveOptions

func ExecutiveOptions() *Options

ExecutiveOptions returns options for executive-focused slides (fewer details).

type Renderer

type Renderer interface {
	// Format returns the output format name (e.g., "marp").
	Format() string
	// FileExtension returns the file extension for this format (e.g., ".md").
	FileExtension() string
	// Render converts a PRD document to the output format.
	Render(doc *prd.Document, opts *Options) ([]byte, error)
}

Renderer defines the interface for output format renderers.