types

package
v1.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 13, 2026 License: BSD-3-Clause Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Asciinema

type Asciinema struct {
	Cast     string `json:"cast"`
	URL      string `json:"url"`
	Loop     bool   `json:"loop"`
	AutoPlay bool   `json:"autoplay"`
}

type Cast

type Cast struct {
	Width  int `json:"width"`
	Height int `json:"height"`
}

type Code

type Code struct {
	Header  string
	Code    string
	Footer  string
	IsEmpty bool
}

type Content

type Content struct {
	Markdown string
	HTML     string
}
type Menu struct {
	Title     string
	Link      int
	PagePrint int
	PageIndex int
}

type Page

type Page struct {
	Header Content
	Data   Content
	Footer Content
}

type Presentation

type Presentation struct {
	Replacers map[string]string
	Endpoints map[string]TerminalCommand
	CSS       string
	JS        string
	HTML      string
	Title     string
	Author    string
	Slides    []Slide
	Menu      []Menu
	Options   PresentationOptions
}

type PresentationOptions added in v1.0.2

type PresentationOptions struct {
	AspectRatioMin     configuration.AspectRatio
	AspectRatioMax     configuration.AspectRatio
	DisableAspectRatio bool
}

type ReadOptions

type ReadOptions struct {
	DefaultFontSize                string
	DefaultBackgroundColor         string
	DefaultTerminalFontSize        string
	DefaultTerminalFontColor       string
	DefaultTerminalBackgroundColor string
	DefaultSlideCSS                string
	DefaultSlideClass              string
	AspectRatioMin                 configuration.AspectRatio
	AspectRatioMax                 configuration.AspectRatio
	DisableAspectRatio             bool
	EveryDashIsATransition         bool
	HideRunButton                  bool
	HidePageNumber                 bool
	KeepPagePrintOnCut             bool
}

type Slide

type Slide struct {
	Asciinema               *Asciinema
	Cast                    *Cast
	Page                    Page
	Admin                   Content
	Notes                   string
	JS                      string // javascript function to call on page enter
	Path                    string
	BackgroundImage         string
	BackgroundColor         string
	CSS                     string
	SlideClass              string
	FontSize                string
	TerminalFontSize        string
	TerminalFontColor       string
	TerminalBackgroundColor string
	Link                    string
	LinkNext                string
	LinkPrev                string
	Title                   string
	HasAudioSrc             string
	TerminalCommandBefore   []TerminalCommand
	TerminalCommand         []TerminalCommand
	TerminalCommandAfter    []TerminalCommand

	SlideCmdBefore        []TerminalCommand
	SlideCmdAfter         []TerminalCommand
	Terminal              TerminalCommand
	PageIndex             int
	PagePrint             int
	IsAdmin               bool
	UseTmpFolder          bool
	CanEdit               bool
	HasCast               bool
	HasCastStreamed       bool
	HasAudio              bool
	HasAudioAutoPlay      bool
	HasAudioOnEndNextpage bool
	HasRun                bool
	HasTerminal           bool
	HideRunButton         bool
	PrintOnly             bool
	PrintDisable          bool
	HidePageNumber        bool
	EnableOverflow        bool
}

type TerminalCommand

type TerminalCommand struct {
	Dir      string
	App      string
	FileName string
	Code     Code
	Cmd      []string
	ENV      []string
	Index    int
	DirFixed bool
}

type TerminalOutputLine

type TerminalOutputLine struct {
	Timestamp string
	Line      string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL