public abstract class MkDocsServe extends MkDocs
Task.NamerTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor and Description |
|---|
MkDocsServe() |
| Modifier and Type | Method and 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.
|
exec, getCommand, getExecOperations, getQuiet, getVerbosecompareTo, 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, usesServiceacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention, notCompatibleWithConfigurationCache@Optional @InputFile @PathSensitive(value=RELATIVE) public abstract RegularFileProperty getConfigFile()
@Input @Optional public abstract Property<String> getDevAddr()
@Optional @Input public abstract Property<Boolean> getStrict()
@Optional @Input public abstract Property<String> getTheme()
@Optional @InputDirectory public abstract DirectoryProperty getThemeDir()
@Optional @Input public abstract Property<Boolean> getLivereload()