Documentation
¶
Overview ¶
Package project assembles a deck's build configuration the way the slides command does: the built-ins, then slides.hcl or slides.yaml found next to the deck, then what the caller asks for (the command's flags).
It reads through a vfs.FS, so that an editor can run the same assembly over the files it holds, without a disk.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ConfigNames = []string{"slides.hcl", "slides.yaml", "slides.yml"}
ConfigNames are the configuration files looked up next to the deck, in order.
Functions ¶
func ConfigPath ¶
ConfigPath returns the configuration file Load would read for a deck in baseDir, "" if none.
Types ¶
type Options ¶
type Options struct {
// ConfigFile names the configuration file; "" looks for ConfigNames
// next to the deck.
ConfigFile string
// NoConfig reads no configuration file.
NoConfig bool
// ThemeSets are theme CSS files or directories of them.
ThemeSets []string
// KindFiles are YAML or HCL kinds files.
KindFiles []string
// DataFiles are YAML, JSON or HCL template data files.
DataFiles []string
// Sets are key=value template data.
Sets []string
// HTML allows all raw HTML.
HTML bool
// Lang is the lang attribute when the deck sets none.
Lang string
Bare bool
NoTemplate bool
StrictYAML bool
NoEmoji bool
// FS is what is read; nil means the disk.
FS vfs.FS
}
Options are what the caller adds to the configuration file; the command fills them from its flags.
Click to show internal directories.
Click to hide internal directories.