KScienceReadmeExtension

class KScienceReadmeExtension(val project: Project)

Constructors

Link copied to clipboard
fun KScienceReadmeExtension(project: Project)

Types

Link copied to clipboard
data class Feature(val id: String, val description: String, val ref: String?, val name: String = id)

Functions

Link copied to clipboard
fun feature(id: String, description: String, ref: String? = null, name: String = id)
fun feature(id: String, ref: String? = null, name: String = id, description: () -> String)
Link copied to clipboard
fun featureWithHtml(id: String, ref: String? = null, name: String = id, htmlBuilder: TagConsumer<String>.() -> Unit)
Link copied to clipboard
Link copied to clipboard
fun property(key: String, value: Any?)
fun property(key: String, value: () -> Any?)
Link copied to clipboard
fun propertyByTemplate(key: String, templateFile: File)
fun propertyByTemplate(key: String, templateString: String)
Link copied to clipboard

Generate a readme string from the template

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val project: Project
Link copied to clipboard

Use this template file if it is provided, otherwise use default template

Link copied to clipboard

If true, use default templates provided by plugin if override is not defined