revealjs

README

go-revealjs

Derived from revealjs-docker. Work in progress.

Documentation

Index

• Constants
• Variables
• func IsHTML(path string) bool
• func IsMarkdown(path string) bool
• type BoolProperty
  • func (p *BoolProperty) ToString(v interface{}) (string, error)
• type Config
  • func LoadConfigFile(reader io.Reader) (*Config, error)
  • func LoadConfigFromMarkdown(content string) (*Config, error)
  • func (c *Config) OverrideWith(other *Config)
  • func (c *Config) Plugins() []Plugin
  • func (c *Config) RevealJSConfig() (map[string]string, error)
• type GenerateOptions
• type HTMLGeneratorParams
• type JSONProperty
  • func (p *JSONProperty) ToString(v interface{}) (string, error)
• type Markdown
  • func NewMarkdown(content string) *Markdown
  • func (m *Markdown) WithoutYAMLHeader() string
  • func (m *Markdown) YAMLHeader() (map[string]interface{}, error)
• type NumberProperty
  • func (p *NumberProperty) ToString(v interface{}) (string, error)
• type Plugin
• type Preset
  • func NewDefaultPreset() *Preset
  • func NewPreset(name string) (*Preset, error)
  • func (f *Preset) Generate(dest string, options *GenerateOptions) error
• type Property
• type RevealJS
  • func NewRevealJS(dataDirectory string) (*RevealJS, error)
  • func (r *RevealJS) Build(dst string) error
  • func (r *RevealJS) DataDirectory() string
  • func (r *RevealJS) FileSystem() fs.FS
  • func (r *RevealJS) GenerateIndexHTML(w io.Writer, params *HTMLGeneratorParams) error
  • func (r *RevealJS) ReloadConfig() error
• type Revision
• type Server
  • func NewServer(port int, revealJS *RevealJS) *Server
  • func (s *Server) Start() error
• type SlideResourceFS
  • func NewSlideResourceFS(fs fs.FS) *SlideResourceFS
  • func (s *SlideResourceFS) Open(name string) (fs.File, error)
  • func (f *SlideResourceFS) ReadDir(name string) ([]fs.DirEntry, error)
• type StringProperty
  • func (p *StringProperty) ToString(v interface{}) (string, error)
• type Watcher
  • func NewWatcher(dataDirectory string, onUpdate func()) (*Watcher, error)
  • func (w *Watcher) Start()

Constants

const (
	FileNameConfig        = "config.yml"
	FileNameIndexHTMLTmpl = "index.html.tmpl"
	FileNameIndexHTML     = "index.html"
	DirNameSlides         = "slides"
	DirNameAssets         = "assets"
)

Variables

var PresetNames = []string{"default", "demo"}

Functions

func IsHTML

func IsHTML(path string) bool

func IsMarkdown

func IsMarkdown(path string) bool

Types

type BoolProperty

type BoolProperty struct {
}

func (*BoolProperty) ToString

func (p *BoolProperty) ToString(v interface{}) (string, error)

type Config

type Config struct {
	Slides          []string               `yaml:"slides"`
	Title           string                 `yaml:"title"`
	Theme           string                 `yaml:"theme"`
	RevealJS        map[string]interface{} `yaml:"revealjs"`
	InternalPlugins []interface{}          `yaml:"plugins"`
}

func LoadConfigFile

func LoadConfigFile(reader io.Reader) (*Config, error)

func LoadConfigFromMarkdown

func LoadConfigFromMarkdown(content string) (*Config, error)

func (*Config) OverrideWith

func (c *Config) OverrideWith(other *Config)

func (*Config) Plugins

func (c *Config) Plugins() []Plugin

func (*Config) RevealJSConfig

func (c *Config) RevealJSConfig() (map[string]string, error)

type GenerateOptions

type GenerateOptions struct {
	Force                bool
	GenerateConfig       bool
	GenerateHTMLTemplate bool
}

type HTMLGeneratorParams

type HTMLGeneratorParams struct {
	HotReload bool
	Revision  *string
}

type JSONProperty

type JSONProperty struct {
}

func (*JSONProperty) ToString

func (p *JSONProperty) ToString(v interface{}) (string, error)

type Markdown

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

func NewMarkdown

func NewMarkdown(content string) *Markdown

func (*Markdown) WithoutYAMLHeader

func (m *Markdown) WithoutYAMLHeader() string

func (*Markdown) YAMLHeader

func (m *Markdown) YAMLHeader() (map[string]interface{}, error)

type NumberProperty

type NumberProperty struct {
}

func (*NumberProperty) ToString

func (p *NumberProperty) ToString(v interface{}) (string, error)

type Plugin

type Plugin struct {
	Name string `yaml:"name"`
	Src  string `yaml:"src"`
}

type Preset

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

Preset is a collection of files that are used to generate an initial Reveal.js presentation.

func NewDefaultPreset

func NewDefaultPreset() *Preset

func NewPreset

func NewPreset(name string) (*Preset, error)

func (*Preset) Generate

func (f *Preset) Generate(dest string, options *GenerateOptions) error

type Property

type Property interface {
	ToString(v interface{}) (string, error)
}

type RevealJS

type RevealJS struct {
	EmbedHTML     bool
	EmbedMarkdown bool
	// contains filtered or unexported fields
}

func NewRevealJS

func NewRevealJS(dataDirectory string) (*RevealJS, error)

func (*RevealJS) Build

func (r *RevealJS) Build(dst string) error

func (*RevealJS) DataDirectory

func (r *RevealJS) DataDirectory() string

func (*RevealJS) FileSystem

func (r *RevealJS) FileSystem() fs.FS

func (*RevealJS) GenerateIndexHTML

func (r *RevealJS) GenerateIndexHTML(w io.Writer, params *HTMLGeneratorParams) error

func (*RevealJS) ReloadConfig

func (r *RevealJS) ReloadConfig() error

type Revision

type Revision struct {
	Value string
}

type Server

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

func NewServer

func NewServer(port int, revealJS *RevealJS) *Server

func (*Server) Start

func (s *Server) Start() error

type SlideResourceFS

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

SlideResourceFS is a file system that provides slides and assets. - *.md - *.html - slides/*.md - slides/*.html - assets/**/* - config.yml - index.html.tmpl

func NewSlideResourceFS

func NewSlideResourceFS(fs fs.FS) *SlideResourceFS

func (*SlideResourceFS) Open

func (s *SlideResourceFS) Open(name string) (fs.File, error)

func (*SlideResourceFS) ReadDir

func (f *SlideResourceFS) ReadDir(name string) ([]fs.DirEntry, error)

type StringProperty

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

func (*StringProperty) ToString

func (p *StringProperty) ToString(v interface{}) (string, error)

type Watcher

type Watcher struct {
	Revision *Revision
	// contains filtered or unexported fields
}

func NewWatcher

func NewWatcher(dataDirectory string, onUpdate func()) (*Watcher, error)

func (*Watcher) Start

func (w *Watcher) Start()