renderer

package
v0.0.0-...-60784e1 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2026 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateHugoConfiguration

func GenerateHugoConfiguration(workshopDir string, target string, params map[string]string, sessionURL string) error

func PopulateTemporaryDirectory

func PopulateTemporaryDirectory() (string, error)

func RenderHugoStaticHTML

func RenderHugoStaticHTML(workshopDir string, tempDir string) error

func RunHugoServer

func RunHugoServer(workshopRoot string, kubeconfig string, context string, workshop string, portal string, localHost string, localPort int, hugoPort int, token string, files bool, cleanupFunc ServerCleanupFunc) error

Types

type ServerCleanupFunc

type ServerCleanupFunc func()

type WorkshopConfig

type WorkshopConfig struct {
	Pathways WorkshopPathwaysConfig `yaml:"pathways,omitempty"`
	Params   []WorkshopParamsConfig `yaml:"params,omitempty"`
}

type WorkshopModuleConfig

type WorkshopModuleConfig struct {
	Title    string `yaml:"title"`
	Path     string `yaml:"path"`
	PrevPage string `yaml:"prev_page"`
	NextPage string `yaml:"next_page"`
	Step     int    `yaml:"step"`
}

type WorkshopParamsConfig

type WorkshopParamsConfig struct {
	Name    string   `yaml:"name"`
	Value   string   `yaml:"value"`
	Aliases []string `yaml:"aliases,omitempty"`
}

type WorkshopPathConfig

type WorkshopPathConfig struct {
	Title       string                 `yaml:"title,omitempty"`
	Description string                 `yaml:"description,omitempty"`
	Params      []WorkshopParamsConfig `yaml:"params,omitempty"`
	Steps       []string               `yaml:"steps,omitempty"`
}

type WorkshopPathwaysConfig

type WorkshopPathwaysConfig struct {
	Default string                          `yaml:"default,omitempty"`
	Paths   map[string]WorkshopPathConfig   `yaml:"paths,omitempty"`
	Modules map[string]WorkshopModuleConfig `yaml:"modules,omitempty"`
}

Jump to

Keyboard shortcuts

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