deck

Documentation

Overview

Package deck parses Margo Markdown into accessible HTML presentation decks.

Index

• type Document
  • func Parse(name string, source []byte) (*Document, error)
  • func (d *Document) Metadata() Metadata
  • func (d *Document) Slides() []Slide
• type Metadata
• type RenderInput
• type Result
  • func Render(ctx context.Context, compiler *margo.Compiler, input RenderInput) (*Result, error)
  • func (r *Result) DocumentFingerprint() margo.DocumentFingerprint
  • func (r *Result) HTML() []byte
  • func (r *Result) Requirements() margo.HTMLRequirements
  • func (r *Result) RuntimeDescriptor(instance margo.RenderInstanceID) (margo.RuntimeDescriptor, error)
  • func (r *Result) SlideCount() int
• type Slide
  • func (s Slide) ID() string
  • func (s Slide) Markdown() []byte
  • func (s Slide) Ordinal() int

Types

type Document

type Document struct {
	// contains filtered or unexported fields
}

func Parse

func Parse(name string, source []byte) (*Document, error)

func (*Document) Metadata

func (d *Document) Metadata() Metadata

func (*Document) Slides

func (d *Document) Slides() []Slide

type Metadata

type Metadata struct {
	Title       string `yaml:"title"`
	Description string `yaml:"description"`
}

type RenderInput

type RenderInput struct {
	Name      string
	Markdown  []byte
	BaseURL   string
	Theme     margo.ThemeName
	ColorMode margo.ColorMode
}

type Result

type Result struct {
	// contains filtered or unexported fields
}

func Render

func Render(ctx context.Context, compiler *margo.Compiler, input RenderInput) (*Result, error)

func (*Result) DocumentFingerprint

func (r *Result) DocumentFingerprint() margo.DocumentFingerprint

func (*Result) HTML

func (r *Result) HTML() []byte

func (*Result) Requirements

func (r *Result) Requirements() margo.HTMLRequirements

func (*Result) RuntimeDescriptor

func (r *Result) RuntimeDescriptor(instance margo.RenderInstanceID) (margo.RuntimeDescriptor, error)

func (*Result) SlideCount

func (r *Result) SlideCount() int

type Slide

type Slide struct {
	// contains filtered or unexported fields
}

func (Slide) ID

func (s Slide) ID() string

func (Slide) Markdown

func (s Slide) Markdown() []byte

func (Slide) Ordinal

func (s Slide) Ordinal() int