viewer

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2026 License: BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Overview

Package viewer writes a deck as one self-contained HTML page: the slides, their style sheet, and a small script to present them — keyboard and pointer navigation, fragmented lists, a slide per URL hash, and printing every slide on its own page. It plays the part of marp-cli's templates.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Document

func Document(o Options) string

Document returns the page.

Types

type Meta

type Meta struct {
	Title, Description, Author, Keywords, URL, Image, Lang string
}

Meta is the page's metadata (marp-cli's title, description, author, keywords, url and image global directives).

type Options

type Options struct {
	Meta Meta
	// CSS is the packed theme style sheet.
	CSS string
	// Slides are the rendered slides, frames included.
	Slides []string
	// Bare leaves the script out: the slides stack vertically, as in
	// marp-cli's bare template.
	Bare bool
}

Options configures Document.

Jump to

Keyboard shortcuts

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