Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Metadata

Metadata describing a package’s content, read from metadata.yaml.

A struct with 11 fields:

fieldtypeoptionaldescription
artworkRelativePathtruePath to cover art. Must be square.
creatorTexttruePrimary person or group who created the content.
descriptionTexttrueSingle-line description of the content.
homepageCheckedUrltrueOfficial homepage of the content.
languageLanguagetrueTwo-letter ISO 639-1 code of the content’s primary language.
mediaMediatrueMetadata describing the media content of the package.
packagePackageMetadatatrueMetadata describing the package itself, as opposed to its content.
publisherTexttruePrimary publisher of the content.
readmeRelativePathtruePath to a markdown file containing a readme describing the content.
timeTimetrueTime the content was created.
titleTexttrueTitle of the content.

Unknown fields are rejected.