MkDocsGhDeploy

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

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>
```
public class MkDocsGhDeploy
extends MkDocs
```
Deploy your documentation to GitHub Pages.

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

MkDocsGhDeploy(ExecOperations execOperations)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RegularFileProperty`	`getConfigFile()`	Provide a specific MkDocs config.
`Property<Boolean>`	`getForce()`	Force the push to the repository.
`Property<Boolean>`	`getIgnoreVersion()`	Ignore check that build is not being deployed with an older version of MkDocs.
`Property<String>`	`getMessage()`	A commit message to use when committing to the Github Pages remote branch.
`Property<String>`	`getRemoteBranch()`	The remote branch to commit to for Github Pages.
`Property<String>`	`getRemoteName()`	The remote name to commit to for Github Pages.

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
  - MkDocsGhDeploy
```
@Inject
public MkDocsGhDeploy(ExecOperations execOperations)
```
- Method Detail
  - getConfigFile
```
public RegularFileProperty getConfigFile()
```
    Provide a specific MkDocs config.
  - getMessage
```
public Property<String> getMessage()
```
    A commit message to use when committing to the Github Pages remote branch. Commit {sha} and MkDocs {version} are available as expansions.
  - getRemoteBranch
```
public Property<String> getRemoteBranch()
```
    The remote branch to commit to for Github Pages. This overrides the value specified in config.
  - getRemoteName
```
public Property<String> getRemoteName()
```
    The remote name to commit to for Github Pages. This overrides the value specified in config.
  - getForce
```
public Property<Boolean> getForce()
```
    Force the push to the repository.
  - getIgnoreVersion
```
public Property<Boolean> getIgnoreVersion()
```
    Ignore check that build is not being deployed with an older version of MkDocs.