stories

package

v1.9.1 Latest Latest Go to latest Published: Oct 19, 2023 License: GPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type BuildCollectionOptions struct {
	Footer           Footer
	Sources          []string
	TemplateFilename string
	TargetDir        string
}

type BuildStorieOptions struct {
	Footer           Footer
	TemplateFilename string
	SourceURL        string
	TargetDir        string
}

func (bo BuildStorieOptions) Template(source fetcher.Result) (filetemplate.Template, error)

type Collection []Story

func BuildCollection(ctx context.Context, opt BuildCollectionOptions) (Collection, error)

func (c Collection) RemoveAll() error

type Footer stages.Footer

type Story struct {
	Stage stages.Stage
	Video string
	Hash  string
}

func BuildStory(ctx context.Context, opt BuildStorieOptions) (Story, error)

func (s Story) MoveVideo(target string) error

func (s Story) RemoveAll() error

func (s Story) RemoveStage() error