AtomManifest

@Serializable
data class AtomManifest(val name: String, val version: String, val entrypoint: String, val description: String? = null, val authors: List<String> = emptyList(), val minQuarkdownVersion: String? = null, val categories: List<String> = emptyList(), val repository: String? = null, val license: String? = null)

Metadata of a package ("atom"), as declared in the atom table of its manifest.

Parameters

name

name of the package, matching its directory in the repository

version

version of the package, matching its version directory in the repository

entrypoint

path, relative to the package root, of the Quarkdown file to include

description

short human-readable description

authors

authors, in the Name <contact> form

minQuarkdownVersion

lowest Quarkdown version the package supports, declared as min-quarkdown

categories

free-form categories used for discovery

repository

URL of the package's own source repository

license

SPDX license identifier

Constructors

Link copied to clipboard
constructor(name: String, version: String, entrypoint: String, description: String? = null, authors: List<String> = emptyList(), minQuarkdownVersion: String? = null, categories: List<String> = emptyList(), repository: String? = null, license: String? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@SerialName(value = "min-quarkdown")
val minQuarkdownVersion: String?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard