MarkdownBlock

abstract class MarkdownBlock(providers: ProviderFactory, objects: ObjectFactory, baseGenDir: Provider<String>, pagesPackage: Property<String>) : KobwebBlock.FileGeneratingBlock(source)

Constructors

constructor(providers: ProviderFactory, objects: ObjectFactory, baseGenDir: Provider<String>, pagesPackage: Property<String>)

abstract val defaultLayout: Property<String>

A layout fqn to use as a fallback if no layout is specified.

abstract val defaultPackage: Property<String>

The default package that source code generated from Markdown files will be written under.

abstract val defaultRoot: Property<String>

A root composable to use as a fallback if no root is explicitly specified.

abstract val genDir: Property<String>

abstract val imports: ListProperty<String>

A list of imports that should be added to the top of every generated markdown file.

abstract val markdownPath: Property<String>

The path under which all markdown resources will live.

fun addSource(dir: Directory, targetPackage: String? = null)

fun addSource(dirProvider: Provider<Directory>, targetPackage: String? = null)

fun addSource(dirProvider: Provider<Directory>, targetPackage: Provider<String>)

fun addSource(taskProvider: TaskProvider<*>, targetPackage: String? = null)

fun addSource(dir: Directory, targetPackage: Provider<String>)

Adds a directory under which to search for markdown files.

fun addSource(taskProvider: TaskProvider<*>, targetPackage: Provider<String>)

Hooks up a task's output files as directories under which to search for additional markdown files.

@Internal

abstract fun getExtensions(): ExtensionContainer