quarkdown-core/com.quarkdown.core.media.storage

Package-level declarations

Types

class MutableMediaStorage(options: MediaStorageOptions, nameProvider: MediaNameProviderStrategy = SanitizedMediaNameProvider()) : ReadOnlyMediaStorage

A media storage that can be modified with new entries.

ReadOnlyMediaStorage

interface ReadOnlyMediaStorage

A storage of Media that can only be read. The main purpose is exporting media to the output files. For example, an image ![](img.png) references a local image. In this case, the HTML renderer would normally produce a <img src="img.png"> tag, but the image would not be found in the output directory. This means that the image must be copied to the output directory (not necessarily under the same name), and the tag must reference the copied image path instead.

StoredMedia

data class StoredMedia(val name: String, val media: Media)

A media file paired with a name, used in a ReadOnlyMediaStorage.