Package io.freefair.gradle.plugins.mkdocs.tasks

Class MkDocsServe

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

io.freefair.gradle.plugins.mkdocs.tasks.MkDocsServe

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable<Task>

public abstract class MkDocsServe
extends MkDocs

Run the builtin development server.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
MkDocsServe()

Method Summary

Modifier and Type	Method	Description
abstract RegularFileProperty	getConfigFile()	Provide a specific MkDocs config.
abstract Property<String>	getDevAddr()	IP address and port to serve documentation locally (default: localhost:8000)
abstract Property<Boolean>	getDirtyreload()	Enable the live reloading in the development server, but only re-build files that have changed.
abstract Property<Boolean>	getLivereload()	Enable the live reloading in the development server
abstract Property<Boolean>	getStrict()	Enable strict mode.
abstract Property<String>	getTheme()	The theme to use when building your documentation.
abstract DirectoryProperty	getThemeDir()	The theme directory to use when building your documentation.

Methods inherited from class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs

exec, getCommand, getExecOperations, getQuiet, getVerbose

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Details

MkDocsServe

public MkDocsServe()

Method Details

getConfigFile

@Optional
@InputFile
@PathSensitive(RELATIVE)
public abstract RegularFileProperty getConfigFile()

Provide a specific MkDocs config.

getDevAddr

@Input
@Optional
public abstract Property<String> getDevAddr()

IP address and port to serve documentation locally (default: localhost:8000)

getStrict

@Optional
@Input
public abstract Property<Boolean> getStrict()

Enable strict mode. This will cause MkDocs to abort the build on any warnings.

getTheme

@Optional
@Input
public abstract Property<String> getTheme()

The theme to use when building your documentation.

getThemeDir

@Optional
@InputDirectory
public abstract DirectoryProperty getThemeDir()

The theme directory to use when building your documentation.

getLivereload

@Optional
@Input
public abstract Property<Boolean> getLivereload()

Enable the live reloading in the development server

getDirtyreload

@Optional
@Input
public abstract Property<Boolean> getDirtyreload()

Enable the live reloading in the development server, but only re-build files that have changed.