revealjs

README

go-revealjs

Deribed from revealjs-docker. Work in progress.

Documentation

Index

• Variables
• func IsMarkdown(path string) bool
• type Config
  • func LoadConfigFile(reader io.Reader) (*Config, error)
  • func (c *Config) OverrideWith(other *Config)
  • func (c *Config) Plugins() []Plugin
  • func (c *Config) RevealJSConfig() map[string]string
• type GenerateOptions
• type HTMLGeneratorParams
• type Markdown
  • func NewMarkdown(content string) *Markdown
  • func (m *Markdown) WithoutYAMLHeader() string
  • func (m *Markdown) YAMLHeader() (map[string]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 RevealJS
  • func NewRevealJS(dataDirectory string) (*RevealJS, error)
  • func (r *RevealJS) Build() error
  • func (r *RevealJS) BuildDirectory() string
  • 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 Watcher
  • func NewWatcher(dataDirectory string, onUpdate func()) (*Watcher, error)
  • func (w *Watcher) Start()

Variables

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

Functions

func IsMarkdown

func IsMarkdown(path string) bool

Types

type Config

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

func LoadConfigFile

func LoadConfigFile(reader io.Reader) (*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

type GenerateOptions

type GenerateOptions struct {
	Force                bool
	GenerateConfig       bool
	GenerateHTMLTemplate bool
}

type HTMLGeneratorParams

type HTMLGeneratorParams struct {
	HotReload bool
	Revision  *string
}

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]string, error)

type Plugin

type Plugin struct {
	Name string `json:"name"`
	Src  string `json:"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 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() error

func (*RevealJS) BuildDirectory

func (r *RevealJS) BuildDirectory() string

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 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()