MkDocsBuild

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.MkDocsBuild

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>
```
@CacheableTask
public class MkDocsBuild
extends MkDocs
```
Build the MkDocs documentation.

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

MkDocsBuild(ExecOperations execOperations)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RegularFileProperty`	`getConfigFile()`	Provide a specific MkDocs config.
`DirectoryProperty`	`getSiteDir()`	The directory to output the result of the documentation build.
`Property<Boolean>`	`getStrict()`	Enable strict mode.
`Property<String>`	`getTheme()`	The theme to use when building your documentation.
`DirectoryProperty`	`getThemeDir()`	The theme directory to use when building your documentation.

Methods inherited from class io.freefair.gradle.plugins.mkdocs.tasks.MkDocs
exec, getCommand, 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, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask
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 Detail
  - MkDocsBuild
```
@Inject
public MkDocsBuild(ExecOperations execOperations)
```
- Method Detail
  - getConfigFile
```
public RegularFileProperty getConfigFile()
```
    Provide a specific MkDocs config.
  - getStrict
```
public Property<Boolean> getStrict()
```
    Enable strict mode. This will cause MkDocs to abort the build on any warnings.
  - getTheme
```
public Property<String> getTheme()
```
    The theme to use when building your documentation.
  - getThemeDir
```
public DirectoryProperty getThemeDir()
```
    The theme directory to use when building your documentation.
  - getSiteDir
```
public DirectoryProperty getSiteDir()
```
    The directory to output the result of the documentation build.